Package net.sourceforge.pmd.lang.java.qname

Class JavaTypeQualifiedName

java.lang.Object

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

net.sourceforge.pmd.lang.java.qname.JavaTypeQualifiedName

All Implemented Interfaces:

net.sourceforge.pmd.lang.ast.QualifiedName

public final class JavaTypeQualifiedName
extends JavaQualifiedName

Specialises JavaQualifiedName for type names.

Since:

6.1.0

Author:

Clément Fournier

Method Summary

Modifier and Type	Method	Description
protected int	buildHashCode()	Computes the hashcode.
protected java.lang.String	buildToString()	Construct the toString once.
java.lang.String	getBinaryName()	Returns the binary name of the type identified by this qualified name.
java.util.List<java.lang.String>	getClassList()	Returns the class specific part of the name.
JavaTypeQualifiedName	getClassName()
java.lang.String	getClassSimpleName()	Get the simple name of the class.
java.util.List<java.lang.String>	getPackageList()	Returns the packages in outer-to-inner order.
java.lang.Class<?>	getType()	Gets the Class instance identified by this qualified name.
boolean	isAnonymousClass()	Returns true if this qualified name identifies an anonymous class.
boolean	isClass()
boolean	isLocalClass()	Returns true if this qualified name identifies a local class.
boolean	isOperation()
boolean	isUnnamedPackage()	Returns true if the class represented by this qualified name is in the unnamed package.
protected boolean	structurallyEquals(JavaQualifiedName qname)	Returns true if the given qname is identical to this qname.

Methods inherited from class net.sourceforge.pmd.lang.java.ast.JavaQualifiedName

equals, getClasses, getOperation, getPackages, hashCode, ofClass, ofString, toString

Methods inherited from class java.lang.Object

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

Method Detail

getClassName

public JavaTypeQualifiedName getClassName()

Specified by:

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

Specified by:

getClassName in class JavaQualifiedName

structurallyEquals

protected boolean structurallyEquals(JavaQualifiedName qname)

Description copied from class: JavaQualifiedName

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

Specified by:

structurallyEquals in class JavaQualifiedName

Parameters:

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

buildHashCode

protected int buildHashCode()

Description copied from class: JavaQualifiedName

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

Specified by:

buildHashCode in class JavaQualifiedName

isClass

public boolean isClass()

isOperation

public boolean isOperation()

isLocalClass

public boolean isLocalClass()

Returns true if this qualified name identifies a local class.

Overrides:

isLocalClass in class JavaQualifiedName

isAnonymousClass

public boolean isAnonymousClass()

Returns true if this qualified name identifies an anonymous class.

getClassSimpleName

public java.lang.String getClassSimpleName()

Get the simple name of the class.

Overrides:

getClassSimpleName in class JavaQualifiedName

isUnnamedPackage

public boolean isUnnamedPackage()

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

Overrides:

isUnnamedPackage in class JavaQualifiedName

getPackageList

public java.util.List<java.lang.String> getPackageList()

Returns the packages in outer-to-inner order. This is specific to Java's package structure. If the outer class is in the unnamed package, returns an empty list.

@NotNull

Returns:

The packages.

getClassList

public java.util.List<java.lang.String> getClassList()

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 list returned contains all enclosing classes in order, from outermost to innermost.

@NotNull

Returns:

The class names.

getType

public java.lang.Class<?> getType()

Gets the Class instance identified by this qualified name.

Returns:

A class instance, or null if the classloader threw a ClassNotFoundException

getBinaryName

public java.lang.String getBinaryName()

Returns the binary name of the type identified by this qualified name. The binary name can be used to load a Class using a ClassLoader. Contrary to this method, JavaQualifiedName.toString() is not guaranteed to return a binary name. For most purposes, you should avoid using this method directly and use getType() instead. Just don't build a dependency on the toString if you want a binary name.

Returns:

The binary name of the type identified by this qualified name

buildToString

protected java.lang.String buildToString()

Description copied from class: JavaQualifiedName

Construct the toString once. Called only once per instance

Specified by:

buildToString in class JavaQualifiedName