public abstract class ResourceDecorator extends Resource
Overwrites all setters to throw exceptions.
MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZEdescription, location, project| Modifier | Constructor and Description |
|---|---|
protected |
ResourceDecorator()
no arg constructor
|
protected |
ResourceDecorator(ResourceCollection other)
Constructor with another resource to wrap.
|
| Modifier and Type | Method and 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.
|
clone, equals, getMagicNumber, iterator, size, toLongString, toStringcheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributesgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectprotected ResourceDecorator()
protected ResourceDecorator(ResourceCollection other)
other - the resource to wrap.public final void addConfigured(ResourceCollection a)
a - the resource to wrap as a single element Resource collection.public java.lang.String getName()
public boolean isExists()
public long getLastModified()
getLastModified in class ResourceFile.public boolean isDirectory()
isDirectory in class Resourcepublic long getSize()
public java.io.InputStream getInputStream()
throws java.io.IOException
getInputStream in class Resourcejava.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.public java.io.OutputStream getOutputStream()
throws java.io.IOException
getOutputStream in class Resourcejava.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.public boolean isFilesystemOnly()
isFilesystemOnly in interface ResourceCollectionisFilesystemOnly in class Resourcepublic void setRefid(Reference r)
public <T> T as(java.lang.Class<T> clazz)
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.
public int compareTo(Resource other)
public int hashCode()
protected final Resource getResource()
protected void dieOnCircularReference(java.util.Stack<java.lang.Object> stack,
Project project)
throws BuildException
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.
dieOnCircularReference in class DataTypestack - the stack of references to check.project - the project to use to dereference the references.BuildException - on error.public void setName(java.lang.String name)
throws BuildException
setName in class Resourcename - not used.BuildException - always.public void setExists(boolean exists)
public void setLastModified(long lastmodified)
throws BuildException
setLastModified in class Resourcelastmodified - not used.BuildException - always.public void setDirectory(boolean directory)
throws BuildException
setDirectory in class Resourcedirectory - not used.BuildException - always.public void setSize(long size)
throws BuildException
setSize in class Resourcesize - not used.BuildException - always.