Interface ElanInterface

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ElanInterface>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ElanInterfaces>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ElanInterfaceKey>

    @Generated("mdsal-binding-generator")
    public interface ElanInterface
    extends org.opendaylight.yangtools.yang.binding.ChildOf<ElanInterfaces>, org.opendaylight.yangtools.yang.binding.Augmentable<ElanInterface>, org.opendaylight.yangtools.yang.binding.Identifiable<ElanInterfaceKey>

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

     list elan-interface {
       key name;
       leaf name {
         type leafref {
           path /if:interfaces/if:interface/if:name;
         }
       }
       leaf elan-instance-name {
         type string;
       }
       list static-mac-entries {
         key mac-address;
         leaf mac-address {
           type yang:phys-address;
         }
         leaf ip-prefix {
           type inet:ip-address;
         }
       }
       leaf description {
         type string {
           length 1..254;
         }
       }
     }
     
    The schema path to identify an instance is elan/elan-interfaces/elan-interface

    To create instances of this class use ElanInterfaceBuilder.

    See Also:
    ElanInterfaceBuilder, ElanInterfaceKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<ElanInterface> 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 ElanInterface 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:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull ElanInterface thisObj,
                                     java.lang.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:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull ElanInterface 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:
        java.lang.NullPointerException - if obj is null
      • getName

        java.lang.String getName()
        Return name, or null if it is not present.
        Returns:
        java.lang.String name, or null if it is not present.
      • getElanInstanceName

        java.lang.String getElanInstanceName()
        Return elanInstanceName, or null if it is not present.
        Returns:
        java.lang.String elanInstanceName, or null if it is not present.
      • getStaticMacEntries

        @Nullable java.util.Map<StaticMacEntriesKey,​StaticMacEntries> getStaticMacEntries()
        Return staticMacEntries, or null if it is not present.
        Returns:
        java.util.Map staticMacEntries, or null if it is not present.
      • nonnullStaticMacEntries

        default @NonNull java.util.Map<StaticMacEntriesKey,​StaticMacEntries> nonnullStaticMacEntries()
        Return staticMacEntries, or an empty list if it is not present.
        Returns:
        java.util.Map staticMacEntries, or an empty list if it is not present.
      • getDescription

        java.lang.String getDescription()
        Return description, or null if it is not present.
             
                 A textual description of elan port, the elan port description helps users
                 memorize the elan port.
             
         
        Returns:
        java.lang.String description, or null if it is not present.