Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416.vlan.top.vlans

Interface Vlan

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Vlan>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Vlans>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<VlanKey>, VlanMembersState
@Generated("mdsal-binding-generator") public interface Vlan extends org.opendaylight.yangtools.yang.binding.ChildOf<Vlans>, org.opendaylight.yangtools.yang.binding.Augmentable<Vlan>, VlanMembersState, org.opendaylight.yangtools.yang.binding.KeyAware<VlanKey>
Configured VLANs keyed by id

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

 list vlan {
   key vlan-id;
   leaf vlan-id {
     type leafref {
       path ../config/vlan-id;
     }
   }
   container config {
     uses vlan-config;
   }
   container state {
     config false;
     uses vlan-config;
     uses vlan-state;
   }
   uses vlan-members-state;
 }

To create instances of this class use VlanBuilder.

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 Vlan thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Vlan obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Vlan 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.
    VlanId
    getVlanId()
    Return vlanId, or null if it is not present.
    default Class<Vlan>
    implementedInterface()
     
    VlanKey
    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 VlanId
    requireVlanId()
    Return vlanId, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

    Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416.VlanMembersState

    getMembers, nonnullMembers

  • 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<Vlan> 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 VlanMembersState

    • bindingHashCode

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

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

    • getVlanId

      VlanId getVlanId()
      Return vlanId, or null if it is not present. 
           
         references the configured vlan-id
      Returns:
      VlanId vlanId, or null if it is not present.

    • requireVlanId

      default @NonNull VlanId requireVlanId()
      Return vlanId, guaranteed to be non-null. 
           
         references the configured vlan-id
      Returns:
      VlanId vlanId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if vlanId is not present

    • getConfig

      Config getConfig()
      Return config, or null if it is not present. 
           
         Configuration parameters for VLANs
      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 variables for VLANs
      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.