Package com.unboundid.util
Enum OutputFormat
- java.lang.Object
-
- java.lang.Enum<OutputFormat>
-
- com.unboundid.util.OutputFormat
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<OutputFormat>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum OutputFormat extends java.lang.Enum<OutputFormat>
This enum defines a set of output formats that may be used in conjunction with theColumnFormatter
when formatting data.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description COLUMNS
Indicates that the output should be formatted in columns.CSV
Indicates that the output should be formatted as comma-separated values.TAB_DELIMITED_TEXT
Indicates that the output should be formatted as tab-delimited text.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static OutputFormat
forName(java.lang.String name)
Retrieves the output format value with the specified name.static OutputFormat
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static OutputFormat[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
COLUMNS
public static final OutputFormat COLUMNS
Indicates that the output should be formatted in columns.
-
TAB_DELIMITED_TEXT
public static final OutputFormat TAB_DELIMITED_TEXT
Indicates that the output should be formatted as tab-delimited text.
-
CSV
public static final OutputFormat CSV
Indicates that the output should be formatted as comma-separated values.
-
-
Method Detail
-
values
public static OutputFormat[] 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 (OutputFormat c : OutputFormat.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static OutputFormat 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
-
forName
public static OutputFormat forName(java.lang.String name)
Retrieves the output format value with the specified name.- Parameters:
name
- The name of the output format value to retrieve. It must not benull
.- Returns:
- The requested output format value, or
null
if no such format is defined.
-
-