Class ArchiveResource
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Resource
org.apache.tools.ant.types.resources.ArchiveResource
- All Implemented Interfaces:
- Cloneable,- Comparable<Resource>,- Iterable<Resource>,- ResourceCollection
- Direct Known Subclasses:
- TarResource,- ZipResource
A Resource representation of an entry inside an archive.
- Since:
- Ant 1.7
- 
Field SummaryFields inherited from class org.apache.tools.ant.types.ResourceMAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZEFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedDefault constructor.protectedConstruct a ArchiveResource representing the specified entry in the specified archive.protectedArchiveResource(File a, boolean withEntry) Construct a ArchiveResource representing the specified entry in the specified archive.protectedArchiveResource(Resource a, boolean withEntry) Construct a ArchiveResource representing the specified entry in the specified archive.
- 
Method SummaryModifier and TypeMethodDescriptionvoidSets the archive that holds this as a single element Resource collection.protected final voidValidate settings and ensure that the represented "archive entry" has been established.intCompare this ArchiveResource to another Resource.protected voiddieOnCircularReference(Stack<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).booleanCompare another Object to this ArchiveResource for equality.protected abstract voidFetch information from the named entry inside the archive.Get the archive that holds this Resource.longGet the last modified date of this Resource.intgetMode()Get the file or dir mode for this Resource.protected ArchiveResourcegetRef()Perform the check for circular references and return the referenced Resource.longgetSize()Get the size of this Resource.inthashCode()Get the hash code for this Resource.booleanLearn whether this Resource represents a directory.booleanisExists()Find out whether this Resource represents an existing Resource.voidsetArchive(File a) Set the archive that holds this Resource.voidsetMode(int mode) Sets the file or dir mode for this resource.voidOverrides the super version.toString()Format this Resource as a String.Methods inherited from class org.apache.tools.ant.types.Resourceas, asOptional, clone, getInputStream, getMagicNumber, getName, getOutputStream, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongStringMethods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectfinalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.IterableforEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
- 
Constructor Details- 
ArchiveResourceprotected ArchiveResource()Default constructor.
- 
ArchiveResourceConstruct a ArchiveResource representing the specified entry in the specified archive.- Parameters:
- a- the archive as File.
 
- 
ArchiveResourceConstruct a ArchiveResource representing the specified entry in the specified archive.- Parameters:
- a- the archive as File.
- withEntry- if the entry has been specified.
 
- 
ArchiveResourceConstruct a ArchiveResource representing the specified entry in the specified archive.- Parameters:
- a- the archive as Resource.
- withEntry- if the entry has been specified.
 
 
- 
- 
Method Details- 
setArchiveSet the archive that holds this Resource.- Parameters:
- a- the archive as a File.
 
- 
setModepublic void setMode(int mode) Sets the file or dir mode for this resource.- Parameters:
- mode- integer representation of Unix permission mask.
 
- 
addConfiguredSets the archive that holds this as a single element Resource collection.- Parameters:
- a- the archive as a single element Resource collection.
 
- 
getArchiveGet the archive that holds this Resource.- Returns:
- the archive as a Resource.
 
- 
getLastModifiedpublic long getLastModified()Get the last modified date of this Resource.- Overrides:
- getLastModifiedin class- Resource
- Returns:
- the last modification date.
 
- 
getSize
- 
isDirectorypublic boolean isDirectory()Learn whether this Resource represents a directory.- Overrides:
- isDirectoryin class- Resource
- Returns:
- boolean flag indicating whether the entry is a directory.
 
- 
isExists
- 
getModepublic int getMode()Get the file or dir mode for this Resource.- Returns:
- integer representation of Unix permission mask.
 
- 
setRefid
- 
compareToCompare this ArchiveResource to another Resource.- Specified by:
- compareToin interface- Comparable<Resource>
- Overrides:
- compareToin 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
- 
hashCode
- 
toString
- 
checkEntryValidate settings and ensure that the represented "archive entry" has been established.- Throws:
- BuildException
 
- 
fetchEntryprotected abstract void fetchEntry()Fetch information from the named entry inside the archive.
- 
dieOnCircularReferenceCheck 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.checkedis true and set it to true on exit.- Overrides:
- dieOnCircularReferencein class- DataType
- Parameters:
- stk- the stack of references to check.
- p- the project to use to dereference the references.
 
- 
getRefDescription copied from class:ResourcePerform the check for circular references and return the referenced Resource.
 
-