io.github.bhowell2.apilib.ApiLibSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-lib Show documentation
API verification library.
The newest version!
package io.github.bhowell2.apilib;

import io.github.bhowell2.apilib.checks.Check;
import io.github.bhowell2.apilib.errors.ApiParamError;
import io.github.bhowell2.apilib.formatters.Formatter;

/**
 * @author Blake Howell
 */
public class ApiLibSettings {

//	/**
//	 * Allows for setting the display name to the keyName in case the user relies on the
//	 * display name.
//	 */
//	public static volatile boolean SET_DISPLAY_NAME_TO_KEY_NAME_IF_NULL = false;

	/**
	 * Used when a parameter is set to null, but null is not a valid value for the parameter.
	 */
	public static volatile String DEFAULT_CANNOT_BE_NULL_MESSAGE = "Cannot be null.";

	/**
	 * Used when a parameter is not supplied. For optional parameters this message
	 * will never be returned, because if they are missing they were optional anyway.
	 */
	public static volatile String DEFAULT_MISSING_PARAMETER_MESSAGE = "Required, but was not provided.";

	/**
	 * Used when no "failure message" is supplied to {@link Check.Result} (on failure, of course).
	 */
	public static volatile String DEFAULT_INVALID_PARAMETER_MESSAGE = "Did not meet requirements.";

	/**
	 * Used as default conditional failure message. This does not recognize param-name-template-var,
	 * because conditional are intended to apply to multiple parameters, so the user should return
	 * an appropriate error message describing the reason for failure.
	 */
	public static volatile String DEFAULT_CONDITIONAL_FAILURE_MESSAGE = "Some condition was not met.";

	/**
	 * Error message used when a ClassCastException is thrown when checking a parameter.
	 */
	public static volatile String DEFAULT_CASTING_ERROR_MESSAGE = "Was of incorrect data type.";

	/**
	 * Error message used when an error occurred during formatting and an error message to
	 * {@link Formatter.Result#failure(String)} was not supplied.
	 */
	public static volatile String DEFAULT_FORMATTING_ERROR_MESSAGE = "Was not formattable.";

	/**
	 * These are used to set the key names of the map that is generated when calling
	 * {@link ApiParamError#toMap()}.
	 */
	public static class ErrorMessageToMapParamNames {
		public static volatile String KEY_NAME = "keyName";
		public static volatile String DISPLAY_NAME = "displayName";
		public static volatile String INDEX = "index";
		public static volatile String ERROR_TYPE = "errorType";
		public static volatile String ERROR_MESSAGE = "errorMessage";
		public static volatile String CHILD_ERROR = "childError";

	}

}