Interface IpMapping

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

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

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

     list ip-mapping {
       key segment-id;
       leaf segment-id {
         type uint32;
       }
       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

    To create instances of this class use IpMappingBuilder.

    See Also:
    IpMappingBuilder, IpMappingKey
    • Field Summary

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

      • QNAME

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

      • implementedInterface

        default java.lang.Class<IpMapping> 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 IpMapping 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 IpMapping 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 IpMapping 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
      • getSegmentId

        org.opendaylight.yangtools.yang.common.Uint32 getSegmentId()
        Return segmentId, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 segmentId, or null if it is not present.
      • getIpMap

        @Nullable java.util.Map<IpMapKey,​IpMap> getIpMap()
        Return ipMap, or null if it is not present.
        Returns:
        java.util.Map ipMap, or null if it is not present.
      • nonnullIpMap

        default @NonNull java.util.Map<IpMapKey,​IpMap> nonnullIpMap()
        Return ipMap, or an empty list if it is not present.
        Returns:
        java.util.Map ipMap, or an empty list if it is not present.
      • key

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