Package org.opendaylight.netvirt.neutronvpn.api.enums

Enum IpVersionChoice

java.lang.Object

java.lang.Enum<IpVersionChoice>

org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IpVersionChoice>

public enum IpVersionChoice
extends java.lang.Enum<IpVersionChoice>

this enum is used to make a choice between IPv4 or IPv6 or both.

Enum Constant Summary

Enum Constants

Enum Constant	Description
IPV4
IPV4AND6
IPV6
UNDEFINED

Field Summary

Fields

Modifier and Type	Field	Description
int	choice

Method Summary

Modifier and Type	Method	Description
IpVersionChoice	addVersion(IpVersionChoice ipVers)	used to get an association of ipv4 and/or ipv6 choice if it is possible.
boolean	isIpVersionChosen(IpVersionChoice arg)
static IpVersionChoice	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static IpVersionChoice[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNDEFINED

public static final IpVersionChoice UNDEFINED

IPV4

public static final IpVersionChoice IPV4

IPV6

public static final IpVersionChoice IPV6

IPV4AND6

public static final IpVersionChoice IPV4AND6

Field Detail

choice

public final int choice

Method Detail

values

public static IpVersionChoice[] 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 (IpVersionChoice c : IpVersionChoice.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IpVersionChoice 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 name

java.lang.NullPointerException - if the argument is null

isIpVersionChosen

public boolean isIpVersionChosen(IpVersionChoice arg)

addVersion

public IpVersionChoice addVersion(IpVersionChoice ipVers)

used to get an association of ipv4 and/or ipv6 choice if it is possible.

Parameters:

ipVers - the IP version to combine with this

Returns:

the new IpVersionChoice