Class ArchiveResource

    • Constructor Detail

      • ArchiveResource

        protected ArchiveResource()
        Default constructor.
      • ArchiveResource

        protected ArchiveResource​(java.io.File a)
        Construct a ArchiveResource representing the specified entry in the specified archive.
        Parameters:
        a - the archive as File.
      • ArchiveResource

        protected ArchiveResource​(java.io.File a,
                                  boolean withEntry)
        Construct a ArchiveResource representing the specified entry in the specified archive.
        Parameters:
        a - the archive as File.
        withEntry - if the entry has been specified.
      • ArchiveResource

        protected ArchiveResource​(Resource a,
                                  boolean withEntry)
        Construct a ArchiveResource representing the specified entry in the specified archive.
        Parameters:
        a - the archive as Resource.
        withEntry - if the entry has been specified.
    • Method Detail

      • setArchive

        public void setArchive​(java.io.File a)
        Set the archive that holds this Resource.
        Parameters:
        a - the archive as a File.
      • setMode

        public void setMode​(int mode)
        Sets the file or dir mode for this resource.
        Parameters:
        mode - integer representation of Unix permission mask.
      • addConfigured

        public void addConfigured​(ResourceCollection a)
        Sets the archive that holds this as a single element Resource collection.
        Parameters:
        a - the archive as a single element Resource collection.
      • getArchive

        public Resource getArchive()
        Get the archive that holds this Resource.
        Returns:
        the archive as a Resource.
      • getLastModified

        public long getLastModified()
        Get the last modified date of this Resource.
        Overrides:
        getLastModified in class Resource
        Returns:
        the last modification date.
      • getSize

        public long getSize()
        Get the size of this Resource.
        Overrides:
        getSize in class Resource
        Returns:
        the long size of this Resource.
      • isDirectory

        public boolean isDirectory()
        Learn whether this Resource represents a directory.
        Overrides:
        isDirectory in class Resource
        Returns:
        boolean flag indicating whether the entry is a directory.
      • isExists

        public boolean isExists()
        Find out whether this Resource represents an existing Resource.
        Overrides:
        isExists in class Resource
        Returns:
        boolean existence flag.
      • getMode

        public int getMode()
        Get the file or dir mode for this Resource.
        Returns:
        integer representation of Unix permission mask.
      • setRefid

        public void setRefid​(Reference r)
        Overrides the super version.
        Overrides:
        setRefid in class Resource
        Parameters:
        r - the Reference to set.
      • compareTo

        public int compareTo​(Resource another)
        Compare this ArchiveResource to another Resource.
        Specified by:
        compareTo in interface java.lang.Comparable<Resource>
        Overrides:
        compareTo in class Resource
        Parameters:
        another - the other Resource against which to compare.
        Returns:
        a negative integer, zero, or a positive integer as this Resource is less than, equal to, or greater than the specified Resource.
      • equals

        public boolean equals​(java.lang.Object another)
        Compare another Object to this ArchiveResource for equality.
        Overrides:
        equals in class Resource
        Parameters:
        another - the other Object to compare.
        Returns:
        true if another is a Resource representing the same entry in the same archive.
      • hashCode

        public int hashCode()
        Get the hash code for this Resource.
        Overrides:
        hashCode in class Resource
        Returns:
        hash code as int.
      • toString

        public java.lang.String toString()
        Format this Resource as a String.
        Overrides:
        toString in class Resource
        Returns:
        String representation of this Resource.
      • checkEntry

        protected final void checkEntry()
                                 throws BuildException
        Validate settings and ensure that the represented "archive entry" has been established.
        Throws:
        BuildException
      • fetchEntry

        protected abstract void fetchEntry()
        Fetch information from the named entry inside the archive.
      • dieOnCircularReference

        protected void dieOnCircularReference​(java.util.Stack<java.lang.Object> stk,
                                              Project p)
        Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

        If one is included, throw a BuildException created by circularReference.

        This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.

        The general contract of this method is that it shouldn't do anything if DataType.checked is true and set it to true on exit.

        Overrides:
        dieOnCircularReference in class DataType
        Parameters:
        stk - the stack of references to check.
        p - the project to use to dereference the references.
      • getRef

        protected ArchiveResource getRef()
        Description copied from class: Resource
        Perform the check for circular references and return the referenced Resource.
        Overrides:
        getRef in class Resource
        Returns:
        Resource.