Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.vlan.match.fields

Interface VlanId

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<VlanId>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<VlanMatchFields>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface VlanId extends org.opendaylight.yangtools.yang.binding.ChildOf<VlanMatchFields>, org.opendaylight.yangtools.yang.binding.Augmentable<VlanId>
VLAN id.

This class represents the following YANG schema fragment defined in module opendaylight-match-types 

 container vlan-id {
   presence "Match field is active and set";
   leaf vlan-id-present {
     type boolean;
   }
   leaf vlan-id {
     type l2t:vlan-id;
   }
 }

To create instances of this class use VlanIdBuilder.

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 VlanId thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull VlanId obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull VlanId obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
    getVlanId()
    Return vlanId, or null if it is not present.
    Boolean
    getVlanIdPresent()
    Return vlanIdPresent, or null if it is not present.
    default Class<VlanId>
    implementedInterface()
     
    default @NonNull org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
    requireVlanId()
    Return vlanId, guaranteed to be non-null.
    default @NonNull Boolean
    requireVlanIdPresent()
    Return vlanIdPresent, 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<VlanId> 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 VlanId 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 VlanId 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 VlanId 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

    • getVlanIdPresent

      Boolean getVlanIdPresent()
      Return vlanIdPresent, or null if it is not present.
      Returns:
      Boolean vlanIdPresent, or null if it is not present.

    • requireVlanIdPresent

      default @NonNull Boolean requireVlanIdPresent()
      Return vlanIdPresent, guaranteed to be non-null.
      Returns:
      Boolean vlanIdPresent, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if vlanIdPresent is not present

    • getVlanId

      org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanId()
      Return vlanId, or null if it is not present.
      Returns:
      org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId vlanId, or null if it is not present.

    • requireVlanId

      default @NonNull org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId requireVlanId()
      Return vlanId, guaranteed to be non-null.
      Returns:
      org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId vlanId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if vlanId is not present