SortableLocation

All Superinterfaces:

java.lang.Comparable<SortableLocation>

All Known Implementing Classes:

ClassLocation, FieldLocation, MethodLocation, PackageLocation
```
public interface SortableLocation
extends java.lang.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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.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.
`java.lang.String`	`getPath()`	Retrieves the path of this SortableLocation.
`boolean`	`isEqualToPath(java.lang.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(java.lang.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
```
java.lang.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
```
java.lang.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()