org.onosproject.cli.net

Enum IpProtocol

java.lang.Object

java.lang.Enum<IpProtocol>

org.onosproject.cli.net.IpProtocol

All Implemented Interfaces:

Serializable, Comparable<IpProtocol>

public enum IpProtocol
extends Enum<IpProtocol>

Known protocol values for IP protocol field that can be supplied to the CLI.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ICMP ICMP.
ICMP6 ICMP6.
TCP TCP.
UDP UDP.

Method Summary

Modifier and Type	Method and Description
static short	parseFromString(String input) Parse a string input that could contain an IpProtocol value.
short	value() Gets the value to use for this IpProtocol.
static IpProtocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static IpProtocol[]	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

ICMP

public static final IpProtocol ICMP

ICMP.

TCP

public static final IpProtocol TCP

TCP.

UDP

public static final IpProtocol UDP

UDP.

ICMP6

public static final IpProtocol ICMP6

ICMP6.

Method Detail

values

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

Returns:

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

valueOf

public static IpProtocol valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public short value()

Gets the value to use for this IpProtocol.

Returns:

short value to use for this IpProtocol

parseFromString

public static short parseFromString(String input)

Parse a string input that could contain an IpProtocol value. The value may appear in the string either as a known protocol name (one of the values of this enum), or a numeric protocol value.

Parameters:

input - the input string to parse

Returns:

the numeric value of the parsed IP protocol

Throws:

IllegalArgumentException - if the input string does not contain a value that can be parsed into an IP protocol