Interface VlanBindings

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<VlanBindings>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<HwvtepPhysicalPortAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VlanBindingsKey>

    @Generated("mdsal-binding-generator")
    public interface VlanBindings
    extends org.opendaylight.yangtools.yang.binding.ChildOf<HwvtepPhysicalPortAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<VlanBindings>, org.opendaylight.yangtools.yang.binding.Identifiable<VlanBindingsKey>
    A map of vlan ID to logical switch pairs

    This class represents the following YANG schema fragment defined in module hwvtep

     list vlan-bindings {
       key vlan-id-key;
       leaf vlan-id-key {
         type ethertype:vlan-id;
       }
       leaf logical-switch-ref {
         type hwvtep-logical-switch-ref;
       }
     }
     

    To create instances of this class use VlanBindingsBuilder.

    See Also:
    VlanBindingsBuilder, VlanBindingsKey
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

        default Class<VlanBindings> 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 VlanBindings 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 VlanBindings 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 VlanBindings 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
      • getVlanIdKey

        org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanIdKey()
        Return vlanIdKey, or null if it is not present.
             
                 vlan ids in the range 0 - 4095
             
         
        Returns:
        VlanId vlanIdKey, or null if it is not present.
      • requireVlanIdKey

        default @NonNull org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId requireVlanIdKey()
        Return vlanIdKey, guaranteed to be non-null.
             
                 vlan ids in the range 0 - 4095
             
         
        Returns:
        VlanId vlanIdKey, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if vlanIdKey is not present
      • getLogicalSwitchRef

        HwvtepLogicalSwitchRef getLogicalSwitchRef()
        Return logicalSwitchRef, or null if it is not present.
             
                 Reference to logical switch for the vlan
             
         
        Returns:
        HwvtepLogicalSwitchRef logicalSwitchRef, or null if it is not present.
      • requireLogicalSwitchRef

        default @NonNull HwvtepLogicalSwitchRef requireLogicalSwitchRef()
        Return logicalSwitchRef, guaranteed to be non-null.
             
                 Reference to logical switch for the vlan
             
         
        Returns:
        HwvtepLogicalSwitchRef logicalSwitchRef, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if logicalSwitchRef is not present