com.sap.cloud.security.token.validation.ValidationResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-security Show documentation

There is a newer version: 3.5.6

package com.sap.cloud.security.token.validation;

import javax.annotation.Nullable;

/**
 * Captures the result of a validation. Normally created by validators that
 * implement the {@link Validator} interface.
 */
public interface ValidationResult {

	/**
	 * Returns true if there is no validation error, false otherwise.
	 * 
	 * @return true if there is no validation error.
	 */
	default boolean isValid() {
		return getErrorDescription() == null;
	}

	/**
	 * Returns true if there is a validation error, false otherwise.
	 *
	 * @return true if there is a validation error.
	 */
	default boolean isErroneous() {
		return !isValid();
	}

	/**
	 * The validation error that have been found.
	 *
	 * @return the error description or null in case the validation was valid.
	 */
	@Nullable
	String getErrorDescription();
}