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

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

public class ClassLocation
extends PackageLocation

Comparable path structure to locate a particular class within compilation unit.

Since:

2.0

Author:

Lennart Jörelid, jGuru Europe AB

Constructor Summary

Constructors

Constructor and Description
ClassLocation(String packageName, String className) Creates a new ClassLocation with the supplied package and class names.

Method Summary

Methods

Modifier and Type	Method and Description
String	getClassName() Retrieves the simple class name for the class potentially holding JavaDoc.
int	hashCode()
String	toString()

Methods inherited from class org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.location.PackageLocation

compareTo, equals, getPackageName, getPath, isEqualToPath

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassLocation

public ClassLocation(String packageName,
             String className)

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 be null.

className - The (simple) name of a class. Cannot be null or empty.

Method Detail

getClassName

public String getClassName()

Retrieves the simple class name for the class potentially holding JavaDoc. Never null or empty.

Returns:

The simple class name for the class potentially holding JavaDoc. Never null or empty.

hashCode

public int hashCode()

Overrides:

hashCode in class PackageLocation

toString

public String toString()

Overrides:

toString in class PackageLocation