Interface IpMap

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<IpMap>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<IpMapping>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<IpMapKey>

    @Generated("mdsal-binding-generator")
    public interface IpMap
    extends org.opendaylight.yangtools.yang.binding.ChildOf<IpMapping>, org.opendaylight.yangtools.yang.binding.Augmentable<IpMap>, org.opendaylight.yangtools.yang.binding.Identifiable<IpMapKey>

    This class represents the following YANG schema fragment defined in module odl-nat

     list ip-map {
       key internal-ip;
       leaf internal-ip {
         type string;
       }
       leaf external-ip {
         type string;
       }
       leaf label {
         type uint32;
       }
     }
     
    The schema path to identify an instance is odl-nat/intext-ip-map/ip-mapping/ip-map

    To create instances of this class use IpMapBuilder.

    See Also:
    IpMapBuilder, IpMapKey
    • 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 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull IpMap thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull IpMap obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull IpMap obj)
      Default implementation of Object.toString() contract for this interface.
      java.lang.String getExternalIp()
      Return externalIp, or null if it is not present.
      java.lang.String getInternalIp()
      Return internalIp, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getLabel()
      Return label, or null if it is not present.
      default java.lang.Class<IpMap> implementedInterface()  
      IpMapKey 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<IpMap> 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 IpMap 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 IpMap 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 IpMap 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
      • getInternalIp

        java.lang.String getInternalIp()
        Return internalIp, or null if it is not present.
        Returns:
        java.lang.String internalIp, or null if it is not present.
      • getExternalIp

        java.lang.String getExternalIp()
        Return externalIp, or null if it is not present.
        Returns:
        java.lang.String externalIp, or null if it is not present.
      • getLabel

        org.opendaylight.yangtools.yang.common.Uint32 getLabel()
        Return label, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 label, or null if it is not present.
      • key

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