Class FileResource
- 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.FileResource
 
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- java.lang.Comparable<Resource>,- java.lang.Iterable<Resource>,- ResourceCollection,- ResourceFactory,- Appendable,- FileProvider,- Touchable
 
 public class FileResource extends Resource implements Touchable, FileProvider, ResourceFactory, Appendable A Resource representation of a File.- 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 Constructor Description FileResource()Default constructor.FileResource(java.io.File f)Construct a new FileResource from a File.FileResource(java.io.File b, java.lang.String name)Construct a new FileResource using the specified basedir and relative name.FileResource(Project p, java.io.File f)Create a new FileResource.FileResource(Project p, java.lang.String s)Constructor for Ant attribute introspection.
 - 
Method SummaryModifier and Type Method Description intcompareTo(Resource another)Compare this FileResource to another Resource.booleanequals(java.lang.Object another)Compare another Object to this FileResource for equality.java.io.OutputStreamgetAppendOutputStream()Get an appending OutputStream.java.io.FilegetBaseDir()Return the basedir to which the name is relative.java.io.FilegetFile()Get the file represented by this FileResource.java.io.InputStreamgetInputStream()Return an InputStream for reading the contents of this Resource.longgetLastModified()Get the modification time in milliseconds since 01.01.1970 .java.lang.StringgetName()Get the name of this FileResource.protected java.io.FilegetNotNullFile()Get the file represented by this FileResource, ensuring it is not null.java.io.OutputStreamgetOutputStream()Get an OutputStream for the Resource.protected FileResourcegetRef()Perform the check for circular references and return the referenced Resource.ResourcegetResource(java.lang.String path)Create a new resource that matches a relative or absolute path.longgetSize()Get the size of this Resource.inthashCode()Get the hash code for this Resource.booleanisDirectory()Learn whether the resource is a directory.booleanisExists()Learn whether this file exists.booleanisFilesystemOnly()Fulfill the ResourceCollection contract.voidsetBaseDir(java.io.File b)Set the basedir for this FileResource.voidsetFile(java.io.File f)Set the File for this FileResource.voidsetRefid(Reference r)Overrides the super version.java.lang.StringtoString()Get the string representation of this Resource.voidtouch(long modTime)Implement the Touchable interface.- 
Methods inherited from class org.apache.tools.ant.types.Resourceas, asOptional, clone, getMagicNumber, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString
 - 
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, 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- 
FileResourcepublic FileResource() Default constructor.
 - 
FileResourcepublic FileResource(java.io.File b, java.lang.String name)Construct a new FileResource using the specified basedir and relative name.- Parameters:
- b- the basedir as File.
- name- the relative filename.
 
 - 
FileResourcepublic FileResource(java.io.File f) Construct a new FileResource from a File.- Parameters:
- f- the File represented.
 
 - 
FileResourcepublic FileResource(Project p, java.io.File f) Create a new FileResource.- Parameters:
- p- Project
- f- File represented
- Since:
- Ant 1.8
 
 - 
FileResourcepublic FileResource(Project p, java.lang.String s) Constructor for Ant attribute introspection.- Parameters:
- p- the Project against which to resolve- s.
- s- the absolute or Project-relative filename as a String.
- See Also:
- IntrospectionHelper
 
 
- 
 - 
Method Detail- 
setFilepublic void setFile(java.io.File f) Set the File for this FileResource.- Parameters:
- f- the File to be represented.
 
 - 
getFilepublic java.io.File getFile() Get the file represented by this FileResource.- Specified by:
- getFilein interface- FileProvider
- Returns:
- the File.
 
 - 
setBaseDirpublic void setBaseDir(java.io.File b) Set the basedir for this FileResource.- Parameters:
- b- the basedir as File.
 
 - 
getBaseDirpublic java.io.File getBaseDir() Return the basedir to which the name is relative.- Returns:
- the basedir as File.
 
 - 
setRefidpublic void setRefid(Reference r) Overrides the super version.
 - 
getNamepublic java.lang.String getName() Get the name of this FileResource. If the basedir is set, the name will be relative to that. Otherwise the basename only will be returned.
 - 
isExistspublic boolean isExists() Learn whether this file exists.
 - 
getLastModifiedpublic long getLastModified() Get the modification time in milliseconds since 01.01.1970 .- Overrides:
- getLastModifiedin class- Resource
- Returns:
- 0 if the resource does not exist.
 
 - 
isDirectorypublic boolean isDirectory() Learn whether the resource is a directory.- Overrides:
- isDirectoryin class- Resource
- Returns:
- boolean flag indicating if the resource is a directory.
 
 - 
getSizepublic long getSize() Get the size of this Resource.
 - 
getInputStreampublic java.io.InputStream getInputStream() throws java.io.IOExceptionReturn an InputStream for reading the contents of this Resource.- Overrides:
- getInputStreamin class- Resource
- Returns:
- an InputStream object.
- Throws:
- java.io.IOException- if an error occurs.
 
 - 
getOutputStreampublic java.io.OutputStream getOutputStream() throws java.io.IOExceptionGet an OutputStream for the Resource.- Overrides:
- getOutputStreamin class- Resource
- Returns:
- an OutputStream to which content can be written.
- Throws:
- java.io.IOException- if unable to provide the content of this Resource as a stream.
- java.lang.UnsupportedOperationException- if OutputStreams are not supported for this Resource type.
 
 - 
getAppendOutputStreampublic java.io.OutputStream getAppendOutputStream() throws java.io.IOExceptionGet an appending OutputStream.- Specified by:
- getAppendOutputStreamin interface- Appendable
- Returns:
- OutputStream
- Throws:
- java.io.IOException- if anything goes wrong
 
 - 
compareTopublic int compareTo(Resource another) Compare this FileResource 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 FileResource is less than, equal to, or greater than the specified Resource.
 
 - 
equalspublic boolean equals(java.lang.Object another) Compare another Object to this FileResource for equality.
 - 
hashCodepublic int hashCode() Get the hash code for this Resource.
 - 
toStringpublic java.lang.String toString() Get the string representation of this Resource.
 - 
isFilesystemOnlypublic boolean isFilesystemOnly() Fulfill the ResourceCollection contract.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Overrides:
- isFilesystemOnlyin class- Resource
- Returns:
- whether this Resource is a FileResource.
 
 - 
touchpublic void touch(long modTime) Implement the Touchable interface.
 - 
getNotNullFileprotected java.io.File getNotNullFile() Get the file represented by this FileResource, ensuring it is not null.- Returns:
- the not-null File.
- Throws:
- BuildException- if file is null.
 
 - 
getResourcepublic Resource getResource(java.lang.String path) Create a new resource that matches a relative or absolute path. If the current instance has a compatible baseDir attribute, it is copied.- Specified by:
- getResourcein interface- ResourceFactory
- Parameters:
- path- relative/absolute path to a resource
- Returns:
- a new resource of type FileResource
- Throws:
- BuildException- if desired
- Since:
- Ant1.8
 
 - 
getRefprotected FileResource getRef() Description copied from class:ResourcePerform the check for circular references and return the referenced Resource.
 
- 
 
-