PcepLSObject (onos-providers-pcep-tunnel)

All Known Implementing Classes:

PcepLSObjectVer1
```
public interface PcepLSObject
```
Abstraction of an entity providing PCEP LS Object.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface PcepLSObject.Builder
Builder interface with get and set functions to build LS object.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`PcepLSObject.Builder` Builder interface with get and set functions to build LS object.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getLSId()` Returns LS ID in LS Object.
`PcepObjectHeader`	`getLSObjHeader()` Returns LS object header.
`List<PcepValueType>`	`getOptionalTlv()` Returns list of Optional Tlvs in LS Object.
`byte`	`getProtocolId()` Returns ProtocolId in LS Object.
`boolean`	`getRemoveFlag()` Returns R flag in LS Object.
`boolean`	`getSyncFlag()` Returns sync flag in LS Object.
`void`	`setLSId(long lsId)` Sets LS ID in LS Object.
`void`	`setLSObjHeader(PcepObjectHeader obj)` Sets LS Object header.
`void`	`setOptionalTlv(List<PcepValueType> optionalTlvList)` Sets list of Optional Tlvs in LS Object.
`void`	`setProtocolId(byte protId)` Sets ProtocolId in LS Object.
`void`	`setRemoveFlag(boolean removeFlag)` Sets R flag in LS Object.
`void`	`setSyncFlag(boolean syncFlag)` Sets sync flag in LS Object.
`int`	`write(org.jboss.netty.buffer.ChannelBuffer bb)` Writes the LS Object into channel buffer.

- Method Detail
  - getLSObjHeader
```
PcepObjectHeader getLSObjHeader()
```
    Returns LS object header.
    
    Returns:
    
    LS object header
  - setLSObjHeader
```
void setLSObjHeader(PcepObjectHeader obj)
```
    Sets LS Object header.
    
    Parameters:
    
    obj - LS Object header
  - getProtocolId
```
byte getProtocolId()
```
    Returns ProtocolId in LS Object.
    
    Returns:
    
    ProtocolId in LS Object
  - setProtocolId
```
void setProtocolId(byte protId)
```
    Sets ProtocolId in LS Object.
    
    Parameters:
    
    protId - ProtocolId in LS Object
  - getRemoveFlag
```
boolean getRemoveFlag()
```
    Returns R flag in LS Object.
    
    Returns:
    
    R flag in LS Object
  - setRemoveFlag
```
void setRemoveFlag(boolean removeFlag)
```
    Sets R flag in LS Object.
    
    Parameters:
    
    removeFlag - R flag in LS Object
  - getSyncFlag
```
boolean getSyncFlag()
```
    Returns sync flag in LS Object.
    
    Returns:
    
    sync flag in LS Object
  - setSyncFlag
```
void setSyncFlag(boolean syncFlag)
```
    Sets sync flag in LS Object.
    
    Parameters:
    
    syncFlag - sync flag in LS Object
  - getLSId
```
long getLSId()
```
    Returns LS ID in LS Object.
    
    Returns:
    
    LS ID in LS Object
  - setLSId
```
void setLSId(long lsId)
```
    Sets LS ID in LS Object.
    
    Parameters:
    
    lsId - LS ID in LS Object
  - getOptionalTlv
```
List<PcepValueType> getOptionalTlv()
```
    Returns list of Optional Tlvs in LS Object.
    
    Returns:
    
    list of Optional Tlvs
  - setOptionalTlv
```
void setOptionalTlv(List<PcepValueType> optionalTlvList)
```
    Sets list of Optional Tlvs in LS Object.
    
    Parameters:
    
    optionalTlvList - list of Optional Tlvs
  - write
```
int write(org.jboss.netty.buffer.ChannelBuffer bb)
   throws PcepParseException
```
    Writes the LS Object into channel buffer.
    
    Parameters:
    
    bb - channel buffer
    
    Returns:
    
    Returns the writerIndex of this buffer
    
    Throws:
    
    PcepParseException - when object header is not written to channel buffer

Interface PcepLSObject

Nested Class Summary

Method Summary

Method Detail

getLSObjHeader

setLSObjHeader

getProtocolId

setProtocolId

getRemoveFlag

setRemoveFlag

getSyncFlag

setSyncFlag

getLSId

setLSId

getOptionalTlv

setOptionalTlv

write