Package com.unboundid.util
Enum HorizontalAlignment
- java.lang.Object
-
- java.lang.Enum<HorizontalAlignment>
-
- com.unboundid.util.HorizontalAlignment
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<HorizontalAlignment>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum HorizontalAlignment extends java.lang.Enum<HorizontalAlignment>
This enumeration defines a set of values that may indicate how text should be horizontally aligned.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
format(java.lang.StringBuilder buffer, java.lang.String text, int width)
Appends the provided string to the given buffer, aligned properly within the specified width.static HorizontalAlignment
forName(java.lang.String name)
Retrieves the horizontal alignment value with the specified name.static HorizontalAlignment
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static HorizontalAlignment[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LEFT
public static final HorizontalAlignment LEFT
Indicates that items should be aligned along their left edges.
-
CENTER
public static final HorizontalAlignment CENTER
Indicates that text should be aligned along their centers.
-
RIGHT
public static final HorizontalAlignment RIGHT
Indicates that text should be aligned along right edges.
-
-
Method Detail
-
values
public static HorizontalAlignment[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (HorizontalAlignment c : HorizontalAlignment.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static HorizontalAlignment valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
format
public void format(@NotNull java.lang.StringBuilder buffer, @NotNull java.lang.String text, int width)
Appends the provided string to the given buffer, aligned properly within the specified width. Spaces will be inserted before and/or after the text as necessary to achieve the desired alignment. This method will always append exactlywidth
characters (including spaces added to achieve the desired alignment) to the provided buffer. If the given text is longer thanwidth
, then only the firstwidth
characters of the provided text will be appended.- Parameters:
buffer
- The buffer to which the formatted text should be appended. It must not benull
.text
- The text to be added to the provided buffer, with additional spaces as necessary to achieve the desired width. It must not benull
.width
- The number of characters to append to the provided buffer. It must be greater than or equal to 1.
-
forName
@Nullable public static HorizontalAlignment forName(@NotNull java.lang.String name)
Retrieves the horizontal alignment value with the specified name.- Parameters:
name
- The name of the horizontal alignment value to retrieve. It must not benull
.- Returns:
- The requested horizontal alignment value, or
null
if no such value is defined.
-
-