Package org.instancio.settings

Enum OnSetFieldError

java.lang.Object

java.lang.Enum<OnSetFieldError>

org.instancio.settings.OnSetFieldError

All Implemented Interfaces:

Serializable, Comparable<OnSetFieldError>, java.lang.constant.Constable

@ExperimentalApi
public enum OnSetFieldError
extends Enum<OnSetFieldError>

A setting that specifies what should happen if an error occurs when setting a field's value.

Since:

2.1.0

See Also:

• Keys.ON_SET_FIELD_ERROR

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	Propagate the error up by throwing InstancioApiException.
IGNORE	Ignore the error and continue populating the object.

Method Summary

Modifier and Type	Method	Description
String	toString()
static OnSetFieldError	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OnSetFieldError[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FAIL

public static final OnSetFieldError FAIL

Propagate the error up by throwing InstancioApiException.

Since:

2.1.0

IGNORE

public static final OnSetFieldError IGNORE

Ignore the error and continue populating the object.

Warning: an error caused by assigning an incompatible type is considered a user error and is never ignored.

Since:

2.1.0

Method Details

values

public static OnSetFieldError[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OnSetFieldError valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<OnSetFieldError>