BgpLinkAttrIgpMetric (onos-providers-bgp-topology)

java.lang.Object
- org.onosproject.bgpio.types.attr.BgpLinkAttrIgpMetric

All Implemented Interfaces:

BgpValueType
```
public class BgpLinkAttrIgpMetric
extends Object
implements BgpValueType
```
Implements BGP link IGP metric attribute.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTRLINK_IGPMETRIC`
`static int`	`ATTRLINK_MAX_LEN`
`static int`	`ISIS_SMALL_METRIC`
`static int`	`ISIS_WIDE_METRIC`
`protected static org.slf4j.Logger`	`log`
`static int`	`OSPF_LINK_METRIC`

Constructor Summary

Constructors
Constructor and Description

BgpLinkAttrIgpMetric(int igpMetric, int igpMetricLen)
Constructor to initialize the value.

Constructors
Constructor and Description
`BgpLinkAttrIgpMetric(int igpMetric, int igpMetricLen)` Constructor to initialize the value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`attrLinkIgpMetric()` Returns the variable length IGP metric data.
`int`	`attrLinkIgpMetricLength()` Returns IGP metric data length.
`int`	`compareTo(Object o)` Compares two objects.
`boolean`	`equals(Object obj)`
`short`	`getType()` Returns the Type of BGP Message.
`int`	`hashCode()`
`static BgpLinkAttrIgpMetric`	`of(int igpMetric, int igpMetricLen)` Returns object of this class with specified values.
`static BgpLinkAttrIgpMetric`	`read(org.jboss.netty.buffer.ChannelBuffer cb)` Reads the BGP link attributes IGP Metric.
`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
  - log
```
protected static final org.slf4j.Logger log
```
  - ATTRLINK_IGPMETRIC
```
public static final int ATTRLINK_IGPMETRIC
```
    See Also:
    
    Constant Field Values
  - ATTRLINK_MAX_LEN
```
public static final int ATTRLINK_MAX_LEN
```
    See Also:
    
    Constant Field Values
  - ISIS_SMALL_METRIC
```
public static final int ISIS_SMALL_METRIC
```
    See Also:
    
    Constant Field Values
  - OSPF_LINK_METRIC
```
public static final int OSPF_LINK_METRIC
```
    See Also:
    
    Constant Field Values
  - ISIS_WIDE_METRIC
```
public static final int ISIS_WIDE_METRIC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BgpLinkAttrIgpMetric
```
public BgpLinkAttrIgpMetric(int igpMetric,
                            int igpMetricLen)
```
    Constructor to initialize the value.
    
    Parameters:
    
    igpMetric - 3 byte IGP metric data.
    
    igpMetricLen - length of IGP metric data.
- Method Detail
  - of
```
public static BgpLinkAttrIgpMetric of(int igpMetric,
                                      int igpMetricLen)
```
    Returns object of this class with specified values.
    
    Parameters:
    
    igpMetric - 3 byte IGP metric data.
    
    igpMetricLen - length of IGP metric data.
    
    Returns:
    
    object of BgpLinkAttrIgpMetric
  - read
```
public static BgpLinkAttrIgpMetric read(org.jboss.netty.buffer.ChannelBuffer cb)
                                 throws BgpParseException
```
    Reads the BGP link attributes IGP Metric.
    
    Parameters:
    
    cb - Channel buffer
    
    Returns:
    
    object of type BgpLinkAttrIgpMetric
    
    Throws:
    
    BgpParseException - while parsing BgpLinkAttrIgpMetric
  - attrLinkIgpMetric
```
public int attrLinkIgpMetric()
```
    Returns the variable length IGP metric data.
    
    Returns:
    
    IGP metric data
  - attrLinkIgpMetricLength
```
public int attrLinkIgpMetricLength()
```
    Returns IGP metric data length.
    
    Returns:
    
    IGP metric length
  - 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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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
  - 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

Class BgpLinkAttrIgpMetric

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

ATTRLINK_IGPMETRIC

ATTRLINK_MAX_LEN

ISIS_SMALL_METRIC

OSPF_LINK_METRIC

ISIS_WIDE_METRIC

Constructor Detail

BgpLinkAttrIgpMetric

Method Detail

of

read

attrLinkIgpMetric

attrLinkIgpMetricLength

getType

hashCode

equals

write

toString

compareTo