Class Pool

    • Method Detail

      • associate

        public void associate​(Resource res)
                       throws PoolsException
        Associate this pool with the supplied resource.
        Parameters:
        res - A resource in the same configuration as this pool.
        Throws:
        PoolsException - If there is an error whilst associating the resource with the pool.
      • dissociate

        public void dissociate​(Resource res)
                        throws PoolsException
        Dissociate this pool from the supplied resource.
        Parameters:
        res - A resource in the same configuration as this pool.
        Throws:
        PoolsException - If there is an error whilst dissociating the resource from the pool.
      • getResources

        public java.util.List getResources​(java.util.List values)
                                    throws PoolsException
        Get a list of resources which match the supplied selection criteria in values. Only resources which are associated with this pool are searched.
        Parameters:
        values - A list of values to be used to qualify the search.
        Returns:
        a list of resources which match the supplied criteria
        Throws:
        PoolsException - If there is an error executing the query.
      • getInformation

        public java.lang.String getInformation​(int deep)
                                        throws PoolsException
        Returns a descriptive string which describes the pool.
        Specified by:
        getInformation in class Element
        Parameters:
        deep - Whether the information should contain information about all contained elements.
        Returns:
        a descriptive string which describes the pool.
        Throws:
        PoolsException - If the pool cannot be located.
      • toString

        public java.lang.String toString()
        Returns a string representation of this pool.
        Overrides:
        toString in class Element
        Returns:
        a string representation of this pool.
      • equals

        public boolean equals​(java.lang.Object o)
        Indicates whether some other Pool is "equal to this one.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - the reference object with which to compare.
        Returns:
        true if this object is the same as the o argument; false otherwise.
        See Also:
        hashCode()
      • hashCode

        public int hashCode()
        Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for this object.
        See Also:
        equals(java.lang.Object), Hashtable
      • getElem

        protected long getElem()
                        throws PoolsException
        Return the pointer to this pool as an element.
        Specified by:
        getElem in class Element
        Returns:
        The pointer to the native pool which this object wraps.
        Throws:
        PoolsException - If there is an error converting the native pool pointer to a native elem pointer.