net.sf.mmm.util.reflect.api

Class ClassName

java.lang.Object

net.sf.mmm.util.reflect.api.ClassName

public class ClassName
extends Object

This is a simple identifier for a Class. Unlike Class it can also identify non existent classes (e.g. that should be generated). On the other hand passing the qualified classname as String around for such purpose may lead to additional parsing e.g. to extract the simple name.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private ClassName	enclosingClass
private String	packageName
private String	simpleName

Constructor Summary

Constructors

Constructor and Description
ClassName(Class<?> type) The constructor.
ClassName(String packageName, String simpleName) The constructor.
ClassName(String packageName, String simpleName, ClassName enclosingClass) The constructor.

Method Summary

Modifier and Type	Method and Description
private void	appendEnclosing(StringBuilder buffer, char enclosingSeparator, ClassName enclosing) Appends the enclosing class in proper order (reverse hierarchy).
boolean	equals(Object obj)
String	getCanonicalName()
ClassName	getEnclosingClass()
String	getName()
private String	getName(char enclosingSeparator)
String	getPackageName()
String	getSimpleName()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

packageName

private final String packageName

enclosingClass

private final ClassName enclosingClass

simpleName

private final String simpleName

Constructor Detail

ClassName

public ClassName(String packageName,
                 String simpleName)

The constructor.

Parameters:

packageName - - see getPackageName().

simpleName - - see getSimpleName().

ClassName

public ClassName(String packageName,
                 String simpleName,
                 ClassName enclosingClass)

The constructor.

Parameters:

packageName - - see getPackageName().

simpleName - - see getSimpleName().

enclosingClass - - see getEnclosingClass().

ClassName

public ClassName(Class<?> type)

The constructor.

Parameters:

type - is the Class to represent.

Method Detail

getPackageName

public String getPackageName()

Returns:

the name of the Package of the Class.

getEnclosingClass

public ClassName getEnclosingClass()

Returns:

the enclosing ClassName or null if for a top-level Class.

getSimpleName

public String getSimpleName()

Returns:

the simple name of the Class.

getName

public String getName()

Returns:

the name of the Class.

getCanonicalName

public String getCanonicalName()

Returns:

the canonical name of the Class.

getName

private String getName(char enclosingSeparator)

Parameters:

enclosingSeparator - the separator for enclosing types ('.' or '$').

Returns:

the qualified name.

appendEnclosing

private void appendEnclosing(StringBuilder buffer,
                             char enclosingSeparator,
                             ClassName enclosing)

Appends the enclosing class in proper order (reverse hierarchy).

Parameters:

buffer - the StringBuilder to append to.

enclosingSeparator - the separator for enclosing types ('.' or '$').

enclosing - the enclosing class.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object