org.apache.tools.ant.types.resources

Class PropertyResource

public class PropertyResource extends Resource

Exposes an Ant property as a Resource.

Since: Ant 1.7

Constructor Summary
PropertyResource()
Default constructor.
PropertyResource(Project p, String n)
Construct a new PropertyResource with the specified name.
Method Summary
booleanequals(Object o)
Override to implement equality with equivalent Resources, since we are capable of proxying them.
InputStreamgetInputStream()
Get an InputStream for the Resource.
ObjectgetObjectValue()
Get the Object value of this PropertyResource.
OutputStreamgetOutputStream()
Get an OutputStream for the Resource.
protected ResourcegetReferencedOrProxied()
Get the referenced or proxied Resource, if applicable.
longgetSize()
Get the size of this Resource.
StringgetValue()
Get the value of this PropertyResource.
inthashCode()
Get the hash code for this Resource.
booleanisExists()
Find out whether this Resource exists.
protected booleanisReferenceOrProxy()
Learn whether this PropertyResource either refers to another Resource or proxies another Resource due to its object property value being said Resource.
StringtoString()

Constructor Detail

PropertyResource

public PropertyResource()
Default constructor.

PropertyResource

public PropertyResource(Project p, String n)
Construct a new PropertyResource with the specified name.

Parameters: p the project to use. n the String name of this PropertyResource (Ant property name/key).

Method Detail

equals

public boolean equals(Object o)
Override to implement equality with equivalent Resources, since we are capable of proxying them.

Parameters: o object to compare

Returns: true if equal to o

getInputStream

public InputStream getInputStream()
Get an InputStream for the 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.

getObjectValue

public Object getObjectValue()
Get the Object value of this PropertyResource.

Returns: the Object value of the specified Property.

Since: Ant 1.8.1

getOutputStream

public OutputStream getOutputStream()
Get an OutputStream for the 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.

getReferencedOrProxied

protected Resource getReferencedOrProxied()
Get the referenced or proxied Resource, if applicable.

Returns: Resource

Throws: IllegalStateException if this PropertyResource neither proxies nor references another Resource.

getSize

public long getSize()
Get the size of this Resource.

Returns: the size, as a long, 0 if the Resource does not exist (for compatibility with java.io.File), or UNKNOWN_SIZE if not known.

getValue

public String getValue()
Get the value of this PropertyResource.

Returns: the value of the specified Property.

hashCode

public int hashCode()
Get the hash code for this Resource.

Returns: hash code as int.

isExists

public boolean isExists()
Find out whether this Resource exists.

Returns: true if the Property is set, false otherwise.

isReferenceOrProxy

protected boolean isReferenceOrProxy()
Learn whether this PropertyResource either refers to another Resource or proxies another Resource due to its object property value being said Resource.

Returns: boolean

toString

public String toString()
{@inheritDoc }