Class ResourceDescription

java.lang.Object

org.apache.creadur.whisker.app.analysis.ResourceDescription

All Implemented Interfaces:

Comparable<ResourceDescription>

public class ResourceDescription
extends Object
implements Comparable<ResourceDescription>

Describes a resource in a software distribution.

Constructor Summary

Constructors

Constructor	Description
ResourceDescription(String directoryName, String resourceName)	Constructs a description of the given resource.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ResourceDescription other)	Natural comparison is directory name, then resource name.
boolean	equals(Object obj)	Equal means identical name and directory.
final String	getDirectory()	Gets the name of the containing directory.
final String	getResource()	Gets the resource name.
int	hashCode()	Hash code compatible with equals.
String	toString()	Suitable for logging.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ResourceDescription

public ResourceDescription(String directoryName,
 String resourceName)

Constructs a description of the given resource.

Parameters:

directoryName - not null

resourceName - not null

Method Details

getDirectory

public final String getDirectory()

Gets the name of the containing directory.

Returns:

the directoryName, not null

getResource

public final String getResource()

Gets the resource name.

Returns:

the resourceName, not null

hashCode

public int hashCode()

Hash code compatible with equals.

Overrides:

hashCode in class Object

Returns:

a suitable hash code

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Equal means identical name and directory.

Overrides:

equals in class Object

Parameters:

obj - object to be compared against

Returns:

true when equal

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Suitable for logging.

Overrides:

toString in class Object

Returns:

not null

See Also:

• Object.toString()

compareTo

public int compareTo(ResourceDescription other)

Natural comparison is directory name, then resource name.

Specified by:

compareTo in interface Comparable<ResourceDescription>

Parameters:

other - possibly null

Returns:

numeric comparison

See Also:

• Comparable.compareTo(java.lang.Object)