org.apache.tools.ant.types
public class Resource extends DataType implements Cloneable, Comparable, ResourceCollection
Since: Ant 1.5.2
See Also: Touchable
Field Summary | |
---|---|
protected static int | MAGIC Magic number |
static long | UNKNOWN_DATETIME Constant unknown datetime for getLastModified |
static long | UNKNOWN_SIZE Constant unknown size |
Constructor Summary | |
---|---|
Resource()
Default constructor. | |
Resource(String name)
Only sets the name.
| |
Resource(String name, boolean exists, long lastmodified)
Sets the name, lastmodified flag, and exists flag.
| |
Resource(String name, boolean exists, long lastmodified, boolean directory)
Sets the name, lastmodified flag, exists flag, and directory flag.
| |
Resource(String name, boolean exists, long lastmodified, boolean directory, long size)
Sets the name, lastmodified flag, exists flag, directory flag, and size.
|
Method Summary | |
---|---|
Object | clone()
Clone this Resource. |
int | compareTo(Object other)
Delegates to a comparison of names. |
boolean | equals(Object other)
Implement basic Resource equality. |
InputStream | getInputStream()
Get an InputStream for the Resource. |
long | getLastModified()
Tells the modification time in milliseconds since 01.01.1970 .
|
protected static int | getMagicNumber(byte[] seed)
Create a "magic number" for use in hashCode calculations. |
String | getName()
Name attribute will contain the path of a file relative to the
root directory of its fileset or the recorded path of a zip
entry.
|
OutputStream | getOutputStream()
Get an OutputStream for the Resource. |
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. |
Iterator | iterator()
Fulfill the ResourceCollection contract. |
void | setDirectory(boolean directory)
Set the directory attribute. |
void | setExists(boolean exists)
Set the exists attribute. |
void | setLastModified(long lastmodified)
Set the last modification attribute. |
void | setName(String name)
Set the name of this Resource. |
void | setRefid(Reference r)
Overrides the base version. |
void | setSize(long size)
Set the size of this Resource. |
int | size()
Fulfill the ResourceCollection contract. |
String | toLongString()
Get a long String representation of this Resource.
|
String | toString()
Get the string representation of this Resource. |
This is a dummy, used for not existing resources.
Parameters: name relative path of the resource. Expects "/" to be used as the directory separator.
Parameters: name relative path of the resource. Expects "/" to be used as the directory separator. exists if true, this resource exists. lastmodified the last modification time of this resource.
Parameters: name relative path of the resource. Expects "/" to be used as the directory separator. exists if true the resource exists lastmodified the last modification time of the resource directory if true, this resource is a directory
Parameters: name relative path of the resource. Expects "/" to be used as the directory separator. exists if true the resource exists lastmodified the last modification time of the resource directory if true, this resource is a directory size the size of this resource.
Returns: copy of this.
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.
Since: Ant 1.6
Parameters: other the object to check against.
Returns: true if the specified Object is equal to this Resource.
Since: Ant 1.7
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.
Since: Ant 1.7
Returns: 0 if the resource does not exist to mirror the behavior of {@link java.io.File File}.
Parameters: seed byte[] to seed with.
Returns: a magic number as int.
example for a file with fullpath /var/opt/adm/resource.txt in a file set with root dir /var/opt it will be adm/resource.txt.
"/" will be used as the directory separator.
Returns: the name of this 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.
Since: Ant 1.7
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.
Since: Ant 1.6.3
Returns: hash code as int.
Since: Ant 1.7
Returns: boolean flag indicating if the resource is a directory.
Returns: true if this resource exists.
Returns: whether this Resource is a FileResource.
Since: Ant 1.7
Returns: an Iterator of Resources.
Since: Ant 1.7
Parameters: directory if true, this resource is a directory.
Parameters: exists if true, this resource exists.
Parameters: lastmodified the modification time in milliseconds since 01.01.1970.
Parameters: name relative path of the resource. Expects "/" to be used as the directory separator.
Parameters: r the Reference to set.
Parameters: size the size, as a long.
Since: Ant 1.6.3
Returns: the size of this ResourceCollection.
Since: Ant 1.7
toString()
prefixed by a type description.Returns: this Resource formatted as a long String.
Since: Ant 1.7
Returns: this Resource formatted as a String.
Since: Ant 1.7