Enum Class ValueTooLongBehavior

java.lang.Object

java.lang.Enum<ValueTooLongBehavior>

com.kingsrook.qqq.backend.core.model.metadata.fields.ValueTooLongBehavior

All Implemented Interfaces:

FieldBehavior<ValueTooLongBehavior>, FieldBehaviorForFrontend, Serializable, Comparable<ValueTooLongBehavior>, Constable

public enum ValueTooLongBehavior
extends Enum<ValueTooLongBehavior>
implements FieldBehavior<ValueTooLongBehavior>, FieldBehaviorForFrontend

Behaviors for string fields, if their value is too long. Sent to frontends (as the constant's name in the field's behaviors), so that a form can cap typing when the behavior is ERROR, and note trimming when it is TRUNCATE. Note: This was the first implementation of a FieldBehavior, so its test coverage is provided in ValueBehaviorApplierTest.

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
ERROR
PASS_THROUGH
TRUNCATE
TRUNCATE_ELLIPSIS

Method Summary

Modifier and Type	Method	Description
void	apply(ValueBehaviorApplier.Action action, List<QRecord> recordList, QInstance instance, QTableMetaData table, QFieldMetaData field)	Apply this behavior to a list of records
ValueTooLongBehavior	getDefault()	In case a behavior of this type wasn't set on the field, what should the default of this type be?
static ValueTooLongBehavior	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ValueTooLongBehavior[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.kingsrook.qqq.backend.core.model.metadata.fields.FieldBehavior

allowMultipleBehaviorsOfThisType, validateBehaviorConfiguration

Enum Constant Details

TRUNCATE

public static final ValueTooLongBehavior TRUNCATE

TRUNCATE_ELLIPSIS

public static final ValueTooLongBehavior TRUNCATE_ELLIPSIS

ERROR

public static final ValueTooLongBehavior ERROR

PASS_THROUGH

public static final ValueTooLongBehavior PASS_THROUGH

Method Details

values

public static ValueTooLongBehavior[] values()

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

Returns:

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

valueOf

public static ValueTooLongBehavior valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDefault

public ValueTooLongBehavior getDefault()

Description copied from interface: FieldBehavior

In case a behavior of this type wasn't set on the field, what should the default of this type be?

Specified by:

getDefault in interface FieldBehavior<ValueTooLongBehavior>

apply

public void apply(ValueBehaviorApplier.Action action,
 List<QRecord> recordList,
 QInstance instance,
 QTableMetaData table,
 QFieldMetaData field)

Description copied from interface: FieldBehavior

Apply this behavior to a list of records

Specified by:

apply in interface FieldBehavior<ValueTooLongBehavior>