Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util

Enum Class StringUtils.Clipping

java.lang.Object

java.lang.Enum<StringUtils.Clipping>

org.tquadrat.foundation.util.StringUtils.Clipping

All Implemented Interfaces:

Serializable, Comparable<StringUtils.Clipping>, Constable

Enclosing class:

StringUtils

@ClassVersion(sourceVersion="$Id: StringUtils.java 1138 2024-06-03 22:46:54Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public static enum StringUtils.Clipping
extends Enum<StringUtils.Clipping>

The clipping mode that is used for the method StringUtils.pad(CharSequence,int,char,Padding,Clipping)

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: StringUtils.java 1138 2024-06-03 22:46:54Z tquadrat $

Since:

0.0.3

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.StringUtils.Clipping"

⁠

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
CLIPPING_ABBREVIATE	If an input String is longer than the target length, it will be abbreviated to that length, by calling StringUtils.abbreviate(CharSequence, int) with that String.
CLIPPING_ABBREVIATE_MIDDLE	If an input String is longer than the target length, it will be abbreviated to that length, by calling StringUtils.abbreviateMiddle(CharSequence, int) with that String.
CLIPPING_CUT	If an input String is longer than the target length, it will be just shortened to that length.
CLIPPING_NONE	If an input String is already longer than the target length, it will be returned unchanged.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Clipping()

Method Summary

Modifier and Type	Method	Description
protected abstract String	clip(CharSequence input, int length)	Clips the given input String.
static StringUtils.Clipping	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StringUtils.Clipping[]	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

CLIPPING_NONE

public static final StringUtils.Clipping CLIPPING_NONE

If an input String is already longer than the target length, it will be returned unchanged.

CLIPPING_CUT

public static final StringUtils.Clipping CLIPPING_CUT

If an input String is longer than the target length, it will be just shortened to that length.

CLIPPING_ABBREVIATE

public static final StringUtils.Clipping CLIPPING_ABBREVIATE

If an input String is longer than the target length, it will be abbreviated to that length, by calling StringUtils.abbreviate(CharSequence, int) with that String. The minimum length for the padded String is 4.

CLIPPING_ABBREVIATE_MIDDLE

public static final StringUtils.Clipping CLIPPING_ABBREVIATE_MIDDLE

If an input String is longer than the target length, it will be abbreviated to that length, by calling StringUtils.abbreviateMiddle(CharSequence, int) with that String. The minimum length for the padded String is 5.

Constructor Details

Clipping

private Clipping()

Method Details

values

public static StringUtils.Clipping[] 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 StringUtils.Clipping 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

clip

protected abstract String clip(CharSequence input,
 int length)

Clips the given input String.

Parameters:

input - The input String.

length - The target length.

Returns:

The result String.