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:
- Cloneable,- Comparable<Resource>,- Iterable<Resource>,- ResourceCollection
- Direct Known Subclasses:
- ContentTransformingResource,- MappedResource
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 SummaryFields inherited from class org.apache.tools.ant.types.ResourceMAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZEFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedno arg constructorprotectedConstructor with another resource to wrap.
- 
Method SummaryModifier and TypeMethodDescriptionfinal voidSets the resource to wrap using a single-element collection.<T> TReturns a view of this resource that implements the interface given as the argument or null if there is no such view.intDelegates to a comparison of names.protected voiddieOnCircularReference(Stack<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).Get an InputStream for the Resource.longTells the modification time in milliseconds since 01.01.1970 .getName()Get the name of the resource.Get an OutputStream for the Resource.protected final ResourceDe-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.booleanTells if the resource is a directory.booleanisExists()The exists attribute tells whether a file exists.booleanFulfill the ResourceCollection contract.voidsetDirectory(boolean directory) Override setDirectory.voidsetExists(boolean exists) Set the exists attribute.voidsetLastModified(long lastmodified) Override setLastModified.voidOverridden, not allowed to set the name of the resource.voidOverrides the base version.voidsetSize(long size) Override setSize.Methods inherited from class org.apache.tools.ant.types.ResourceasOptional, clone, equals, getMagicNumber, getRef, iterator, size, toLongString, toStringMethods 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, 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
- 
Constructor Details- 
ResourceDecoratorprotected ResourceDecorator()no arg constructor
- 
ResourceDecoratorConstructor with another resource to wrap.- Parameters:
- other- the resource to wrap.
 
 
- 
- 
Method Details- 
addConfiguredSets the resource to wrap using a single-element collection.- Parameters:
- a- the resource to wrap as a single element Resource collection.
 
- 
getNameGet the name of the resource.
- 
isExistspublic boolean isExists()The exists attribute tells whether a file exists.
- 
getLastModifiedpublic long getLastModified()Tells the modification time in milliseconds since 01.01.1970 .- Overrides:
- getLastModifiedin class- Resource
- Returns:
- 0 if the resource does not exist to mirror the behavior
 of File.
 
- 
isDirectorypublic boolean isDirectory()Tells if 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.
- 
getInputStreamGet an InputStream for the Resource.- Overrides:
- getInputStreamin class- 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.
 
- 
getOutputStreamGet an OutputStream for the Resource.- Overrides:
- getOutputStreamin class- 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.
 
- 
isFilesystemOnlypublic boolean isFilesystemOnly()Fulfill the ResourceCollection contract.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Overrides:
- isFilesystemOnlyin class- Resource
- Returns:
- whether this Resource is a FileProvider.
 
- 
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. 
- 
compareToDelegates to a comparison of names.- Specified by:
- compareToin interface- Comparable<Resource>
- Overrides:
- compareToin class- 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.
 
- 
hashCodepublic int hashCode()Get the hash code for this Resource.
- 
getResourceDe-references refids if any, ensures a wrapped resource has been specified.- Returns:
- Resource
 
- 
dieOnCircularReferenceCheck 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:
- stack- the stack of references to check.
- project- the project to use to dereference the references.
- Throws:
- BuildException- on error.
 
- 
setNameOverridden, not allowed to set the name of the resource.- Overrides:
- setNamein class- Resource
- Parameters:
- name- not used.
- Throws:
- BuildException- always.
 
- 
setExistspublic void setExists(boolean exists) Set the exists attribute.
- 
setLastModifiedOverride setLastModified.- Overrides:
- setLastModifiedin class- Resource
- Parameters:
- lastmodified- not used.
- Throws:
- BuildException- always.
 
- 
setDirectoryOverride setDirectory.- Overrides:
- setDirectoryin class- Resource
- Parameters:
- directory- not used.
- Throws:
- BuildException- always.
 
- 
setSizeOverride setSize.- Overrides:
- setSizein class- Resource
- Parameters:
- size- not used.
- Throws:
- BuildException- always.
 
 
-