Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.subinterfaces.top.subinterfaces

Interface Subinterface

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<Subinterface>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<Subinterfaces>, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.EntryObject<Subinterface,SubinterfaceKey>, org.opendaylight.yangtools.binding.KeyAware<SubinterfaceKey>
@Generated("mdsal-binding-generator") public interface Subinterface extends org.opendaylight.yangtools.binding.ChildOf<Subinterfaces>, org.opendaylight.yangtools.binding.EntryObject<Subinterface,SubinterfaceKey>
The list of subinterfaces (logical interfaces) associated with a physical interface

This class represents the following YANG schema fragment defined in module openconfig-interfaces 

 list subinterface {
   key index;
   leaf index {
     type leafref {
       path ../oc-if:config/oc-if:index;
     }
   }
   container config {
     uses subinterfaces-config;
   }
   container state {
     config false;
     uses subinterfaces-config;
     uses subinterfaces-state;
   }
 }

To create instances of this class use SubinterfaceBuilder.

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 Subinterface thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Subinterface obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Subinterface obj)
    Default implementation of Object.toString() contract for this interface.
    Config
    getConfig()
    Return config, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getIndex()
    Return index, or null if it is not present.
    State
    getState()
    Return state, or null if it is not present.
    default Class<Subinterface>
    implementedInterface()
     
    SubinterfaceKey
    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 org.opendaylight.yangtools.yang.common.Uint32
    requireIndex()
    Return index, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yangtools.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<Subinterface> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.DataObject

    • bindingHashCode

      static int bindingHashCode(@NonNull Subinterface 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 Subinterface 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 Subinterface 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

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

    • getIndex

      org.opendaylight.yangtools.yang.common.Uint32 getIndex()
      Return index, or null if it is not present. 
           
         The index number of the subinterface -- used to address the logical interface
      Returns:
      Uint32 index, or null if it is not present.

    • requireIndex

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireIndex()
      Return index, guaranteed to be non-null. 
           
         The index number of the subinterface -- used to address the logical interface
      Returns:
      Uint32 index, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if index is not present

    • getConfig

      Config getConfig()
      Return config, or null if it is not present. 
           
         Configurable items at the subinterface level
      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. 
           
         Operational state data for logical interfaces
      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.