Package org.apache.tools.ant.types
Class Resource
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Resource
- All Implemented Interfaces:
- Cloneable,- Comparable<Resource>,- Iterable<Resource>,- ResourceCollection
- Direct Known Subclasses:
- AbstractClasspathResource,- ArchiveResource,- FileResource,- LogOutputResource,- PropertyResource,- ResourceDecorator,- StringResource,- URLResource
Describes a "File-like" resource (File, ZipEntry, etc.).
 
This class is meant to be used by classes needing to record path and date/time information about a file, a zip entry or some similar resource (URL, archive in a version control repository, ...).
- Since:
- Ant 1.5.2
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected static final intMagic numberstatic final longConstant unknown datetime for getLastModifiedstatic final longConstant unknown sizeFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructorsConstructorDescriptionResource()Default constructor.Only sets the name.Sets the name, lastmodified flag, and exists flag.Sets the name, lastmodified flag, exists flag, and directory flag.Sets the name, lastmodified flag, exists flag, directory flag, and size.
- 
Method SummaryModifier and TypeMethodDescription<T> TReturns a view of this resource that implements the interface given as the argument or null if there is no such view.<T> Optional<T>asOptional(Class<T> clazz) clone()Clone this Resource.intDelegates to a comparison of names.booleanImplement basic Resource equality.Get an InputStream for the Resource.longTells the modification time in milliseconds since 01.01.1970 (the "epoch").protected static intgetMagicNumber(byte[] seed) Create a "magic number" for use in hashCode calculations.getName()Name attribute will contain the path of a file relative to the root directory of its fileset or the recorded path of a zip entry.Get an OutputStream for the Resource.protected ResourcegetRef()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.booleanTells if the resource is a directory.booleanisExists()The exists attribute tells whether a resource exists.booleanFulfill the ResourceCollection contract.iterator()Fulfill the ResourceCollection contract.voidsetDirectory(boolean directory) Set the directory attribute.voidsetExists(boolean exists) Set the exists attribute.voidsetLastModified(long lastmodified) Set the last modification attribute.voidSet the name of this Resource.voidOverrides the base version.voidsetSize(long size) Set the size of this Resource.intsize()Fulfill the ResourceCollection contract.final StringGet a long String representation of this Resource.toString()Get the string representation of this Resource.Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, 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
- 
Field Details- 
UNKNOWN_SIZEpublic static final long UNKNOWN_SIZEConstant unknown size- See Also:
 
- 
UNKNOWN_DATETIMEpublic static final long UNKNOWN_DATETIMEConstant unknown datetime for getLastModified- See Also:
 
- 
MAGICprotected static final int MAGICMagic number
 
- 
- 
Constructor Details- 
Resourcepublic Resource()Default constructor.
- 
ResourceOnly sets the name.This is a dummy, used for not existing resources. - Parameters:
- name- relative path of the resource. Expects "/" to be used as the directory separator.
 
- 
ResourceSets the name, lastmodified flag, and exists flag.- Parameters:
- name- relative path of the resource. Expects "/" to be used as the directory separator.
- exists- if true, this resource exists.
- lastmodified- the last modification time of this resource.
 
- 
ResourceSets the name, lastmodified flag, exists flag, and directory flag.- Parameters:
- name- relative path of the resource. Expects "/" to be used as the directory separator.
- exists- if true the resource exists
- lastmodified- the last modification time of the resource
- directory- if true, this resource is a directory
 
- 
ResourceSets the name, lastmodified flag, exists flag, directory flag, and size.- Parameters:
- name- relative path of the resource. Expects "/" to be used as the directory separator.
- exists- if true the resource exists
- lastmodified- the last modification time of the resource
- directory- if true, this resource is a directory
- size- the size of this resource.
 
 
- 
- 
Method Details- 
getMagicNumberprotected static int getMagicNumber(byte[] seed) Create a "magic number" for use in hashCode calculations.- Parameters:
- seed- byte[] to seed with.
- Returns:
- a magic number as int.
 
- 
getNameName attribute will contain the path of a file relative to the root directory of its fileset or the recorded path of a zip entry.example for a file with fullpath /var/opt/adm/resource.txt in a file set with root dir /var/opt it will be adm/resource.txt. "/" will be used as the directory separator. - Returns:
- the name of this resource.
 
- 
setNameSet the name of this Resource.- Parameters:
- name- relative path of the resource. Expects "/" to be used as the directory separator.
 
- 
isExistspublic boolean isExists()The exists attribute tells whether a resource exists.- Returns:
- true if this resource exists.
 
- 
setExistspublic void setExists(boolean exists) Set the exists attribute.- Parameters:
- exists- if true, this resource exists.
 
- 
getLastModifiedpublic long getLastModified()Tells the modification time in milliseconds since 01.01.1970 (the "epoch").- Returns:
- the modification time, if that is meaningful
            (e.g. for a file resource which exists);
         0 if the resource does not exist, to mirror the behavior
         of File.lastModified(); or 0 if the notion of modification time is meaningless for this class of resource (e.g. an inline string)
 
- 
setLastModifiedpublic void setLastModified(long lastmodified) Set the last modification attribute.- Parameters:
- lastmodified- the modification time in milliseconds since 01.01.1970.
 
- 
isDirectorypublic boolean isDirectory()Tells if the resource is a directory.- Returns:
- boolean flag indicating if the resource is a directory.
 
- 
setDirectorypublic void setDirectory(boolean directory) Set the directory attribute.- Parameters:
- directory- if true, this resource is a directory.
 
- 
setSizepublic void setSize(long size) Set the size of this Resource.- Parameters:
- size- the size, as a long.
- Since:
- Ant 1.6.3
 
- 
getSizepublic long getSize()Get the size of this Resource.- Returns:
- the size, as a long, 0 if the Resource does not exist (for compatibility with java.io.File), or UNKNOWN_SIZE if not known.
- Since:
- Ant 1.6.3
 
- 
cloneClone this Resource.
- 
compareToDelegates to a comparison of names.- Specified by:
- compareToin interface- Comparable<Resource>
- Parameters:
- other- the object to compare to.
- Returns:
- a negative integer, zero, or a positive integer as this Resource is less than, equal to, or greater than the specified Resource.
- Since:
- Ant 1.6
 
- 
equalsImplement basic Resource equality.
- 
hashCodepublic int hashCode()Get the hash code for this Resource.
- 
getInputStreamGet an InputStream for the Resource.- Returns:
- an InputStream containing this Resource's content.
- Throws:
- IOException- if unable to provide the content of this Resource as a stream.
- UnsupportedOperationException- if InputStreams are not supported for this Resource type.
- Since:
- Ant 1.7
 
- 
getOutputStreamGet an OutputStream for the Resource.- Returns:
- an OutputStream to which content can be written.
- Throws:
- IOException- if unable to provide the content of this Resource as a stream.
- UnsupportedOperationException- if OutputStreams are not supported for this Resource type.
- Since:
- Ant 1.7
 
- 
iteratorFulfill the ResourceCollection contract.
- 
sizepublic int size()Fulfill the ResourceCollection contract.- Specified by:
- sizein interface- ResourceCollection
- Returns:
- the size of this ResourceCollection.
- Since:
- Ant 1.7
 
- 
isFilesystemOnlypublic boolean isFilesystemOnly()Fulfill the ResourceCollection contract.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Returns:
- whether this Resource is a FileProvider.
- Since:
- Ant 1.7
 
- 
toStringGet the string representation of this Resource.
- 
toLongStringGet a long String representation of this Resource. This typically should be the value oftoString()prefixed by a type description.- Returns:
- this Resource formatted as a long String.
- Since:
- Ant 1.7
 
- 
setRefidOverrides the base version.
- 
asReturns a view of this resource that implements the interface given as the argument or null if there is no such view.This allows extension interfaces to be added to resources without growing the number of permutations of interfaces decorators/adapters need to implement. This implementation of the method will return the current instance itself if it can be assigned to the given class. - Type Parameters:
- T- desired type
- Parameters:
- clazz- a class
- Returns:
- resource of a desired type
- Since:
- Ant 1.8.0
 
- 
asOptional- Type Parameters:
- T- desired type
- Parameters:
- clazz- a class
- Returns:
- Optionalresource of a desired type
- Since:
- Ant 1.10.2
 
- 
getRefPerform the check for circular references and return the referenced Resource.- Returns:
- Resource.
 
 
-