Class ClassLocation
java.lang.Object
org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.location.PackageLocation
org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.location.ClassLocation
- All Implemented Interfaces:
Comparable<SortableLocation>
,SortableLocation
- Direct Known Subclasses:
FieldLocation
Comparable path structure to locate a particular class within compilation unit.
- Since:
- 2.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionClassLocation
(String packageName, String className, String classXmlName) Creates a new ClassLocation with the supplied package and class names. -
Method Summary
Modifier and TypeMethodDescriptionNote: Packages cannot be renamed from a JAXB annotation.Retrieves the simple class name for the class potentially holding JavaDoc.getPath()
Always appends the effective className to the path from the superclassPackageLocation
.int
hashCode()
toString()
Methods inherited from class org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.location.PackageLocation
compareTo, equals, getPackageName, isEqualToPath
-
Field Details
-
className
-
classXmlName
-
-
Constructor Details
-
ClassLocation
Creates a new ClassLocation with the supplied package and class names.- Parameters:
packageName
- The name of the package for a class potentially holding JavaDoc. Cannot benull
.className
- The (simple) name of a class. Cannot be null or empty.classXmlName
- The name given as theXmlType.name()
value of an annotation placed on the Class, ornull
if none is provided.
-
-
Method Details
-
getClassName
Retrieves the simple class name for the class potentially holding JavaDoc. Nevernull
or empty.- Returns:
- The simple class name for the class potentially holding JavaDoc. Never
null
or empty.
-
getPath
Always appends the effective className to the path from the superclassPackageLocation
. If thegetAnnotationRenamedTo()
method returns a non-null value, that value is the effective className. Otherwise, thegetClassName()
method is used as the effective className. This is to handle renames such as provided in aXmlType
annotation'sXmlType.name()
attribute value.- Specified by:
getPath
in interfaceSortableLocation
- Overrides:
getPath
in classPackageLocation
- Returns:
- the path of the PackageLocation superclass, appended with the effective className.
- See Also:
-
getAnnotationRenamedTo
Note: Packages cannot be renamed from a JAXB annotation. Retrieves the value of the name attribute provided by a JAXB annotation, implying that the XSD type should use another name than the default.- Specified by:
getAnnotationRenamedTo
in interfaceSortableLocation
- Overrides:
getAnnotationRenamedTo
in classPackageLocation
- Returns:
- the value of the name attribute provided by a JAXB annotation relevant to this
SortableLocation
. - See Also:
-
hashCode
public int hashCode()- Overrides:
hashCode
in classPackageLocation
-
toString
- Overrides:
toString
in classPackageLocation
-