Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.tables

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.KeyAware<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.KeyAware<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

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    bindingEquals(@NonNull Table thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Table obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Table obj)
    Default implementation of Object.toString() contract for this interface.
    Config
    getConfig()
    Return config, or null if it is not present.
    State
    getState()
    Return state, or null if it is not present.
    String
    getTableName()
    Return tableName, or null if it is not present.
    default Class<Table>
    implementedInterface()
     
    TableKey
    key()
     
    @NonNull Config
    nonnullConfig()
    Return config, or an empty instance if it is not present.
    @NonNull State
    nonnullState()
    Return state, or an empty instance if it is not present.
    default @NonNull String
    requireTableName()
    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 QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<Table> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • bindingHashCode

      static int bindingHashCode(@NonNull Table obj)
      Default implementation of Object.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 - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull Table thisObj, Object obj)
      Default implementation of Object.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 invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull Table obj)
      Default implementation of Object.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 - if obj is null

    • key

      TableKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.yang.binding.KeyAware<TableKey>

    • getTableName

      String getTableName()
      Return tableName, or null if it is not present. 
           
         A name for the table
      Returns:
      String tableName, or null if it is not present.

    • requireTableName

      default @NonNull String 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, or null if it is not present. 
           
         Configuration parameters related to the table
      Returns:
      Config config, or null 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, or null if it is not present. 
           
         State parameters related to the table
      Returns:
      State state, or null 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.