net.sourceforge.pmd.lang.java.ast

Class QualifiedName

java.lang.Object

net.sourceforge.pmd.lang.java.ast.QualifiedName

public final class QualifiedName
extends Object

Represents Qualified Names for use within PackageStats. TODO:cf make unit tests once the visitor is working to ensure new implementations won't break it

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String[]	getClasses() Returns the classes.
String	getOperation() Returns the operation string.
String[]	getPackages() Returns the packages.
int	hashCode()
boolean	isClass() Returns true if the resource addressed by this qualified name is a class.
boolean	isOperation() Returns true if the resource addressed by this qualified name is an operation.
static QualifiedName	makeClassOf(Class<?> clazz)
static QualifiedName	makeNestedClassOf(QualifiedName parent, String className) Builds the qualified name of a nested class using the qualified name of its immediate parent.
static QualifiedName	makeOperationOf(ASTConstructorDeclaration node) Builds the qualified name of a constructor declaration.
static QualifiedName	makeOperationOf(ASTMethodDeclaration node) Builds the qualified name of a method declaration.
static QualifiedName	makeOuterClassOf(ASTClassOrInterfaceDeclaration node) Builds the qualified name of an outer (not nested) class.
static QualifiedName	parseName(String name) Parses a qualified name given in the format defined for this implementation.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final Pattern FORMAT

Pattern specifying the format.

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

Method Detail

makeOperationOf

public static QualifiedName makeOperationOf(ASTMethodDeclaration node)

Builds the qualified name of a method declaration.

Parameters:

node - The method declaration node

Returns:

The qualified name of the node

makeOperationOf

public static QualifiedName makeOperationOf(ASTConstructorDeclaration node)

Builds the qualified name of a constructor declaration.

Parameters:

node - The constructor declaration node

Returns:

The qualified name of the node

makeNestedClassOf

public static QualifiedName makeNestedClassOf(QualifiedName parent,
                              String className)

Builds the qualified name of a nested class using the qualified name of its immediate parent.

Parameters:

parent - The qname of the immediate parent

className - The name of the class

Returns:

The qualified name of the nested class

makeOuterClassOf

public static QualifiedName makeOuterClassOf(ASTClassOrInterfaceDeclaration node)

Builds the qualified name of an outer (not nested) class.

Parameters:

node - The class node

Returns:

The qualified name of the node

makeClassOf

public static QualifiedName makeClassOf(Class<?> clazz)

parseName

public static QualifiedName parseName(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()

Returns true if the resource addressed by this qualified name is a class.

Returns:

true if the resource addressed by this qualified name is a class.

isOperation

public boolean isOperation()

Returns true if the resource addressed by this qualified name is an operation.

Returns:

true if the resource addressed by this qualified name is an operation.

getPackages

public String[] getPackages()

Returns the packages. @return The packages.

getClasses

public String[] getClasses()

Returns the classes. @return The classes.

getOperation

public String getOperation()

Returns the operation string. @return The operation string.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object