Class JavaDocExtractor.ReadOnlySearchableDocumentation

java.lang.Object

org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.JavaDocExtractor.ReadOnlySearchableDocumentation

All Implemented Interfaces:

SearchableDocumentation

Enclosing class:

JavaDocExtractor

private class JavaDocExtractor.ReadOnlySearchableDocumentation
extends Object
implements SearchableDocumentation

Standard read-only SearchableDocumentation implementation.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
private TreeMap<String, SortableLocation>	keyMap
private SortedMap<? extends SortableLocation, JavaDocData>	valueMap

Constructor Summary

Constructors

Constructor	Description
ReadOnlySearchableDocumentation(SortedMap<SortableLocation, JavaDocData> valueMap)

Method Summary

Modifier and Type	Method	Description
SortedMap<SortableLocation, JavaDocData>	getAll()	The full map relating each SortableLocation subclass to its corresponding JavaDocData.
<T extends SortableLocation> SortedMap<T, JavaDocData>	getAll(Class<T> type)	Convenience method which retrieves a SortedMap relating all SortableLocations of a particular type to their JavaDocData, respectively.
JavaDocData	getJavaDoc(String path)	Convenience method to acquire the JavaDocData for a SortableLocation with the supplied path.
<T extends SortableLocation> T	getLocation(String path)	Convenience method to acquire the SortableLocation corresponding to the given path.
SortedSet<String>	getPaths()	Retrieves all unique SortableLocation paths within this SearchableDocumentation.

Methods inherited from class Object

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

Field Details

keyMap

private TreeMap<String, SortableLocation> keyMap

valueMap

private SortedMap<? extends SortableLocation, JavaDocData> valueMap

Constructor Details

ReadOnlySearchableDocumentation

ReadOnlySearchableDocumentation(SortedMap<SortableLocation, JavaDocData> valueMap)

Method Details

getPaths

public SortedSet<String> getPaths()

Retrieves all unique SortableLocation paths within this SearchableDocumentation.

Specified by:

getPaths in interface SearchableDocumentation

Returns:

all unique SortableLocation paths within this SearchableDocumentation. The result may be empty, but will never be null.

getJavaDoc

public JavaDocData getJavaDoc(String path)

Convenience method to acquire the JavaDocData for a SortableLocation with the supplied path.

Specified by:

getJavaDoc in interface SearchableDocumentation

Parameters:

path - A non-null path for which the harvested JavaDocData should be retrieved.

Returns:

The JavaDocData matching the SortableLocation with the supplied path, or null if no SortableLocation with the supplied path was found within this SearchableDocumentation.

getLocation

public <T extends SortableLocation> T getLocation(String path)

Convenience method to acquire the SortableLocation corresponding to the given path.

Specified by:

getLocation in interface SearchableDocumentation

Type Parameters:

T - The SortableLocation subtype.

Parameters:

path - The path of a SortableLocation, which is retrieved by a call to its toString() method.

Returns:

the SortableLocation corresponding to the given path, or null if this SearchableDocumentation does not contain a SortableLocation with the provided path.

getAll

public SortedMap<SortableLocation, JavaDocData> getAll()

The full map relating each SortableLocation subclass to its corresponding JavaDocData.

Specified by:

getAll in interface SearchableDocumentation

Returns:

The full map relating each SortableLocation subclass to its corresponding JavaDocData. Never null.

getAll

public <T extends SortableLocation>
SortedMap<T, JavaDocData> getAll(Class<T> type)

Convenience method which retrieves a SortedMap relating all SortableLocations of a particular type to their JavaDocData, respectively.

Specified by:

getAll in interface SearchableDocumentation

Type Parameters:

T - The SortableLocation subtype for which all JavaDocData should be retrieved.

Parameters:

type - The exact type of SortableLocation which should be filtered from the result and returned in the form of a SortedMap, along with its respective JavaDocData.

Returns:

a SortedMap relating all SortableLocations of a particular (exact) type (i.e. any subclass types will not be returned) to their JavaDocData, respectively. May return empty Maps, but never null.