Class ResourceDecorator
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.ResourceDecorator
- All Implemented Interfaces:
java.lang.Cloneable
,java.lang.Comparable<Resource>
,java.lang.Iterable<Resource>
,ResourceCollection
- Direct Known Subclasses:
ContentTransformingResource
,MappedResource
public abstract class ResourceDecorator extends Resource
Abstract class that delegates all reading methods of Resource to
its wrapped resource and deals with reference handling.
Overwrites all setters to throw exceptions.
- Since:
- Ant 1.8.0
-
Field Summary
Fields inherited from class org.apache.tools.ant.types.Resource
MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
-
Constructor Summary
Constructors Modifier Constructor Description protected
ResourceDecorator()
no arg constructorprotected
ResourceDecorator(ResourceCollection other)
Constructor with another resource to wrap. -
Method Summary
Modifier and Type Method Description void
addConfigured(ResourceCollection a)
Sets the resource to wrap using a single-element collection.<T> T
as(java.lang.Class<T> clazz)
Returns a view of this resource that implements the interface given as the argument or null if there is no such view.int
compareTo(Resource other)
Delegates to a comparison of names.protected void
dieOnCircularReference(java.util.Stack<java.lang.Object> stack, Project project)
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).java.io.InputStream
getInputStream()
Get an InputStream for the Resource.long
getLastModified()
Tells the modification time in milliseconds since 01.01.1970 .java.lang.String
getName()
Get the name of the resource.java.io.OutputStream
getOutputStream()
Get an OutputStream for the Resource.protected Resource
getResource()
De-references refids if any, ensures a wrapped resource has been specified.long
getSize()
Get the size of this Resource.int
hashCode()
Get the hash code for this Resource.boolean
isDirectory()
Tells if the resource is a directory.boolean
isExists()
The exists attribute tells whether a file exists.boolean
isFilesystemOnly()
Fulfill the ResourceCollection contract.void
setDirectory(boolean directory)
Override setDirectory.void
setExists(boolean exists)
Set the exists attribute.void
setLastModified(long lastmodified)
Override setLastModified.void
setName(java.lang.String name)
Overridden, not allowed to set the name of the resource.void
setRefid(Reference r)
Overrides the base version.void
setSize(long size)
Override setSize.Methods inherited from class org.apache.tools.ant.types.Resource
asOptional, clone, equals, getMagicNumber, getRef, iterator, size, toLongString, toString
Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, 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.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Constructor Details
-
ResourceDecorator
protected ResourceDecorator()no arg constructor -
ResourceDecorator
Constructor with another resource to wrap.- Parameters:
other
- the resource to wrap.
-
-
Method Details
-
addConfigured
Sets the resource to wrap using a single-element collection.- Parameters:
a
- the resource to wrap as a single element Resource collection.
-
getName
public java.lang.String getName()Get the name of the resource. -
isExists
public boolean isExists()The exists attribute tells whether a file exists. -
getLastModified
public long getLastModified()Tells the modification time in milliseconds since 01.01.1970 .- Overrides:
getLastModified
in classResource
- Returns:
- 0 if the resource does not exist to mirror the behavior
of
File
.
-
isDirectory
public boolean isDirectory()Tells if the resource is a directory.- Overrides:
isDirectory
in classResource
- Returns:
- boolean flag indicating if the resource is a directory.
-
getSize
public long getSize()Get the size of this Resource. -
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOExceptionGet an InputStream for the Resource.- Overrides:
getInputStream
in classResource
- Returns:
- an InputStream containing this Resource's content.
- Throws:
java.io.IOException
- if unable to provide the content of this Resource as a stream.java.lang.UnsupportedOperationException
- if InputStreams are not supported for this Resource type.
-
getOutputStream
public java.io.OutputStream getOutputStream() throws java.io.IOExceptionGet an OutputStream for the Resource.- Overrides:
getOutputStream
in classResource
- 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.
-
isFilesystemOnly
public boolean isFilesystemOnly()Fulfill the ResourceCollection contract.- Specified by:
isFilesystemOnly
in interfaceResourceCollection
- Overrides:
isFilesystemOnly
in classResource
- Returns:
- whether this Resource is a FileProvider.
-
setRefid
Overrides the base version. -
as
public <T> T as(java.lang.Class<T> clazz)Returns 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.
-
compareTo
Delegates to a comparison of names. -
hashCode
public int hashCode()Get the hash code for this Resource. -
getResource
De-references refids if any, ensures a wrapped resource has been specified.- Returns:
- Resource
-
dieOnCircularReference
protected void dieOnCircularReference(java.util.Stack<java.lang.Object> stack, Project project) throws BuildExceptionCheck 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 classDataType
- Parameters:
stack
- the stack of references to check.project
- the project to use to dereference the references.- Throws:
BuildException
- on error.
-
setName
Overridden, not allowed to set the name of the resource.- Overrides:
setName
in classResource
- Parameters:
name
- not used.- Throws:
BuildException
- always.
-
setExists
public void setExists(boolean exists)Set the exists attribute. -
setLastModified
Override setLastModified.- Overrides:
setLastModified
in classResource
- Parameters:
lastmodified
- not used.- Throws:
BuildException
- always.
-
setDirectory
Override setDirectory.- Overrides:
setDirectory
in classResource
- Parameters:
directory
- not used.- Throws:
BuildException
- always.
-
setSize
Override setSize.- Overrides:
setSize
in classResource
- Parameters:
size
- not used.- Throws:
BuildException
- always.
-