public static final class CommandTypes.FormatterType extends ApiEnumeration<CommandTypes.FormatterType>
FormatterType
enumeration class defines supported CLI output
formatter types. See CommandTypes.Info.getFormatter()
.
Modifier and Type | Class and Description |
---|---|
static class |
CommandTypes.FormatterType.Values
Native Java
enum representing this enumeration class. |
Modifier and Type | Field and Description |
---|---|
static CommandTypes.FormatterType |
CSV
Displays command output in CSV format.
|
static CommandTypes.FormatterType |
HTML
Displays command output in HTML format.
|
static CommandTypes.FormatterType |
JSON
Displays command output in JSON format.
|
static CommandTypes.FormatterType |
SIMPLE
Displays command output as it is.
|
static CommandTypes.FormatterType |
TABLE
Displays command output in table format.
|
static CommandTypes.FormatterType |
XML
Displays command output in XML format.
|
Modifier and Type | Method and Description |
---|---|
CommandTypes.FormatterType.Values |
getEnumValue()
Returns a native Java
enum constant representing this enumeration
constant. |
boolean |
isUnknown()
Checks if this enumeration constant is unknown.
|
static CommandTypes.FormatterType |
valueOf(String name)
Returns the enumeration constant for the specified name.
|
static CommandTypes.FormatterType[] |
values()
Retrieve all enumeration constants pre-defined by this enumeration class.
|
equals, hashCode, name, toString
public static final CommandTypes.FormatterType SIMPLE
public static final CommandTypes.FormatterType TABLE
public static final CommandTypes.FormatterType JSON
public static final CommandTypes.FormatterType XML
public static final CommandTypes.FormatterType CSV
public static final CommandTypes.FormatterType HTML
public static CommandTypes.FormatterType[] values()
Additional instances might exist at runtime, for example to represent a
new constant added to this enumeration class in subsequent version of the
API. Such new constant is represented as instance of CommandTypes.FormatterType
but is not pre-defined.
null
.public static CommandTypes.FormatterType valueOf(String name)
If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.
Otherwise, a new instance of CommandTypes.FormatterType
will be returned for the
specified name, which will not be one of the pre-defined constant
instances. Such new instance maps to the CommandTypes.FormatterType.Values._UNKNOWN
enum
constant from the native Java enum
.
name
- The name of the constant to return. Must not be null
.null
.public boolean isUnknown()
valueOf(java.lang.String)
and values()
.true
if this constant is unknown, and false
otherwise.public CommandTypes.FormatterType.Values getEnumValue()
enum
constant representing this enumeration
constant. The result is useful for usual handling of Java enum
,
for example it can be used in switch
statements.
If this enumeration constant is unknown, then CommandTypes.FormatterType.Values._UNKNOWN
enum
constant is returned.
The native Java enum
is CommandTypes.FormatterType.Values
.
enum
constant. Never null
.Copyright © 2016. All Rights Reserved.