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

Interface Interface

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Interface>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Interfaces>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, InterfacePhysHoldtimeTop, org.opendaylight.yangtools.yang.binding.KeyAware<InterfaceKey>, SubinterfacesTop
@Generated("mdsal-binding-generator") public interface Interface extends org.opendaylight.yangtools.yang.binding.ChildOf<Interfaces>, org.opendaylight.yangtools.yang.binding.Augmentable<Interface>, InterfacePhysHoldtimeTop, SubinterfacesTop, org.opendaylight.yangtools.yang.binding.KeyAware<InterfaceKey>
The list of named interfaces on the device.

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

 list interface {
   key name;
   leaf name {
     type leafref {
       path ../oc-if:config/oc-if:name;
     }
   }
   container config {
     uses interface-phys-config;
   }
   container state {
     config false;
     uses interface-phys-config;
     uses interface-common-state;
     uses interface-counters-state;
   }
   uses interface-phys-holdtime-top;
   uses subinterfaces-top;
 }

To create instances of this class use InterfaceBuilder.

See Also:

  • 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<Interface> 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
      Specified by:
      implementedInterface in interface InterfacePhysHoldtimeTop
      Specified by:
      implementedInterface in interface SubinterfacesTop

    • bindingHashCode

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

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

    • getName

      String getName()
      Return name, or null if it is not present. 
           
         References the configured name of the interface
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null. 
           
         References the configured name of the interface
      Returns:
      String name, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if name is not present

    • getConfig

      Config getConfig()
      Return config, or null if it is not present. 
           
         Configurable items at the global, physical interface 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 at the global interface level
      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.