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

Class FieldLocation

java.lang.Object

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

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

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

All Implemented Interfaces:

Comparable<SortableLocation>, SortableLocation

Direct Known Subclasses:

MethodLocation

public class FieldLocation
extends ClassLocation

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

Since:

2.0

Author:

Lennart Jörelid, jGuru Europe AB

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getMemberName() Retrieves the name of the member (i.e. method or field), potentially holding JavaDoc.
int	hashCode()
String	toString()

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

getClassName

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

FieldLocation

public FieldLocation(String packageName,
                     String className,
                     String memberName)

Creates a new FieldLocation with the supplied package, class and member 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.

memberName - The name of a (method or) field. Cannot be null or empty.

Method Detail

getMemberName

public String getMemberName()

Retrieves the name of the member (i.e. method or field), potentially holding JavaDoc.

Returns:

The name of the member (i.e. method or field), potentially holding JavaDoc. Never null or empty.

toString

public String toString()

Overrides:

toString in class ClassLocation

hashCode

public int hashCode()

Overrides:

hashCode in class ClassLocation