com.vmware.vapi.metadata.cli

Class CommandTypes.FormatterType

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<CommandTypes.FormatterType>

com.vmware.vapi.metadata.cli.CommandTypes.FormatterType

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CommandTypes

public static final class CommandTypes.FormatterType
extends ApiEnumeration<CommandTypes.FormatterType>

The FormatterType enumeration class defines supported CLI output formatter types. See CommandTypes.Info.getFormatter().

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandTypes.FormatterType.Values Native Java enum representing this enumeration class.

Field Summary

Fields

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.

Method Summary

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(java.lang.String name) Returns the enumeration constant for the specified name.
static CommandTypes.FormatterType[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SIMPLE

public static final CommandTypes.FormatterType SIMPLE

Displays command output as it is.

TABLE

public static final CommandTypes.FormatterType TABLE

Displays command output in table format.

JSON

public static final CommandTypes.FormatterType JSON

Displays command output in JSON format.

XML

public static final CommandTypes.FormatterType XML

Displays command output in XML format.

CSV

public static final CommandTypes.FormatterType CSV

Displays command output in CSV format.

HTML

public static final CommandTypes.FormatterType HTML

Displays command output in HTML format.

Method Detail

values

public static CommandTypes.FormatterType[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

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.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static CommandTypes.FormatterType valueOf(java.lang.String name)

Returns the enumeration constant for the specified 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.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public CommandTypes.FormatterType.Values getEnumValue()

Returns a native Java 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.

Returns:

The Java enum constant. Never null.