Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.push.vlan.action._case

Interface PushVlanAction

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

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

 container push-vlan-action {
   leaf ethernet-type {
     type uint16;
   }
   leaf tag {
     type int32;
   }
   leaf pcp {
     type int32;
   }
   leaf cfi {
     type vlan-cfi;
   }
   leaf vlan-id {
     type l2t:vlan-id;
   }
 }

To create instances of this class use PushVlanActionBuilder.

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 PushVlanAction thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull PushVlanAction obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull PushVlanAction obj)
    Default implementation of Object.toString() contract for this interface.
    VlanCfi
    getCfi()
    Return cfi, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getEthernetType()
    Return ethernetType, or null if it is not present.
    Integer
    getPcp()
    Return pcp, or null if it is not present.
    Integer
    getTag()
    Return tag, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
    getVlanId()
    Return vlanId, or null if it is not present.
    default Class<PushVlanAction>
    implementedInterface()
     
    default @NonNull VlanCfi
    requireCfi()
    Return cfi, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireEthernetType()
    Return ethernetType, guaranteed to be non-null.
    default @NonNull Integer
    requirePcp()
    Return pcp, guaranteed to be non-null.
    default @NonNull Integer
    requireTag()
    Return tag, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
    requireVlanId()
    Return vlanId, 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<PushVlanAction> 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 PushVlanAction 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 PushVlanAction 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 PushVlanAction 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

    • getEthernetType

      org.opendaylight.yangtools.yang.common.Uint16 getEthernetType()
      Return ethernetType, or null if it is not present.
      Returns:
      Uint16 ethernetType, or null if it is not present.

    • requireEthernetType

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireEthernetType()
      Return ethernetType, guaranteed to be non-null.
      Returns:
      Uint16 ethernetType, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ethernetType is not present

    • getTag

      Integer getTag()
      Return tag, or null if it is not present.
      Returns:
      Integer tag, or null if it is not present.

    • requireTag

      default @NonNull Integer requireTag()
      Return tag, guaranteed to be non-null.
      Returns:
      Integer tag, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if tag is not present

    • getPcp

      Integer getPcp()
      Return pcp, or null if it is not present.
      Returns:
      Integer pcp, or null if it is not present.

    • requirePcp

      default @NonNull Integer requirePcp()
      Return pcp, guaranteed to be non-null.
      Returns:
      Integer pcp, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if pcp is not present

    • getCfi

      VlanCfi getCfi()
      Return cfi, or null if it is not present.
      Returns:
      VlanCfi cfi, or null if it is not present.

    • requireCfi

      default @NonNull VlanCfi requireCfi()
      Return cfi, guaranteed to be non-null.
      Returns:
      VlanCfi cfi, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if cfi 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:
      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:
      VlanId vlanId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if vlanId is not present