Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools

Interface IdPool

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<IdPool>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<IdPools>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<IdPoolKey>
    @Generated("mdsal-binding-generator")
public interface IdPool
extends org.opendaylight.yangtools.yang.binding.ChildOf<IdPools>, org.opendaylight.yangtools.yang.binding.Augmentable<IdPool>, org.opendaylight.yangtools.yang.binding.Identifiable<IdPoolKey>

    This class represents the following YANG schema fragment defined in module id-manager 

     list id-pool {
   key pool-name;
   leaf pool-name {
     type string;
   }
   leaf block-size {
     type uint16;
   }
   leaf parent-pool-name {
     type string;
   }
   list child-pools {
     key child-pool-name;
     leaf child-pool-name {
       type string;
     }
     leaf last-access-time {
       type uint32;
     }
   }
   list id-entries {
     key id-key;
     leaf id-key {
       type string;
     }
     leaf-list id-value {
       type uint32;
     }
   }
   container available-ids-holder {
     uses available-ids;
   }
   container released-ids-holder {
     uses released-ids;
   }
 }
    The schema path to identify an instance is id-manager/id-pools/id-pool

    To create instances of this class use IdPoolBuilder.

    See Also:
    IdPoolBuilder, IdPoolKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default java.lang.Class<IdPool> 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 IdPool 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 IdPool 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 IdPool 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

      • getPoolName

        java.lang.String getPoolName()
        Return poolName, or null if it is not present.
        Returns:
        java.lang.String poolName, or null if it is not present.

      • getBlockSize

        org.opendaylight.yangtools.yang.common.Uint16 getBlockSize()
        Return blockSize, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 blockSize, or null if it is not present.

      • getParentPoolName

        java.lang.String getParentPoolName()
        Return parentPoolName, or null if it is not present.
        Returns:
        java.lang.String parentPoolName, or null if it is not present.

      • getChildPools

        @Nullable java.util.Map<ChildPoolsKey,​ChildPools> getChildPools()
        Return childPools, or null if it is not present.
        Returns:
        java.util.Map childPools, or null if it is not present.

      • nonnullChildPools

        default @NonNull java.util.Map<ChildPoolsKey,​ChildPools> nonnullChildPools()
        Return childPools, or an empty list if it is not present.
        Returns:
        java.util.Map childPools, or an empty list if it is not present.

      • getIdEntries

        @Nullable java.util.Map<IdEntriesKey,​IdEntries> getIdEntries()
        Return idEntries, or null if it is not present. 
             
         Id entry for the given Id Pool, where id-key is used to identify the id entry
        Returns:
        java.util.Map idEntries, or null if it is not present.

      • nonnullIdEntries

        default @NonNull java.util.Map<IdEntriesKey,​IdEntries> nonnullIdEntries()
        Return idEntries, or an empty list if it is not present.
        Returns:
        java.util.Map idEntries, or an empty list if it is not present.

      • getAvailableIdsHolder

        AvailableIdsHolder getAvailableIdsHolder()
        Return availableIdsHolder, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.id.pool.AvailableIdsHolder availableIdsHolder, or null if it is not present.

      • getReleasedIdsHolder

        ReleasedIdsHolder getReleasedIdsHolder()
        Return releasedIdsHolder, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.id.pool.ReleasedIdsHolder releasedIdsHolder, or null if it is not present.

      • key

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