Enum Class WhiteSpaceBehavior

java.lang.Object

java.lang.Enum<WhiteSpaceBehavior>

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

All Implemented Interfaces:

FieldBehavior<WhiteSpaceBehavior>, FieldBehaviorForFrontend, FieldFilterBehavior<WhiteSpaceBehavior>, Serializable, Comparable<WhiteSpaceBehavior>, Constable

public enum WhiteSpaceBehavior
extends Enum<WhiteSpaceBehavior>
implements FieldBehavior<WhiteSpaceBehavior>, FieldBehaviorForFrontend, FieldFilterBehavior<WhiteSpaceBehavior>

Field behavior that changes the whitespace of string values.

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
NONE
REMOVE_ALL_WHITESPACE
TRIM
TRIM_LEFT
TRIM_RIGHT

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleBehaviorsOfThisType()	control if multiple behaviors of this type should be allowed together on a field.
void	apply(ValueBehaviorApplier.Action action, List<QRecord> recordList, QInstance instance, QTableMetaData table, QFieldMetaData field)	Apply this behavior to a list of records
Serializable	applyToFilterCriteriaValue(Serializable value, QInstance instance, QTableMetaData table, QFieldMetaData field)	Apply the filter to a value from a criteria.
WhiteSpaceBehavior	getDefault()	In case a behavior of this type wasn't set on the field, what should the default of this type be?
List<String>	validateBehaviorConfiguration(QTableMetaData tableMetaData, QFieldMetaData fieldMetaData)	allow this behavior to be validated during QInstance validation.
static WhiteSpaceBehavior	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WhiteSpaceBehavior[]	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

Enum Constant Details

NONE

public static final WhiteSpaceBehavior NONE

REMOVE_ALL_WHITESPACE

public static final WhiteSpaceBehavior REMOVE_ALL_WHITESPACE

TRIM

public static final WhiteSpaceBehavior TRIM

TRIM_LEFT

public static final WhiteSpaceBehavior TRIM_LEFT

TRIM_RIGHT

public static final WhiteSpaceBehavior TRIM_RIGHT

Method Details

values

public static WhiteSpaceBehavior[] 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 WhiteSpaceBehavior 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 WhiteSpaceBehavior 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<WhiteSpaceBehavior>

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<WhiteSpaceBehavior>

applyToFilterCriteriaValue

public Serializable applyToFilterCriteriaValue(Serializable value,
 QInstance instance,
 QTableMetaData table,
 QFieldMetaData field)

Description copied from interface: FieldFilterBehavior

Apply the filter to a value from a criteria. If you don't want to change the input value, return the parameter.

Specified by:

applyToFilterCriteriaValue in interface FieldFilterBehavior<WhiteSpaceBehavior>

allowMultipleBehaviorsOfThisType

public boolean allowMultipleBehaviorsOfThisType()

Description copied from interface: FieldBehavior

control if multiple behaviors of this type should be allowed together on a field.

Specified by:

allowMultipleBehaviorsOfThisType in interface FieldBehavior<WhiteSpaceBehavior>

validateBehaviorConfiguration

public List<String> validateBehaviorConfiguration(QTableMetaData tableMetaData,
 QFieldMetaData fieldMetaData)

Description copied from interface: FieldBehavior

allow this behavior to be validated during QInstance validation. return a list of validation errors, if there are any.

Specified by:

validateBehaviorConfiguration in interface FieldBehavior<WhiteSpaceBehavior>