org.onosproject.net

Enum EncapsulationType

java.lang.Object

java.lang.Enum<EncapsulationType>

org.onosproject.net.EncapsulationType

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
MPLS Indicates an MPLS encapsulation.
NONE Indicates no encapsulation.
VLAN Indicates a VLAN encapsulation.

Method Summary

Modifier and Type	Method and Description
static EncapsulationType	enumFromString(java.lang.String encap) Alternative method to valueOf.
static EncapsulationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EncapsulationType[]	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

NONE

public static final EncapsulationType NONE

Indicates no encapsulation.

MPLS

public static final EncapsulationType MPLS

Indicates an MPLS encapsulation.

VLAN

public static final EncapsulationType VLAN

Indicates a VLAN encapsulation.

Method Detail

values

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

Returns:

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

valueOf

public static EncapsulationType 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

enumFromString

public static EncapsulationType enumFromString(java.lang.String encap)

Alternative method to valueOf. It returns the encapsulation type constant corresponding to the given string. If the parameter does not match a constant name, or is null, NONE is returned.

Parameters:

encap - the string representing the encapsulation type

Returns:

the EncapsulationType constant corresponding to the string given