net.sourceforge.pmd.lang.java.ast

Class JavaQualifiedName

java.lang.Object

net.sourceforge.pmd.lang.java.ast.JavaQualifiedName

All Implemented Interfaces:

QualifiedName

public final class JavaQualifiedName
extends java.lang.Object
implements QualifiedName

Represents Qualified Names for use within the java metrics framework.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	FORMAT Pattern specifying the format.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String[]	getClasses() Returns the class specific part of the name.
JavaQualifiedName	getClassName()
java.lang.String	getOperation() Returns the operation specific part of the name.
java.lang.String[]	getPackages() Returns the packages.
int	hashCode()
boolean	isClass()
boolean	isOperation()
static JavaQualifiedName	ofClass(java.lang.Class<?> clazz) Gets the qualified name of a class.
static JavaQualifiedName	ofString(java.lang.String name) Parses a qualified name given in the format defined for this implementation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final java.util.regex.Pattern FORMAT

Pattern specifying the format.

((\w+\.)+|\.)((\w+)(\$\w+)*)(#(\w+)\(((\w+)(, \w+)*)?\))?

Method Detail

ofClass

public static JavaQualifiedName ofClass(java.lang.Class<?> clazz)

Gets the qualified name of a class.

Parameters:

clazz - Class object

Returns:

The qualified name of the class, or null if the class is null

ofString

public static JavaQualifiedName ofString(java.lang.String name)

Parses a qualified name given in the format defined for this implementation. The format is specified by a regex pattern (see FORMAT). Examples:

com.company.MyClass$Nested#myMethod(String, int)

• Packages are separated by full stops;
• Nested classes are separated by a dollar symbol;
• The optional method suffix is separated from the class with a hashtag;
• Method arguments are separated by a comma and a single space.

.MyClass$Nested

• A class in the unnamed package is preceded by a single full stop.

Parameters:

name - The name to parse.

Returns:

A qualified name instance corresponding to the parsed string.

isClass

public boolean isClass()

Specified by:

isClass in interface QualifiedName

isOperation

public boolean isOperation()

Specified by:

isOperation in interface QualifiedName

getPackages

public java.lang.String[] getPackages()

Returns the packages. This is specific to Java's package structure.

Returns:

The packages.

getClasses

public java.lang.String[] getClasses()

Returns the class specific part of the name. It identifies a class in the namespace it's declared in. If the class is nested inside another, then the array returned contains all enclosing classes in order.

Returns:

The class names array.

getOperation

public java.lang.String getOperation()

Returns the operation specific part of the name. It identifies an operation in its namespace.

Returns:

The operation string.

getClassName

public JavaQualifiedName getClassName()

Specified by:

getClassName in interface QualifiedName

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface QualifiedName

Overrides:

toString in class java.lang.Object