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

Class MethodLocation

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

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

All Implemented Interfaces:

Comparable<SortableLocation>, SortableLocation

public class MethodLocation
extends FieldLocation

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

Since:

2.0

Author:

Lennart Jörelid, jGuru Europe AB

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_PARAMETERS Signature for a method without any parameters.
static String	PARAMETER_SEPARATOR Separator for a method's parameters.

Constructor Summary

Constructors

Constructor and Description
MethodLocation(String packageName, String className, String classXmlName, String memberName, String memberXmlName, List<com.thoughtworks.qdox.model.JavaParameter> parameters) Creates a new MethodLocation with the supplied package, class and member names.

Method Summary

Modifier and Type	Method and Description
String	getParametersAsString()
String	getPath() Always appends the effective className to the path from the superclass PackageLocation.
int	hashCode()
boolean	hasNoParameters()
String	toString()

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

getAnnotationRenamedTo, getMemberName

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, isEqualToPath

Methods inherited from class java.lang.Object

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

Field Detail

NO_PARAMETERS

public static final String NO_PARAMETERS

Signature for a method without any parameters.

See Also:

Constant Field Values

PARAMETER_SEPARATOR

public static final String PARAMETER_SEPARATOR

Separator for a method's parameters.

See Also:

Constant Field Values

Constructor Detail

MethodLocation

public MethodLocation(String packageName,
                      String className,
                      String classXmlName,
                      String memberName,
                      String memberXmlName,
                      List<com.thoughtworks.qdox.model.JavaParameter> parameters)

Creates a new MethodLocation 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.

classXmlName - The name given as the XmlType.name() value of an annotation placed on the Class, or null if none is provided.

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

memberXmlName - The name given as the XmlElement.name() or XmlAttribute.name() value of an annotation placed on this Field, or null if none is provided.

parameters - The names of the types which are parameters to this method.

Method Detail

getPath

public String getPath()

Always appends the effective className to the path from the superclass PackageLocation. If the ClassLocation.getAnnotationRenamedTo() method returns a non-null value, that value is the effective className. Otherwise, the ClassLocation.getClassName() method is used as the effective className. This is to handle renames such as provided in a XmlType annotation's XmlType.name() attribute value.

Specified by:

getPath in interface SortableLocation

Overrides:

getPath in class FieldLocation

Returns:

the path of the PackageLocation superclass, appended with the effective className.

See Also:

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

toString

public String toString()

Overrides:

toString in class FieldLocation

hashCode

public int hashCode()

Overrides:

hashCode in class FieldLocation

getParametersAsString

public String getParametersAsString()

Returns:

The parameters, concatenated into a String.

hasNoParameters

public boolean hasNoParameters()

Returns:

True if this MethodLocation has no parameters.