agi.foundation

(agi.foundation.core-2024r3.jar)

Class PropertyInvalidException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalStateException

agi.foundation.PropertyInvalidException

All Implemented Interfaces:

Serializable

public class PropertyInvalidException
extends IllegalStateException

An exception that indicates that a property required for an operation has an invalid value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PropertyCannotBeEmptyCollection A message string indicating that a property cannot be an empty collection.
static String	PropertyCannotBeLessThanOne A message string indicating that a property must be greater than or equal to one.
static String	PropertyCannotBeNaN A message string indicating that a property cannot be NaN.
static String	PropertyCannotBeNegative A message string indicating that a property cannot be negative.
static String	PropertyCannotBeNull A message string indicating that a property cannot be null.
static String	PropertyCannotBePositive A message string indicating that a property cannot be positive.
static String	PropertyCannotBeZero A message string indicating that a property may not be set to zero.
static String	PropertyCannotContainNullElements A message string indicating that a property cannot contain null elements.
static String	PropertyCannotHaveZeroElements A message string indicating that a property cannot have zero elements.
static String	PropertyMustBeNegative A message string indicating that a property must be negative.
static String	PropertyMustBePositive A message string indicating that a property must be positive.
static String	PropertyMustBeSet A message string indicating that a property must be set prior to execution.

Constructor Summary

Constructors

Constructor and Description
PropertyInvalidException(String propertyName, RuntimeException inner) Initializes a new instance with a specified property name and a reference to the inner exception that is the cause of this exception.
PropertyInvalidException(String propertyName, String message) Initializes a new instance with a specified property name.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Gets a message that describes the current exception.
String	getPropertyName() Gets the name of the property that is required.
static void	validateGreaterThanZero(double value, String propertyName) Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.
static void	validateGreaterThanZero(double value, String propertyName, String exceptionMessage) Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.
static void	validateGreaterThanZero(int value, String propertyName) Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.
static void	validateGreaterThanZero(int value, String propertyName, String exceptionMessage) Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.
static <TInterface> void	validateImplementsInterface(TypeLiteral<TInterface> typeLiteralTInterface, Object value, String propertyName) Validate that the given property implements the specified interface.
static <TInterface> void	validateImplementsInterface(TypeLiteral<TInterface> typeLiteralTInterface, Object value, String propertyName, String exceptionMessage) Validate that the given property implements the specified interface.
static void	validateNonNegative(double value, String propertyName) Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.
static void	validateNonNegative(double value, String propertyName, String exceptionMessage) Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.
static void	validateNonNegative(int value, String propertyName) Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.
static void	validateNonNegative(int value, String propertyName, String exceptionMessage) Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.
static void	validateNonNull(Object value, String propertyName) Validate that the given property value must be non-null, and throw PropertyInvalidException if it is not.
static void	validateNonNull(Object value, String propertyName, String exceptionMessage) Validate that the given property value must be non-null, and throw PropertyInvalidException if it is not.
static void	validateNonZero(double value, String propertyName) Validate that the given property value must be non-zero, and throw PropertyInvalidException if it is not.
static void	validateNonZero(double value, String propertyName, String exceptionMessage) Validate that the given property value must be non-zero, and throw PropertyInvalidException if it is not.
static <T> void	validateNotEmpty(Collection<T> value, String propertyName) Validate that the given property value must not be null or an empty collection, and throw PropertyInvalidException if it is.
static <T> void	validateNotEmpty(Collection<T> value, String propertyName, String exceptionMessage) Validate that the given property value must not be null or an empty collection, and throw PropertyInvalidException if it is.
static <TKey,TValue> void	validateNotEmpty(Map<TKey,TValue> value, String propertyName) Validate that the given property value must not be null or an empty dictionary, and throw PropertyInvalidException if it is.
static <TKey,TValue> void	validateNotEmpty(Map<TKey,TValue> value, String propertyName, String exceptionMessage) Validate that the given property value must not be null or an empty dictionary, and throw PropertyInvalidException if it is.
static void	validateNotNaN(double value, String propertyName) Validate that the given property value must not be NaN, and throw PropertyInvalidException if it is.
static void	validateNotNaN(double value, String propertyName, String exceptionMessage) Validate that the given property value must not be NaN, and throw PropertyInvalidException if it is.
static void	validateZeroToOne(double value, String propertyName, String exceptionMessage) Validate that the given property value must be between zero and one, and throw PropertyInvalidException if it is not.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PropertyCannotBeNull

public static final String PropertyCannotBeNull

A message string indicating that a property cannot be null.

PropertyCannotBeNegative

public static final String PropertyCannotBeNegative

A message string indicating that a property cannot be negative.

PropertyMustBePositive

public static final String PropertyMustBePositive

A message string indicating that a property must be positive.

PropertyCannotBePositive

public static final String PropertyCannotBePositive

A message string indicating that a property cannot be positive.

PropertyMustBeNegative

public static final String PropertyMustBeNegative

A message string indicating that a property must be negative.

PropertyCannotBeLessThanOne

public static final String PropertyCannotBeLessThanOne

A message string indicating that a property must be greater than or equal to one.

PropertyCannotHaveZeroElements

public static final String PropertyCannotHaveZeroElements

A message string indicating that a property cannot have zero elements.

PropertyCannotContainNullElements

public static final String PropertyCannotContainNullElements

A message string indicating that a property cannot contain null elements.

PropertyMustBeSet

public static final String PropertyMustBeSet

A message string indicating that a property must be set prior to execution.

PropertyCannotBeZero

public static final String PropertyCannotBeZero

A message string indicating that a property may not be set to zero.

PropertyCannotBeNaN

public static final String PropertyCannotBeNaN

A message string indicating that a property cannot be NaN.

PropertyCannotBeEmptyCollection

public static final String PropertyCannotBeEmptyCollection

A message string indicating that a property cannot be an empty collection.

Constructor Detail

PropertyInvalidException

public PropertyInvalidException(String propertyName,
                                String message)

Initializes a new instance with a specified property name.

Parameters:

propertyName - The name of the property that has an invalid value.

message - The message that describes the error.

PropertyInvalidException

public PropertyInvalidException(String propertyName,
                                RuntimeException inner)

Initializes a new instance with a specified property name and a reference to the inner exception that is the cause of this exception.

Parameters:

propertyName - The name of the property that has an invalid value.

inner - The exception that is the cause of the current exception.

Method Detail

getPropertyName

public final String getPropertyName()

Gets the name of the property that is required.

getMessage

public String getMessage()

Gets a message that describes the current exception.

Overrides:

getMessage in class Throwable

Returns:

The error message that explains the reason for the exception, or an empty string("").

validateImplementsInterface

public static <TInterface> void validateImplementsInterface(TypeLiteral<TInterface> typeLiteralTInterface,
                                                            Object value,
                                                            String propertyName)

Validate that the given property implements the specified interface.

Type Parameters:

TInterface - The type of interface expected.

Parameters:

typeLiteralTInterface - A TypeLiteral object representing the generic type TInterface.

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value does not implement TInterface.

validateImplementsInterface

public static <TInterface> void validateImplementsInterface(TypeLiteral<TInterface> typeLiteralTInterface,
                                                            Object value,
                                                            String propertyName,
                                                            String exceptionMessage)

Validate that the given property implements the specified interface.

Type Parameters:

TInterface - The type of interface expected.

Parameters:

typeLiteralTInterface - A TypeLiteral object representing the generic type TInterface.

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value does not implement TInterface.

validateNonNull

public static void validateNonNull(Object value,
                                   String propertyName)

Validate that the given property value must be non-null, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is null.

validateNonNull

public static void validateNonNull(Object value,
                                   String propertyName,
                                   String exceptionMessage)

Validate that the given property value must be non-null, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is null.

validateNonZero

public static void validateNonZero(double value,
                                   String propertyName)

Validate that the given property value must be non-zero, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is zero.

validateNonZero

public static void validateNonZero(double value,
                                   String propertyName,
                                   String exceptionMessage)

Validate that the given property value must be non-zero, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is zero.

validateNonNegative

public static void validateNonNegative(double value,
                                       String propertyName)

Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is less than zero.

validateNonNegative

public static void validateNonNegative(double value,
                                       String propertyName,
                                       String exceptionMessage)

Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is less than zero.

validateNonNegative

public static void validateNonNegative(int value,
                                       String propertyName)

Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is less than zero.

validateNonNegative

public static void validateNonNegative(int value,
                                       String propertyName,
                                       String exceptionMessage)

Validate that the given property value must be non-negative, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is less than zero.

validateGreaterThanZero

public static void validateGreaterThanZero(double value,
                                           String propertyName)

Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is less than or equal to zero.

validateGreaterThanZero

public static void validateGreaterThanZero(double value,
                                           String propertyName,
                                           String exceptionMessage)

Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is less than or equal to zero.

validateGreaterThanZero

public static void validateGreaterThanZero(int value,
                                           String propertyName)

Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is less than or equal to zero.

validateGreaterThanZero

public static void validateGreaterThanZero(int value,
                                           String propertyName,
                                           String exceptionMessage)

Validate that the given property value must be greater than zero, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is less than or equal to zero.

validateZeroToOne

public static void validateZeroToOne(double value,
                                     String propertyName,
                                     String exceptionMessage)

Validate that the given property value must be between zero and one, and throw PropertyInvalidException if it is not.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is not between zero and one.

validateNotNaN

public static void validateNotNaN(double value,
                                  String propertyName)

Validate that the given property value must not be NaN, and throw PropertyInvalidException if it is.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is NaN.

validateNotNaN

public static void validateNotNaN(double value,
                                  String propertyName,
                                  String exceptionMessage)

Validate that the given property value must not be NaN, and throw PropertyInvalidException if it is.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is NaN.

validateNotEmpty

public static <T> void validateNotEmpty(Collection<T> value,
                                        String propertyName)

Validate that the given property value must not be null or an empty collection, and throw PropertyInvalidException if it is.

Type Parameters:

T - The type of items in the collection.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is empty.

validateNotEmpty

public static <TKey,TValue> void validateNotEmpty(Map<TKey,TValue> value,
                                                  String propertyName)

Validate that the given property value must not be null or an empty dictionary, and throw PropertyInvalidException if it is.

Type Parameters:

TKey - The type of keys in the dictionary.

TValue - The type of values in the dictionary.

Parameters:

value - The property value.

propertyName - The name of the property.

Throws:

PropertyInvalidException - Thrown if value is empty.

validateNotEmpty

public static <T> void validateNotEmpty(Collection<T> value,
                                        String propertyName,
                                        String exceptionMessage)

Validate that the given property value must not be null or an empty collection, and throw PropertyInvalidException if it is.

Type Parameters:

T - The type of items in the collection.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is empty.

validateNotEmpty

public static <TKey,TValue> void validateNotEmpty(Map<TKey,TValue> value,
                                                  String propertyName,
                                                  String exceptionMessage)

Validate that the given property value must not be null or an empty dictionary, and throw PropertyInvalidException if it is.

Type Parameters:

TKey - The type of keys in the dictionary.

TValue - The type of values in the dictionary.

Parameters:

value - The property value.

propertyName - The name of the property.

exceptionMessage - The message to use when throwing the exception.

Throws:

PropertyInvalidException - Thrown if value is empty.