Interface MacEntry

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<MacEntry>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ForwardingEntries>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<MacEntryKey>

    @Generated("mdsal-binding-generator")
    public interface MacEntry
    extends org.opendaylight.yangtools.yang.binding.ChildOf<ForwardingEntries>, org.opendaylight.yangtools.yang.binding.Augmentable<MacEntry>, org.opendaylight.yangtools.yang.binding.Identifiable<MacEntryKey>
    Details of a MAC address

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

     list mac-entry {
       key mac-address;
       leaf mac-address {
         type yang:phys-address;
       }
       leaf interface {
         type leafref {
           path /if:interfaces/if:interface/if:name;
         }
       }
       leaf controllerLearnedForwardingEntryTimestamp {
         type uint64;
       }
       leaf isStaticAddress {
         type boolean;
       }
       leaf ip-prefix {
         type inet:ip-address;
       }
       leaf src-tor-nodeid {
         type string;
       }
     }
     
    The schema path to identify an instance is elan/forwarding-entries/mac-entry

    To create instances of this class use MacEntryBuilder.

    See Also:
    MacEntryBuilder, MacEntryKey
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull MacEntry thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull MacEntry obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull MacEntry obj)
      Default implementation of Object.toString() contract for this interface.
      org.opendaylight.yangtools.yang.common.Uint64 getControllerLearnedForwardingEntryTimestamp()
      Return controllerLearnedForwardingEntryTimestamp, or null if it is not present.
      java.lang.String getInterface()
      Return interface, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpPrefix()
      Return ipPrefix, or null if it is not present.
      java.lang.Boolean getIsStaticAddress()
      Return isStaticAddress, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress getMacAddress()
      Return macAddress, or null if it is not present.
      java.lang.String getSrcTorNodeid()
      Return srcTorNodeid, or null if it is not present.
      default java.lang.Class<MacEntry> implementedInterface()  
      default java.lang.Boolean isIsStaticAddress()
      Deprecated, for removal: This API element is subject to removal in a future version.
      MacEntryKey key()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<MacEntry> 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 MacEntry 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 MacEntry 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 MacEntry 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
      • getMacAddress

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress getMacAddress()
        Return macAddress, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress macAddress, or null if it is not present.
      • getInterface

        java.lang.String getInterface()
        Return interface, or null if it is not present.
        Returns:
        java.lang.String interface, or null if it is not present.
      • getControllerLearnedForwardingEntryTimestamp

        org.opendaylight.yangtools.yang.common.Uint64 getControllerLearnedForwardingEntryTimestamp()
        Return controllerLearnedForwardingEntryTimestamp, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 controllerLearnedForwardingEntryTimestamp, or null if it is not present.
      • getIsStaticAddress

        java.lang.Boolean getIsStaticAddress()
        Return isStaticAddress, or null if it is not present.
        Returns:
        java.lang.Boolean isStaticAddress, or null if it is not present.
      • isIsStaticAddress

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isIsStaticAddress()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getIpPrefix

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpPrefix()
        Return ipPrefix, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ipPrefix, or null if it is not present.
      • getSrcTorNodeid

        java.lang.String getSrcTorNodeid()
        Return srcTorNodeid, or null if it is not present.
             
                 The src tor node id
             
         
        Returns:
        java.lang.String srcTorNodeid, or null if it is not present.
      • key

        MacEntryKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<MacEntryKey>