Package net.sourceforge.pmd.lang.java.ast

Class JavaQualifiedName

java.lang.Object

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

All Implemented Interfaces:

net.sourceforge.pmd.lang.ast.QualifiedName

Direct Known Subclasses:

JavaOperationQualifiedName, JavaTypeQualifiedName

public abstract class JavaQualifiedName
extends Object
implements net.sourceforge.pmd.lang.ast.QualifiedName

Unambiguous identifier for a java method or class. This implementation approaches the qualified name format found in stack traces for example, using a custom format specification (see QualifiedNameFactory.ofString(String)).

Instances of this class are immutable. They can be obtained from the factory methods of QualifiedNameFactory, or from JavaQualifiableNode.getQualifiedName() on AST nodes that support it.

Class qualified names follow the binary name spec.

Method qualified names don't follow a specification but allow to distinguish overloads of the same method, using parameter types and order.

Since:

5.8.1

Author:

Clément Fournier

See Also:

JavaTypeQualifiedName, JavaOperationQualifiedName

Constructor Summary

Constructors

Constructor	Description
JavaQualifiedName()

Method Summary

Modifier and Type	Method	Description
protected abstract int	buildHashCode()	Computes the hashcode.
protected abstract String	buildToString()	Construct the toString once.
boolean	equals(Object o)
String[]	getClasses()	Deprecated. Use {JavaTypeQualifiedName.getClassList().
abstract JavaTypeQualifiedName	getClassName()
String	getClassSimpleName()	Deprecated. Use JavaTypeQualifiedName.getClassSimpleName().
String	getOperation()	Deprecated. Use JavaOperationQualifiedName.getOperation().
String[]	getPackages()	Deprecated. Use JavaTypeQualifiedName.getPackageList() ()}.
int	hashCode()
boolean	isLocalClass()	Deprecated. Use JavaTypeQualifiedName.isLocalClass().
boolean	isUnnamedPackage()	Deprecated. Use JavaTypeQualifiedName.isUnnamedPackage().
static JavaQualifiedName	ofClass(Class<?> clazz)	Deprecated. Use QualifiedNameFactory.ofClass(Class).
static JavaQualifiedName	ofString(String name)	Deprecated. Use QualifiedNameFactory.ofString(String).
protected abstract boolean	structurallyEquals(JavaQualifiedName qname)	Returns true if the given qname is identical to this qname.
String	toString()	Returns the string representation of this qualified name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.ast.QualifiedName

isClass, isOperation

Constructor Detail

JavaQualifiedName

public JavaQualifiedName()

Method Detail

getClassName

public abstract JavaTypeQualifiedName getClassName()

Specified by:

getClassName in interface net.sourceforge.pmd.lang.ast.QualifiedName

isLocalClass

@Deprecated
public boolean isLocalClass()

Deprecated.

Use JavaTypeQualifiedName.isLocalClass(). Will be removed in 7.0.0

Returns true if this qualified name identifies a local class.

getClassSimpleName

@Deprecated
public String getClassSimpleName()

Deprecated.

Use JavaTypeQualifiedName.getClassSimpleName(). Will be removed in 7.0.0

Get the simple name of the class.

isUnnamedPackage

@Deprecated
public boolean isUnnamedPackage()

Deprecated.

Use JavaTypeQualifiedName.isUnnamedPackage(). Will be removed in 7.0.0

Returns true if the class represented by this qualified name is in the unnamed package.

getOperation

@Deprecated
public String getOperation()

Deprecated.

Use JavaOperationQualifiedName.getOperation(). Will be removed in 7.0.0

Returns the operation specific part of the name. It identifies an operation in its namespace. Returns null if QualifiedName.isOperation() returns false.

Returns:

The operation string, or null.

getPackages

@Deprecated
public String[] getPackages()

Deprecated.

Use JavaTypeQualifiedName.getPackageList() ()}. Will be removed in 7.0.0

Returns the packages in order.

getClasses

@Deprecated
public String[] getClasses()

Deprecated.

Use {JavaTypeQualifiedName.getClassList(). Will be removed in 7.0.0

Returns the classes in order.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

structurallyEquals

protected abstract boolean structurallyEquals(JavaQualifiedName qname)

Returns true if the given qname is identical to this qname. Performs a structural comparison. Used in the implementation of equals(Object) after taking shortcuts.

Parameters:

qname - The other comparand. Can always be casted down to the subclass type in which this method is overridden

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

buildHashCode

protected abstract int buildHashCode()

Computes the hashcode. Called once, then cached. Since QualifiedNames are mostly used as the keys of a map, caching the hashcode makes sense.

toString

public final String toString()

Returns the string representation of this qualified name. The representation follows the format defined for QualifiedNameFactory.ofString(String).

Specified by:

toString in interface net.sourceforge.pmd.lang.ast.QualifiedName

Overrides:

toString in class Object

ofString

@Deprecated
public static JavaQualifiedName ofString(String name)

Deprecated.

Use QualifiedNameFactory.ofString(String). Will be removed in 7.0.0

ofClass

@Deprecated
public static JavaQualifiedName ofClass(Class<?> clazz)

Deprecated.

Use QualifiedNameFactory.ofClass(Class). Will be removed in 7.0.0

buildToString

protected abstract String buildToString()

Construct the toString once. Called only once per instance