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<Subinterfaces,Subinterface,SubinterfaceKey>, org.opendaylight.yangtools.binding.lib.ImplementedInterface<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.lib.JavaContract<org.opendaylight.yangtools.binding.DataContainer,Subinterface>, org.opendaylight.yangtools.binding.lib.JavaDataContainer<Subinterface>, org.opendaylight.yangtools.binding.KeyAware<SubinterfaceKey>, org.opendaylight.yangtools.binding.ParentObject<Subinterface>
@Generated("mdsal-binding-generator") public interface Subinterface extends org.opendaylight.yangtools.binding.EntryObject<Subinterfaces,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
    The YANG identifier of the list statement represented by this interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    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()
     
    default boolean
    javaEQ(Subinterface obj)
     
    default int
    javaHC()
     
    default String
    javaTS()
     
    @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

    Methods inherited from interface org.opendaylight.yangtools.binding.EntryObject

    key

    Methods inherited from interface org.opendaylight.yangtools.binding.lib.JavaContract

    equals, hashCode, toString

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      The YANG identifier of the list statement represented by this interface.

  • Method Details

    • 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. 
           
         Configurable items at the subinterface level
      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. 
           
         Operational state data for logical interfaces
      Returns:
      State state, or an empty instance if it is not present.

    • 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
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.lib.ImplementedInterface<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.ParentObject<Subinterface>

    • javaHC

      default int javaHC()
      Specified by:
      javaHC in interface org.opendaylight.yangtools.binding.lib.JavaContract<org.opendaylight.yangtools.binding.DataContainer,Subinterface>
      Specified by:
      javaHC in interface org.opendaylight.yangtools.binding.lib.JavaDataContainer<Subinterface>

    • javaEQ

      default boolean javaEQ(Subinterface obj)
      Specified by:
      javaEQ in interface org.opendaylight.yangtools.binding.lib.JavaContract<org.opendaylight.yangtools.binding.DataContainer,Subinterface>
      Specified by:
      javaEQ in interface org.opendaylight.yangtools.binding.lib.JavaDataContainer<Subinterface>

    • javaTS

      default String javaTS()
      Specified by:
      javaTS in interface org.opendaylight.yangtools.binding.lib.JavaContract<org.opendaylight.yangtools.binding.DataContainer,Subinterface>
      Specified by:
      javaTS in interface org.opendaylight.yangtools.binding.lib.JavaDataContainer<Subinterface>