Class BaseResourceCollectionContainer

    • Constructor Detail

      • BaseResourceCollectionContainer

        public BaseResourceCollectionContainer()
        Create a new BaseResourceCollectionContainer.
      • BaseResourceCollectionContainer

        public BaseResourceCollectionContainer​(Project project)
        Create a new BaseResourceCollectionContainer.
        Parameters:
        project - Project
        Since:
        Ant 1.8
    • Method Detail

      • setCache

        public void setCache​(boolean b)
        Set whether to cache collections.
        Parameters:
        b - boolean cache flag.
      • isCache

        public boolean isCache()
        Learn whether to cache collections. Default is true.
        Returns:
        boolean cache flag.
      • addAll

        public void addAll​(java.util.Collection<? extends ResourceCollection> c)
                    throws BuildException
        Add the Collection of ResourceCollections to the container.
        Parameters:
        c - the Collection whose elements to add.
        Throws:
        BuildException - on error.
      • iterator

        public final java.util.Iterator<Resource> iterator()
        Fulfill the ResourceCollection contract. The Iterator returned will throw ConcurrentModificationExceptions if ResourceCollections are added to this container while the Iterator is in use.
        Specified by:
        iterator in interface java.lang.Iterable<Resource>
        Returns:
        a "fail-fast" Iterator.
      • size

        public int size()
        Fulfill the ResourceCollection contract.
        Specified by:
        size in interface ResourceCollection
        Returns:
        number of elements as int.
      • isFilesystemOnly

        public boolean isFilesystemOnly()
        Fulfill the ResourceCollection contract.
        Specified by:
        isFilesystemOnly in interface ResourceCollection
        Returns:
        whether this is a filesystem-only resource collection.
      • dieOnCircularReference

        protected void dieOnCircularReference​(java.util.Stack<java.lang.Object> stk,
                                              Project p)
                                       throws BuildException
        Overrides the version of DataType to recurse on all DataType child elements that may have been added.
        Overrides:
        dieOnCircularReference in class DataType
        Parameters:
        stk - the stack of data types to use (recursively).
        p - the project to use to dereference the references.
        Throws:
        BuildException - on error.
      • getResourceCollections

        public final java.util.List<ResourceCollection> getResourceCollections()
        Get the nested ResourceCollections.
        Returns:
        List.
      • getCollection

        protected abstract java.util.Collection<Resource> getCollection()
        Template method for subclasses to return a Collection object of Resources.
        Returns:
        Collection.
      • clone

        public java.lang.Object clone()
        Implement clone. The set of nested resource collections is shallowly cloned.
        Overrides:
        clone in class DataType
        Returns:
        a cloned instance.
      • toString

        public java.lang.String toString()
        Format this BaseResourceCollectionContainer as a String.
        Overrides:
        toString in class DataType
        Returns:
        a descriptive String.