Interface Allocations

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Allocations>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Network>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<AllocationsKey>

    @Generated("mdsal-binding-generator")
    public interface Allocations
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Network>, org.opendaylight.yangtools.yang.binding.Augmentable<Allocations>, org.opendaylight.yangtools.yang.binding.Identifiable<AllocationsKey>

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

     list allocations {
       key subnet;
       leaf subnet {
         type inet:ip-prefix;
       }
       list allocation-instance {
         key mac;
         leaf mac {
           type yang:phys-address;
         }
         leaf allocated-ip {
           type inet:ip-address;
         }
       }
     }
     
    The schema path to identify an instance is dhcp_allocation_pool/dhcp_allocation_pool/network/allocations

    To create instances of this class use AllocationsBuilder.

    See Also:
    AllocationsBuilder, AllocationsKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<Allocations> 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 Allocations 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 Allocations 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 Allocations 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
      • getSubnet

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSubnet()
        Return subnet, or null if it is not present.
             
                 subnet for the dhcp to allocate ip addresses
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix subnet, or null if it is not present.
      • getAllocationInstance

        @Nullable java.util.Map<AllocationInstanceKey,​AllocationInstance> getAllocationInstance()
        Return allocationInstance, or null if it is not present.
        Returns:
        java.util.Map allocationInstance, or null if it is not present.
      • nonnullAllocationInstance

        default @NonNull java.util.Map<AllocationInstanceKey,​AllocationInstance> nonnullAllocationInstance()
        Return allocationInstance, or an empty list if it is not present.
        Returns:
        java.util.Map allocationInstance, or an empty list if it is not present.