| org.apache.tools.ant.types.DataType org.apache.tools.ant.types.Resource
All known Subclasses: org.apache.tools.ant.types.resources.CompressedResource, org.apache.tools.ant.types.resources.StringResource, org.apache.tools.ant.types.resources.ArchiveResource, org.apache.tools.ant.types.resources.PropertyResource, org.apache.tools.ant.types.resources.URLResource, org.apache.tools.ant.types.resources.JavaResource, org.apache.tools.ant.types.resources.FileResource,
Constructor Summary | |
public | Resource() Default constructor. | public | Resource(String name) Only sets the name.
This is a dummy, used for not existing resources.
Parameters: name - relative path of the resource. | public | Resource(String name, boolean exists, long lastmodified) Sets the name, lastmodified flag, and exists flag.
Parameters: name - relative path of the resource. | public | Resource(String name, boolean exists, long lastmodified, boolean directory) Sets the name, lastmodified flag, exists flag, and directory flag.
Parameters: name - relative path of the resource. | public | Resource(String name, boolean exists, long lastmodified, boolean directory, long size) Sets the name, lastmodified flag, exists flag, directory flag, and size.
Parameters: name - relative path of the resource. |
Method Summary | |
public Object | clone() Clone this Resource. | public int | compareTo(Object other) Delegates to a comparison of names.
Parameters: other - the object to compare to. | public boolean | equals(Object other) Implement basic Resource equality.
Parameters: other - the object to check against. | public InputStream | getInputStream() Get an InputStream for the Resource. | public 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.
Parameters: seed - byte[] to seed with. | public 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. | public OutputStream | getOutputStream() Get an OutputStream for the Resource. | public long | getSize() Get the size of this Resource. | public int | hashCode() Get the hash code for this Resource. | public boolean | isDirectory() Tells if the resource is a directory. | public boolean | isExists() The exists attribute tells whether a file exists. | public boolean | isFilesystemOnly() Fulfill the ResourceCollection contract. | public Iterator | iterator() Fulfill the ResourceCollection contract. | public void | setDirectory(boolean directory) Set the directory attribute. | public void | setExists(boolean exists) Set the exists attribute. | public void | setLastModified(long lastmodified) Set the last modification attribute. | public void | setName(String name) Set the name of this Resource.
Parameters: name - relative path of the resource. | public void | setRefid(Reference r) Overrides the base version. | public void | setSize(long size) Set the size of this Resource. | public int | size() Fulfill the ResourceCollection contract. | final public String | toLongString() Get a long String representation of this Resource. | public String | toString() Get the string representation of this Resource. |
MAGIC | final protected static int MAGIC(Code) | | Magic number
|
UNKNOWN_DATETIME | final public static long UNKNOWN_DATETIME(Code) | | Constant unknown datetime for getLastModified
|
UNKNOWN_SIZE | final public static long UNKNOWN_SIZE(Code) | | Constant unknown size
|
Resource | public Resource()(Code) | | Default constructor.
|
Resource | public Resource(String name)(Code) | | Only sets the name.
This is a dummy, used for not existing resources.
Parameters: name - relative path of the resource. Expects"/" to be used as the directory separator. |
Resource | public Resource(String name, boolean exists, long lastmodified)(Code) | | Sets the name, lastmodified flag, and exists flag.
Parameters: name - relative path of the resource. Expects"/" to be used as the directory separator. Parameters: exists - if true, this resource exists. Parameters: lastmodified - the last modification time of this resource. |
Resource | public Resource(String name, boolean exists, long lastmodified, boolean directory)(Code) | | Sets the name, lastmodified flag, exists flag, and directory flag.
Parameters: name - relative path of the resource. Expects"/" to be used as the directory separator. Parameters: exists - if true the resource exists Parameters: lastmodified - the last modification time of the resource Parameters: directory - if true, this resource is a directory |
Resource | public Resource(String name, boolean exists, long lastmodified, boolean directory, long size)(Code) | | Sets the name, lastmodified flag, exists flag, directory flag, and size.
Parameters: name - relative path of the resource. Expects"/" to be used as the directory separator. Parameters: exists - if true the resource exists Parameters: lastmodified - the last modification time of the resource Parameters: directory - if true, this resource is a directory Parameters: size - the size of this resource. |
clone | public Object clone()(Code) | | Clone this Resource.
copy of this. |
compareTo | public int compareTo(Object other)(Code) | | Delegates to a comparison of names.
Parameters: other - the object to compare to. a negative integer, zero, or a positive integer as this Resourceis less than, equal to, or greater than the specified Resource. since: Ant 1.6 |
equals | public boolean equals(Object other)(Code) | | Implement basic Resource equality.
Parameters: other - the object to check against. true if the specified Object is equal to this Resource. since: Ant 1.7 |
getInputStream | public InputStream getInputStream() throws IOException(Code) | | Get an InputStream for the Resource.
an InputStream containing this Resource's content. throws: IOException - if unable to provide the content of thisResource as a stream. throws: UnsupportedOperationException - if InputStreams are notsupported for this Resource type. since: Ant 1.7 |
getLastModified | public long getLastModified()(Code) | | Tells the modification time in milliseconds since 01.01.1970 .
0 if the resource does not exist to mirror the behaviorof java.io.File File. |
getMagicNumber | protected static int getMagicNumber(byte[] seed)(Code) | | Create a "magic number" for use in hashCode calculations.
Parameters: seed - byte[] to seed with. a magic number as int. |
getName | public String getName()(Code) | | 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.
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.
the name of this resource. |
getOutputStream | public OutputStream getOutputStream() throws IOException(Code) | | Get an OutputStream for the Resource.
an OutputStream to which content can be written. throws: IOException - if unable to provide the content of thisResource as a stream. throws: UnsupportedOperationException - if OutputStreams are notsupported for this Resource type. since: Ant 1.7 |
getSize | public long getSize()(Code) | | Get the size of this Resource.
the size, as a long, 0 if the Resource does not exist (forcompatibility with java.io.File), or UNKNOWN_SIZE if not known. since: Ant 1.6.3 |
hashCode | public int hashCode()(Code) | | Get the hash code for this Resource.
hash code as int. since: Ant 1.7 |
isDirectory | public boolean isDirectory()(Code) | | Tells if the resource is a directory.
boolean flag indicating if the resource is a directory. |
isExists | public boolean isExists()(Code) | | The exists attribute tells whether a file exists.
true if this resource exists. |
isFilesystemOnly | public boolean isFilesystemOnly()(Code) | | Fulfill the ResourceCollection contract.
whether this Resource is a FileResource. since: Ant 1.7 |
iterator | public Iterator iterator()(Code) | | Fulfill the ResourceCollection contract.
an Iterator of Resources. since: Ant 1.7 |
setDirectory | public void setDirectory(boolean directory)(Code) | | Set the directory attribute.
Parameters: directory - if true, this resource is a directory. |
setExists | public void setExists(boolean exists)(Code) | | Set the exists attribute.
Parameters: exists - if true, this resource exists. |
setLastModified | public void setLastModified(long lastmodified)(Code) | | Set the last modification attribute.
Parameters: lastmodified - the modification time in milliseconds since 01.01.1970. |
setName | public void setName(String name)(Code) | | Set the name of this Resource.
Parameters: name - relative path of the resource. Expects"/" to be used as the directory separator. |
setRefid | public void setRefid(Reference r)(Code) | | Overrides the base version.
Parameters: r - the Reference to set. |
setSize | public void setSize(long size)(Code) | | Set the size of this Resource.
Parameters: size - the size, as a long. since: Ant 1.6.3 |
size | public int size()(Code) | | Fulfill the ResourceCollection contract.
the size of this ResourceCollection. since: Ant 1.7 |
toLongString | final public String toLongString()(Code) | | Get a long String representation of this Resource.
This typically should be the value of toString()
prefixed by a type description.
this Resource formatted as a long String. since: Ant 1.7 |
toString | public String toString()(Code) | | Get the string representation of this Resource.
this Resource formatted as a String. since: Ant 1.7 |
|
|