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:
- java.lang.Cloneable,- java.lang.Comparable<Resource>,- java.lang.Iterable<Resource>,- ResourceCollection
 - Direct Known Subclasses:
- TarResource,- ZipResource
 
 public abstract class ArchiveResource extends Resource A Resource representation of an entry inside an archive.- Since:
- Ant 1.7
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.tools.ant.types.ResourceMAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
 - 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Modifier Constructor Description protectedArchiveResource()Default constructor.protectedArchiveResource(java.io.File a)Construct a ArchiveResource representing the specified entry in the specified archive.protectedArchiveResource(java.io.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 Type Method Description voidaddConfigured(ResourceCollection a)Sets the archive that holds this as a single element Resource collection.protected voidcheckEntry()Validate settings and ensure that the represented "archive entry" has been established.intcompareTo(Resource another)Compare this ArchiveResource to another Resource.protected voiddieOnCircularReference(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).booleanequals(java.lang.Object another)Compare another Object to this ArchiveResource for equality.protected abstract voidfetchEntry()Fetch information from the named entry inside the archive.ResourcegetArchive()Get the archive that holds this Resource.longgetLastModified()Get 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.booleanisDirectory()Learn whether this Resource represents a directory.booleanisExists()Find out whether this Resource represents an existing Resource.voidsetArchive(java.io.File a)Set the archive that holds this Resource.voidsetMode(int mode)Sets the file or dir mode for this resource.voidsetRefid(Reference r)Overrides the super version.java.lang.StringtoString()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, toLongString
 - 
Methods 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, tooManyAttributes
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectfinalize, getClass, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
 
- 
 
- 
- 
- 
Constructor Detail- 
ArchiveResourceprotected ArchiveResource() Default constructor.
 - 
ArchiveResourceprotected ArchiveResource(java.io.File a) Construct a ArchiveResource representing the specified entry in the specified archive.- Parameters:
- a- the archive as File.
 
 - 
ArchiveResourceprotected 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.
 
 - 
ArchiveResourceprotected 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- 
setArchivepublic void setArchive(java.io.File a) Set 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.
 
 - 
addConfiguredpublic 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.
 
 - 
getArchivepublic Resource getArchive() Get 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.
 
 - 
getSizepublic long getSize() Get the size of this Resource.
 - 
isDirectorypublic boolean isDirectory() Learn whether this Resource represents a directory.- Overrides:
- isDirectoryin class- Resource
- Returns:
- boolean flag indicating whether the entry is a directory.
 
 - 
isExistspublic boolean isExists() Find out whether this Resource represents an existing Resource.
 - 
getModepublic int getMode() Get the file or dir mode for this Resource.- Returns:
- integer representation of Unix permission mask.
 
 - 
setRefidpublic void setRefid(Reference r) Overrides the super version.
 - 
compareTopublic int compareTo(Resource another) Compare this ArchiveResource to another Resource.- Specified by:
- compareToin interface- java.lang.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.
 
 - 
equalspublic boolean equals(java.lang.Object another) Compare another Object to this ArchiveResource for equality.
 - 
hashCodepublic int hashCode() Get the hash code for this Resource.
 - 
toStringpublic java.lang.String toString() Format this Resource as a String.
 - 
checkEntryprotected final void checkEntry() throws BuildExceptionValidate 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.
 - 
dieOnCircularReferenceprotected 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.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.
 
 - 
getRefprotected ArchiveResource getRef() Description copied from class:ResourcePerform the check for circular references and return the referenced Resource.
 
- 
 
-