org.apache.tools.ant.types.resources

Class ArchiveResource

public abstract class ArchiveResource extends Resource

A Resource representation of an entry inside an archive.

Since: Ant 1.7

Constructor Summary
	ArchiveResource() Default constructor.
	ArchiveResource(File a) Construct a ArchiveResource representing the specified entry in the specified archive.
	ArchiveResource(File a, boolean withEntry) Construct a ArchiveResource representing the specified entry in the specified archive.
	ArchiveResource(Resource a, boolean withEntry) Construct a ArchiveResource representing the specified entry in the specified archive.

Method Summary
void	addConfigured(ResourceCollection a) Sets the archive that holds this as a single element Resource collection.
int	compareTo(Object another) Compare this ArchiveResource to another Resource.
boolean	equals(Object another) Compare another Object to this ArchiveResource for equality.
protected abstract void	fetchEntry() fetches information from the named entry inside the archive.
Resource	getArchive() Get the archive that holds this Resource.
long	getLastModified() Get the last modified date of this Resource.
int	getMode() Get the file or dir mode for this Resource.
long	getSize() Get the size of this Resource.
int	hashCode() Get the hash code for this Resource.
boolean	isDirectory() Learn whether this Resource represents a directory.
boolean	isExists() Find out whether this Resource represents an existing Resource.
void	setArchive(File a) Set the archive that holds this Resource.
void	setMode(int mode) Sets the file or dir mode for this resource.
void	setRefid(Reference r) Overrides the super version.
String	toString() Format this Resource as a String.

Constructor Detail

ArchiveResource

public ArchiveResource()

Default constructor.

ArchiveResource

public ArchiveResource(File a)

Construct a ArchiveResource representing the specified entry in the specified archive.

Parameters: a the archive as File.

ArchiveResource

public ArchiveResource(File a, boolean withEntry)

Construct a ArchiveResource representing the specified entry in the specified archive.

Parameters: a the archive as File. withEntry if the entry has been specified.

ArchiveResource

public ArchiveResource(Resource a, boolean withEntry)

Construct a ArchiveResource representing the specified entry in the specified archive.

Parameters: a the archive as Resource. withEntry if the entry has been specified.

Method Detail

addConfigured

public void addConfigured(ResourceCollection a)

Sets the archive that holds this as a single element Resource collection.

Parameters: a the archive as a single element Resource collection.

compareTo

public int compareTo(Object another)

Compare this ArchiveResource to another Resource.

Parameters: another the other Resource against which to compare.

Returns: a negative integer, zero, or a positive integer as this Resource is less than, equal to, or greater than the specified Resource.

equals

public boolean equals(Object another)

Compare another Object to this ArchiveResource for equality.

Parameters: another the other Object to compare.

Returns: true if another is a Resource representing the same entry in the same archive.

fetchEntry

protected abstract void fetchEntry()

fetches information from the named entry inside the archive.

getArchive

public Resource getArchive()

Get the archive that holds this Resource.

Returns: the archive as a Resource.

getLastModified

public long getLastModified()

Get the last modified date of this Resource.

Returns: the last modification date.

getMode

public int getMode()

Get the file or dir mode for this Resource.

Returns: integer representation of Unix permission mask.

getSize

public long getSize()

Get the size of this Resource.

Returns: the long size of this Resource.

hashCode

public int hashCode()

Get the hash code for this Resource.

Returns: hash code as int.

isDirectory

public boolean isDirectory()

Learn whether this Resource represents a directory.

Returns: boolean flag indicating whether the entry is a directory.

isExists

public boolean isExists()

Find out whether this Resource represents an existing Resource.

Returns: boolean existence flag.

setArchive

public void setArchive(File a)

Set the archive that holds this Resource.

Parameters: a the archive as a File.

setMode

public void setMode(int mode)

Sets the file or dir mode for this resource.

Parameters: mode integer representation of Unix permission mask.

setRefid

public void setRefid(Reference r)

Overrides the super version.

Parameters: r the Reference to set.

toString

public String toString()

Format this Resource as a String.

Returns: String representatation of this Resource.