org.onosproject.bgpio.types

Class Origin

java.lang.Object

org.onosproject.bgpio.types.Origin

All Implemented Interfaces:

BgpValueType

public class Origin
extends Object
implements BgpValueType

Provides Implementation of mandatory BGP Origin path attribute.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Origin.OriginType Enum to provide ORIGIN types.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	FLAGS
static byte	ORIGIN_TYPE
static byte	ORIGIN_VALUE_LEN

Constructor Summary

Constructors

Constructor and Description
Origin(byte origin) Constructor to initialize parameters.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compares two objects.
boolean	equals(Object obj)
short	getType() Returns the Type of BGP Message.
int	hashCode()
boolean	isOriginSet() Returns true if origin attribute is present otherwise false.
Origin.OriginType	origin() Returns type of Origin in Enum values.
static Origin	read(org.jboss.netty.buffer.ChannelBuffer cb) Reads from ChannelBuffer and parses Origin.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the byte Stream of BGP Message to channel buffer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ORIGIN_TYPE

public static final byte ORIGIN_TYPE

See Also:

Constant Field Values

ORIGIN_VALUE_LEN

public static final byte ORIGIN_VALUE_LEN

See Also:

Constant Field Values

FLAGS

public static final byte FLAGS

See Also:

Constant Field Values

Constructor Detail

Origin

public Origin(byte origin)

Constructor to initialize parameters.

Parameters:

origin - origin value

Method Detail

isOriginSet

public boolean isOriginSet()

Returns true if origin attribute is present otherwise false.

Returns:

whether origin is present or not

origin

public Origin.OriginType origin()

Returns type of Origin in Enum values.

Returns:

type of Origin in Enum values

read

public static Origin read(org.jboss.netty.buffer.ChannelBuffer cb)
                   throws BgpParseException

Reads from ChannelBuffer and parses Origin.

Parameters:

cb - ChannelBuffer

Returns:

object of Origin

Throws:

BgpParseException - while parsing Origin path attribute

getType

public short getType()

Description copied from interface: BgpValueType

Returns the Type of BGP Message.

Specified by:

getType in interface BgpValueType

Returns:

short value of type

write

public int write(org.jboss.netty.buffer.ChannelBuffer cb)

Description copied from interface: BgpValueType

Writes the byte Stream of BGP Message to channel buffer.

Specified by:

write in interface BgpValueType

Parameters:

cb - channel buffer

Returns:

length written to channel buffer

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Object o)

Description copied from interface: BgpValueType

Compares two objects.

Specified by:

compareTo in interface BgpValueType

Parameters:

o - object

Returns:

result after comparing two objects