com.vmware.vcenter.vcha

Class IpFamily

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<IpFamily>

com.vmware.vcenter.vcha.IpFamily

All Implemented Interfaces:

java.io.Serializable

public final class IpFamily
extends ApiEnumeration<IpFamily>

The IpFamily enumeration class defines the Ip address family. This enumeration was added in vSphere API 6.7.1.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static IpFamily	IPV4 IPV4 address family.
static IpFamily	IPV6 IPv6 address family.

Method Summary

Modifier and Type	Method and Description
IpFamily.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static IpFamily	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static IpFamily[]	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

IPV4

public static final IpFamily IPV4

IPV4 address family. This constant field was added in vSphere API 6.7.1.

IPV6

public static final IpFamily IPV6

IPv6 address family. This constant field was added in vSphere API 6.7.1.

Method Detail

values

public static IpFamily[] 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 IpFamily but is not pre-defined.

Returns:

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

valueOf

public static IpFamily 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 IpFamily will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the IpFamily.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 IpFamily.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 IpFamily.Values._UNKNOWN enum constant is returned.

The native Java enum is IpFamily.Values.

Returns:

The Java enum constant. Never null.