Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util

Enum Class StringUtils.Padding

java.lang.Object

java.lang.Enum<StringUtils.Padding>

org.tquadrat.foundation.util.StringUtils.Padding

All Implemented Interfaces:

Serializable, Comparable<StringUtils.Padding>, 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.Padding
extends Enum<StringUtils.Padding>

The padding mode that is used for the methods StringUtils.pad(CharSequence,int,char,Padding,boolean) and 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.5

UML Diagram

⁠

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

⁠

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
PADDING_CENTER	The pad characters are distributed evenly at begin and end of the string.
PADDING_LEFT	The pad characters are added at the beginning of the string (prefixing it).
PADDING_RIGHT	The pad characters are added the end of the string (as a suffix).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Padding()

Method Summary

Modifier and Type	Method	Description
protected abstract String	pad(CharSequence input, int padSize, char c)	Pads the given input String.
private static String	padding(int repeat, char padChar)	Returns padding using the specified pad character repeated to the given length.
static StringUtils.Padding	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StringUtils.Padding[]	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

PADDING_CENTER

public static final StringUtils.Padding PADDING_CENTER

The pad characters are distributed evenly at begin and end of the string.

PADDING_LEFT

public static final StringUtils.Padding PADDING_LEFT

The pad characters are added at the beginning of the string (prefixing it).

PADDING_RIGHT

public static final StringUtils.Padding PADDING_RIGHT

The pad characters are added the end of the string (as a suffix).

Constructor Details

Padding

private Padding()

Method Details

values

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

pad

protected abstract String pad(CharSequence input,
 int padSize,
 char c)

Pads the given input String.

Parameters:

input - The input String.

padSize - The pad size.

c - The pad character.

Returns:

The result String.

padding

private static String padding(int repeat,
 char padChar)
                       throws IndexOutOfBoundsException

Returns padding using the specified pad character repeated to the given length.

Padding.padding( 0, 'e' ) ⇒ ""
Padding.padding( 3, 'e' ) ⇒ "eee"
Padding.padding( -2, 'e' ) ⇒ IndexOutOfBoundsException


Parameters:

repeat - Number of times to repeat padChar; must be 0 or greater.

padChar - Character to repeat.

Returns:

String with repeated padChar character, or the empty String if repeat is 0.

Throws:

IndexOutOfBoundsException - repeat is less than 0.

See Also:

• StringUtils.repeat(int,int)