Interface Table
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Table>
,org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Tables>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<TableKey>
@Generated("mdsal-binding-generator")
public interface Table
extends org.opendaylight.yangtools.yang.binding.ChildOf<Tables>, org.opendaylight.yangtools.yang.binding.Augmentable<Table>, org.opendaylight.yangtools.yang.binding.Identifiable<TableKey>
A network instance manages one or more forwarding or routing tables. These may
reflect the Layer 2 forwarding information base, the Layer 3 routing
base of the MPLS LFIB. Protocols may be explictly associated with a particular
table into which they populate entries. Multiple protocols may install entries
into a single table, or there may be a 1:1 relationship between a routing
protocol and a table .The import-policy and export-policy lists are used to
specify how routes leak between different tables within the same forwarding
instance.
This class represents the following YANG schema fragment defined in module openconfig-network-instance
list table { key table-name; leaf table-name { type leafref { path ../config/table-name; } } container config { uses table-config; } container state { config false; uses table-config; } }
To create instances of this class use TableBuilder
.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final @NonNull org.opendaylight.yangtools.yang.common.QName
YANG identifier of the statement represented by this class. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
bindingEquals
(@NonNull Table thisObj, Object obj) Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode
(@NonNull Table obj) Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString
(@NonNull Table obj) Default implementation ofObject.toString()
contract for this interface.Return config, ornull
if it is not present.getState()
Return state, ornull
if it is not present.Return tableName, ornull
if it is not present.key()
@NonNull Config
Return config, or an empty instance if it is not present.@NonNull State
Return state, or an empty instance if it is not present.default @NonNull String
Return tableName, guaranteed to be non-null.Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations
-
Field Details
-
QNAME
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAMEYANG identifier of the statement represented by this class.
-
-
Method Details
-
implementedInterface
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
Default implementation ofObject.hashCode()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.- Parameters:
obj
- Object for which to generate hashCode() result.- Returns:
- Hash code value of data modeled by this interface.
- Throws:
NullPointerException
- ifobj
isnull
-
bindingEquals
Default implementation ofObject.equals(Object)
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.- Parameters:
thisObj
- Object acting as the receiver of equals invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
isnull
-
bindingToString
Default implementation ofObject.toString()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.- Parameters:
obj
- Object for which to generate toString() result.- Returns:
String
value of data modeled by this interface.- Throws:
NullPointerException
- ifobj
isnull
-
key
TableKey key()- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<TableKey>
-
getTableName
String getTableName()Return tableName, ornull
if it is not present.A name for the table
- Returns:
String
tableName, ornull
if it is not present.
-
requireTableName
Return tableName, guaranteed to be non-null.A name for the table
- Returns:
String
tableName, guaranteed to be non-null.- Throws:
NoSuchElementException
- if tableName is not present
-
getConfig
Config getConfig()Return config, ornull
if it is not present.Configuration parameters related to the table
- Returns:
Config
config, ornull
if it is not present.
-
nonnullConfig
@NonNull Config nonnullConfig()Return config, or an empty instance if it is not present.- Returns:
Config
config, or an empty instance if it is not present.
-
getState
State getState()Return state, ornull
if it is not present.State parameters related to the table
- Returns:
State
state, ornull
if it is not present.
-
nonnullState
@NonNull State nonnullState()Return state, or an empty instance if it is not present.- Returns:
State
state, or an empty instance if it is not present.
-