org.onosproject.cli.net

Enum Icmp6Code

java.lang.Object

java.lang.Enum<Icmp6Code>

org.onosproject.cli.net.Icmp6Code

All Implemented Interfaces:

Serializable, Comparable<Icmp6Code>

public enum Icmp6Code
extends Enum<Icmp6Code>

Known values for ICMPv6 code field that can be supplied to the CLI.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDR_UNREACH Address unreachable.
BEYOND_SCOPE Beyond scope of source address.
COMM_PROHIBIT Communication with destination administratively prohibited.
DEFRAG_TIME_EXCEED Fragment reassembly time exceeded.
FAIL_POLICY Source address failed ingress/egress policy.
HDR_FIELD_ERR Erroneous header field encountered.
HOP_LIMIT_EXCEED Hop limit exceeded in transit.
IPV6_OPT_ERR Unrecognized IPv6 option encountered.
NEXT_HEADER_ERR Unrecognized Next Header type encountered.
NO_ROUTE No route to destination.
PORT_UNREACH Port unreachable.
REJECT_ROUTE Reject route to destination.
SRC_ROUTING_HEADER_ERR Error in Source Routing Header.

Method Summary

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

NO_ROUTE

public static final Icmp6Code NO_ROUTE

No route to destination.

COMM_PROHIBIT

public static final Icmp6Code COMM_PROHIBIT

Communication with destination administratively prohibited.

BEYOND_SCOPE

public static final Icmp6Code BEYOND_SCOPE

Beyond scope of source address.

ADDR_UNREACH

public static final Icmp6Code ADDR_UNREACH

Address unreachable.

PORT_UNREACH

public static final Icmp6Code PORT_UNREACH

Port unreachable.

FAIL_POLICY

public static final Icmp6Code FAIL_POLICY

Source address failed ingress/egress policy.

REJECT_ROUTE

public static final Icmp6Code REJECT_ROUTE

Reject route to destination.

SRC_ROUTING_HEADER_ERR

public static final Icmp6Code SRC_ROUTING_HEADER_ERR

Error in Source Routing Header.

HOP_LIMIT_EXCEED

public static final Icmp6Code HOP_LIMIT_EXCEED

Hop limit exceeded in transit.

DEFRAG_TIME_EXCEED

public static final Icmp6Code DEFRAG_TIME_EXCEED

Fragment reassembly time exceeded.

HDR_FIELD_ERR

public static final Icmp6Code HDR_FIELD_ERR

Erroneous header field encountered.

NEXT_HEADER_ERR

public static final Icmp6Code NEXT_HEADER_ERR

Unrecognized Next Header type encountered.

IPV6_OPT_ERR

public static final Icmp6Code IPV6_OPT_ERR

Unrecognized IPv6 option encountered.

Method Detail

values

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

Returns:

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

valueOf

public static Icmp6Code 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 byte value()

Gets the value to use for this Icmp6Code.

Returns:

short value to use for this Icmp6Code

parseFromString

public static byte parseFromString(String input)

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

Parameters:

input - the input string to parse

Returns:

the numeric value of the parsed ICMPv6 code

Throws:

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