com.thomasjensen.checkstyle.addons.checks

Class BinaryName

java.lang.Object

com.thomasjensen.checkstyle.addons.checks.BinaryName

@Immutable
public final class BinaryName
extends java.lang.Object

Represents a Java binary class name for reference types, in the form of its fragments. This is the only way to tell the difference between a class called A$B and a class called A that has an inner class B.

Constructor Summary

Constructors

Constructor and Description
BinaryName(java.lang.String pPkg, java.util.Collection<java.lang.String> pClsNames) Constructor.
BinaryName(java.lang.String pPkg, java.lang.String pOuterCls, java.lang.String... pInnerCls) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pOther)
java.lang.String	getInnerSimpleName() Getter.
java.lang.String	getOuterFqcn() The fully qualified name of the outer class.
java.lang.String	getOuterSimpleName() Getter.
java.lang.String	getPackage()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryName

public BinaryName(@Nullable
                  java.lang.String pPkg,
                  @Nonnull
                  java.util.Collection<java.lang.String> pClsNames)

Constructor.

Parameters:

pPkg - package name

pClsNames - class simple names in descending order of their nesting

BinaryName

public BinaryName(@Nullable
                  java.lang.String pPkg,
                  @Nonnull
                  java.lang.String pOuterCls,
                  @Nullable
                  java.lang.String... pInnerCls)

Constructor.

Parameters:

pPkg - package name

pOuterCls - outer class simple name

pInnerCls - inner class simple names in descending order of their nesting

Method Detail

equals

public boolean equals(java.lang.Object pOther)

Overrides:

equals in class java.lang.Object

getInnerSimpleName

public java.lang.String getInnerSimpleName()

Getter.

Returns:

the simple name of the inner class represented by this binary name. null if this binary name does not represent an inner class

getOuterFqcn

@CheckForNull
public java.lang.String getOuterFqcn()

The fully qualified name of the outer class.

Returns:

that, or null if the simple name of the outer class is unknown

getOuterSimpleName

public java.lang.String getOuterSimpleName()

Getter.

Returns:

the simple name of the outer class (even if this binary name represents an inner class)

getPackage

public java.lang.String getPackage()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object