Package org.apache.creadur.whisker.model

Class WithinDirectory

java.lang.Object

org.apache.creadur.whisker.model.WithinDirectory

All Implemented Interfaces:

Comparable<WithinDirectory>, ContentElement

public class WithinDirectory
extends Object
implements Comparable<WithinDirectory>, ContentElement

Links resources expected within a directory in the distribution to licensing meta-data.

Constructor Summary

Constructors

Constructor	Description
WithinDirectory(String name, Collection<WithLicense> licenses, Collection<ByOrganisation> publicDomain)	Constructs a description of a directory

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accepts a visitor.
int	compareTo(WithinDirectory other)	Based on name.
boolean	equals(Object obj)	Based on directory name.
Collection<WithLicense>	getLicenses()	Gets resources contained, grouped by license applicable.
String	getName()	Gets the name of the directory described.
Collection<ByOrganisation>	getPublicDomain()	Gets resources in the public domain, grouped by the organisation responsible.
int	hashCode()	Based on name.
boolean	isNamed(String directoryName)	Does the directory described have the given name?

Methods inherited from class java.lang.Object

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

Constructor Details

WithinDirectory

public WithinDirectory(String name,
 Collection<WithLicense> licenses,
 Collection<ByOrganisation> publicDomain)

Constructs a description of a directory

Parameters:

name - directory name, not null

licenses - resources contained, grouped by license applicable, not null

publicDomain - resources in the public domain, grouped by responsible organisation

Method Details

getPublicDomain

public Collection<ByOrganisation> getPublicDomain()

Gets resources in the public domain, grouped by the organisation responsible.

Returns:

not null

getName

public String getName()

Gets the name of the directory described.

Returns:

not null

getLicenses

public Collection<WithLicense> getLicenses()

Gets resources contained, grouped by license applicable.

Returns:

not null

hashCode

public int hashCode()

Based on name.

Overrides:

hashCode in class Object

Returns:

hash code

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Based on directory name.

Overrides:

equals in class Object

Parameters:

obj - possibly null

Returns:

true when directory names are equal, false otherwise

See Also:

• Object.equals(java.lang.Object)

compareTo

public int compareTo(WithinDirectory other)

Based on name.

Specified by:

compareTo in interface Comparable<WithinDirectory>

Returns:

based on name

See Also:

• Comparable.compareTo(java.lang.Object)

isNamed

public boolean isNamed(String directoryName)

Does the directory described have the given name?

Parameters:

directoryName - not null

Returns:

true when the name match that of this directory, false otherwise

accept

public void accept(Visitor visitor)

Accepts a visitor.

Specified by:

accept in interface ContentElement

Parameters:

visitor - possibly null