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

Interface SortableLocation

All Superinterfaces:

Comparable<SortableLocation>

All Known Implementing Classes:

ClassLocation, FieldLocation, MethodLocation, PackageLocation

public interface SortableLocation
extends Comparable<SortableLocation>

Common specification for a JavaDoc location which can be compared and sorted. JavaDoc locations must be comparable and also convert-able to unique strings.

Since:

2.0

Author:

Lennart Jörelid, jGuru Europe AB

Method Summary

Modifier and Type	Method and Description
String	getAnnotationRenamedTo() Retrieves the value of the name attribute provided by a JAXB annotation, implying that the XSD type should use another name than the default.
String	getPath() Retrieves the path of this SortableLocation.
boolean	isEqualToPath(String path) Validates if the supplied path is equal to this SortableLocation.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isEqualToPath

boolean isEqualToPath(String path)

Validates if the supplied path is equal to this SortableLocation.

Parameters:

path - The non-null path to compare to this SortableLocation.

Returns:

true if this SortableLocation is equal to the supplied path.

getPath

String getPath()

Retrieves the path of this SortableLocation. The path must uniquely correspond to each unique SortableLocation, implying that SortableLocations could be sorted and compared for equality using the path property.

Returns:

the path of this SortableLocation. Never null.

getAnnotationRenamedTo

String getAnnotationRenamedTo()

Retrieves the value of the name attribute provided by a JAXB annotation, implying that the XSD type should use another name than the default.

Returns:

the value of the name attribute provided by a JAXB annotation relevant to this SortableLocation.

See Also:

XmlElement.name(), XmlAttribute.name(), XmlType.name()