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
-
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedResourceDecorator()no arg constructorprotectedResourceDecorator(ResourceCollection other)Constructor with another resource to wrap.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddConfigured(ResourceCollection a)Sets the resource to wrap using a single-element collection.<T> Tas(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.intcompareTo(Resource other)Delegates to a comparison of names.protected voiddieOnCircularReference(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.InputStreamgetInputStream()Get an InputStream for the Resource.longgetLastModified()Tells the modification time in milliseconds since 01.01.1970 .java.lang.StringgetName()Get the name of the resource.java.io.OutputStreamgetOutputStream()Get an OutputStream for the Resource.protected ResourcegetResource()De-references refids if any, ensures a wrapped resource has been specified.longgetSize()Get the size of this Resource.inthashCode()Get the hash code for this Resource.booleanisDirectory()Tells if the resource is a directory.booleanisExists()The exists attribute tells whether a file exists.booleanisFilesystemOnly()Fulfill the ResourceCollection contract.voidsetDirectory(boolean directory)Override setDirectory.voidsetExists(boolean exists)Set the exists attribute.voidsetLastModified(long lastmodified)Override setLastModified.voidsetName(java.lang.String name)Overridden, not allowed to set the name of the resource.voidsetRefid(Reference r)Overrides the base version.voidsetSize(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
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.tools.ant.types.ResourceCollection
isEmpty, stream
-
-
-
-
Constructor Detail
-
ResourceDecorator
protected ResourceDecorator()
no arg constructor
-
ResourceDecorator
protected ResourceDecorator(ResourceCollection other)
Constructor with another resource to wrap.- Parameters:
other- the resource to wrap.
-
-
Method Detail
-
addConfigured
public final void addConfigured(ResourceCollection a)
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:
getLastModifiedin 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:
isDirectoryin 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:
getInputStreamin 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:
getOutputStreamin 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:
isFilesystemOnlyin interfaceResourceCollection- Overrides:
isFilesystemOnlyin classResource- Returns:
- whether this Resource is a FileProvider.
-
setRefid
public void setRefid(Reference r)
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
public int compareTo(Resource other)
Delegates to a comparison of names.
-
hashCode
public int hashCode()
Get the hash code for this Resource.
-
getResource
protected final 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.checkedis true and set it to true on exit.- Overrides:
dieOnCircularReferencein classDataType- Parameters:
stack- the stack of references to check.project- the project to use to dereference the references.- Throws:
BuildException- on error.
-
setName
public void setName(java.lang.String name) throws BuildExceptionOverridden, not allowed to set the name of the resource.- Overrides:
setNamein classResource- Parameters:
name- not used.- Throws:
BuildException- always.
-
setExists
public void setExists(boolean exists)
Set the exists attribute.
-
setLastModified
public void setLastModified(long lastmodified) throws BuildExceptionOverride setLastModified.- Overrides:
setLastModifiedin classResource- Parameters:
lastmodified- not used.- Throws:
BuildException- always.
-
setDirectory
public void setDirectory(boolean directory) throws BuildExceptionOverride setDirectory.- Overrides:
setDirectoryin classResource- Parameters:
directory- not used.- Throws:
BuildException- always.
-
setSize
public void setSize(long size) throws BuildExceptionOverride setSize.- Overrides:
setSizein classResource- Parameters:
size- not used.- Throws:
BuildException- always.
-
-