ValidatorHelperResult.java

/**
 * Copyright 2005-2016 hdiv.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.hdiv.filter;

import java.util.ArrayList;
import java.util.List;

import org.hdiv.state.IState;

/**
 * Result of the invocation of the validation of a request with {@link IValidationHelper}
 *
 * @author Gotzon Illarramendi
 * @since 2.1.4
 */
public class ValidatorHelperResult {

	/**
	 * Constant valid result.
	 */
	public static final ValidatorHelperResult VALID = new ValidatorHelperResult(true);

	/**
	 * Constant valid result for requests that do not require validation.
	 */
	public static final ValidatorHelperResult VALIDATION_NOT_REQUIRED = new ValidatorHelperResult(true);

	/**
	 * Constant valid result.
	 */
	public static final ValidatorHelperResult PEN_TESTING = new ValidatorHelperResult(false);

	/**
	 * Validation is valid or not
	 */
	private final boolean valid;

	/**
	 * Validation method result value
	 */
	private IState value;

	/**
	 * Validation error data
	 */
	private List<ValidatorError> errors;

	public ValidatorHelperResult(final boolean valid) {
		this.valid = valid;
	}

	public ValidatorHelperResult(final ValidatorError error) {
		this(false, error);
	}

	public ValidatorHelperResult(final List<ValidatorError> errors) {
		valid = false;
		this.errors = errors;
	}

	public ValidatorHelperResult(final boolean valid, final IState value) {
		this.valid = valid;
		this.value = value;
	}

	public ValidatorHelperResult(final boolean valid, final ValidatorError error) {
		this.valid = valid;
		errors = new ArrayList<ValidatorError>();
		errors.add(error);
	}

	public boolean isValid() {
		return valid;
	}

	public List<ValidatorError> getErrors() {
		return errors;
	}

	public IState getValue() {
		return value;
	}

	@Override
	public String toString() {
		StringBuilder b = new StringBuilder();
		b.append("Valid: ").append(valid).append(", ");
		if (errors != null) {
			for (ValidatorError error : errors) {
				b.append(" Errorcode: ").append(error.toString());
			}
		}
		if (value != null) {
			b.append(" Value:").append(value).append(", ");
		}
		if (equals(VALIDATION_NOT_REQUIRED)) {
			b.append(" Type: VALIDATION_NOT_REQUIRED");
		}

		return b.toString();
	}

}