Module org.refcodes.mixin

Package org.refcodes.mixin

Enum TruncateMode

java.lang.Object

java.lang.Enum<TruncateMode>

org.refcodes.mixin.TruncateMode

All Implemented Interfaces:

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

public enum TruncateMode
extends Enum<TruncateMode>

The TruncateMode specifies for according algorithms on how to truncate a sequence.

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
HEAD	Truncate the head (left hand side) of a sequence.
HEAD_AND_TAIL	Truncate both head and tail (left and right hand side) of a sequence.
TAIL	Truncate the tail (right hand side) of a sequence.

Method Summary

Modifier and Type	Method	Description
boolean	isHead()	Returns true in case the head is to be truncated.
boolean	isTail()	Returns true in case the tail is to be truncated.
static TruncateMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TruncateMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HEAD

public static final TruncateMode HEAD

Truncate the head (left hand side) of a sequence.

HEAD_AND_TAIL

public static final TruncateMode HEAD_AND_TAIL

Truncate both head and tail (left and right hand side) of a sequence.

TAIL

public static final TruncateMode TAIL

Truncate the tail (right hand side) of a sequence.

Method Details

values

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

isHead

public boolean isHead()

Returns true in case the head is to be truncated.

Returns:

True in case the left hand side is to be truncated.

isTail

public boolean isTail()

Returns true in case the tail is to be truncated.

Returns:

True in case the right hand side is to be truncated.