Interface VlanId

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<VlanId>, 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;
       }
     }
     
    The schema path to identify an instance is opendaylight-match-types/vlan-match-fields/vlan-id

    To create instances of this class use VlanIdBuilder.

    See Also:
    VlanIdBuilder
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default Class<VlanId> implementedInterface()
        Specified by:
        implementedInterface in interface 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:
        java.lang.Boolean vlanIdPresent, or null if it is not present.
      • isVlanIdPresent

        @Deprecated(forRemoval=true)
        default Boolean isVlanIdPresent()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • 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.