Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class ClassNameImpl

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.TypeNameImpl

org.tquadrat.foundation.javacomposer.internal.ClassNameImpl

All Implemented Interfaces:

Comparable<ClassName>, ClassName, TypeName

@ClassVersion(sourceVersion="$Id: ClassNameImpl.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public final class ClassNameImpl
extends TypeNameImpl
implements ClassName

The implementation of ClassName for a fully-qualified class name for top-level and member classes.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ClassNameImpl.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.ClassNameImpl"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final ClassNameImpl	BOXED_BOOLEAN	The class name for Boolean.
static final ClassNameImpl	BOXED_BYTE	The class name for Byte.
static final ClassNameImpl	BOXED_CHAR	The class name for Character.
static final ClassNameImpl	BOXED_DOUBLE	The class name for Double.
static final ClassNameImpl	BOXED_FLOAT	The class name for Float.
static final ClassNameImpl	BOXED_INT	The class name for Integer.
static final ClassNameImpl	BOXED_LONG	The class name for Long.
static final ClassNameImpl	BOXED_SHORT	The class name for Short.
static final ClassNameImpl	BOXED_VOID	The class name for Void.
private final String	m_CanonicalName	The full class name like java.util.Map.Entry.
private final Optional<ClassNameImpl>	m_EnclosingClassName	The enclosing class, or empty if this is not enclosed in another class.
private final String	m_PackageName	The package name of this class, or the empty String if this is in the default package.
private final String	m_SimpleName	The name for this class name, like Entry for java.util.Map.Entry.
static final ClassNameImpl	OBJECT	The class name for Object.

Fields inherited from class org.tquadrat.foundation.javacomposer.internal.TypeNameImpl

BOOLEAN_PRIMITIVE, BYTE_PRIMITIVE, CHAR_PRIMITIVE, DOUBLE_PRIMITIVE, FLOAT_PRIMITIVE, INT_PRIMITIVE, LONG_PRIMITIVE, SHORT_PRIMITIVE, VOID_PRIMITIVE

Constructor Summary

Constructors

Constructor	Description
ClassNameImpl(CharSequence packageName, Optional<ClassNameImpl> enclosingClassName, CharSequence simpleName)	Creates a new ClassNameImpl instance.
ClassNameImpl(CharSequence packageName, Optional<ClassNameImpl> enclosingClassName, CharSequence simpleName, List<AnnotationSpecImpl> annotations)	Creates a new ClassNameImpl instance.
ClassNameImpl(CharSequence packageName, ClassNameImpl enclosingClassName, CharSequence simpleName)	Creates a new ClassNameImpl instance.
ClassNameImpl(CharSequence packageName, ClassNameImpl enclosingClassName, CharSequence simpleName, List<AnnotationSpecImpl> annotations)	Creates a new ClassNameImpl instance.

Method Summary

Modifier and Type	Method	Description
final ClassNameImpl	annotated(List<AnnotationSpec> annotations)	Creates a new instance for an implementation of TypeName as a copy of this one, but with the given annotations added.
final String	canonicalName()	Returns the canonical form of the class name.
final int	compareTo(ClassName o)
final CodeWriter	emit(CodeWriter out)	Emits this type name instance to the given CodeWriter.
private final List<ClassNameImpl>	enclosingClasses()	Returns all enclosing classes in this, outermost first.
final Optional<ClassNameImpl>	enclosingClassName()	Returns the enclosing class, like Map for java.util.Map.Entry.
static final ClassNameImpl	from(CharSequence packageName, CharSequence simpleName, CharSequence... simpleNames)	Returns a class name created from the given parts. For example, calling this method with package name "java.util" and simple names "Map" and "Entry" yields java.util.Map.Entry.
static final ClassNameImpl	from(Class<?> sourceClass)	Creates a new ClassName instance from an instance of Class.
static final ClassNameImpl	from(TypeElement element)	Returns the class name for the given TypeElement instance.
final boolean	isAnnotated()	Checks whether this type name is annotated.
final ClassNameImpl	nestedClass(CharSequence name)	Returns a new instance for an implementation of ClassName for the specified name as nested inside this class.
final String	packageName()	Returns the package name, like java.util for java.util.Map.Entry.
final Optional<ClassName>	parentClass()	Returns the enclosing class, like Map for java.util.Map.Entry.
final ClassNameImpl	peerClass(CharSequence name)	Creates a class that shares the same enclosing package or class.
final String	reflectionName()	Returns the binary name of a class, as used by reflection.
final String	simpleName()	Returns the simple name of this class, like Entry for java.util.Map.Entry.
final List<String>	simpleNames()	Returns a list of the simple names for this nesting group.
final ClassNameImpl	topLevelClassName()	Returns the top class in this nesting group.
final ClassNameImpl	withoutAnnotations()	Creates a new instance for an implementation of TypeName as a copy of this one, but without any annotations.

Methods inherited from class org.tquadrat.foundation.javacomposer.internal.TypeNameImpl

annotations, asArray, box, concatAnnotations, emitAnnotations, equals, from, from, from, from, hashCode, isBoxedPrimitive, isPrimitive, list, list, toString, unbox

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tquadrat.foundation.javacomposer.ClassName

equals

Methods inherited from interface org.tquadrat.foundation.javacomposer.TypeName

annotated, box, hashCode, isBoxedPrimitive, isPrimitive, toString, unbox

Field Details

BOXED_BOOLEAN

public static final ClassNameImpl BOXED_BOOLEAN

The class name for Boolean.

BOXED_BYTE

public static final ClassNameImpl BOXED_BYTE

The class name for Byte.

BOXED_CHAR

public static final ClassNameImpl BOXED_CHAR

The class name for Character.

BOXED_DOUBLE

public static final ClassNameImpl BOXED_DOUBLE

The class name for Double.

BOXED_FLOAT

public static final ClassNameImpl BOXED_FLOAT

The class name for Float.

BOXED_INT

public static final ClassNameImpl BOXED_INT

The class name for Integer.

BOXED_LONG

public static final ClassNameImpl BOXED_LONG

The class name for Long.

BOXED_SHORT

public static final ClassNameImpl BOXED_SHORT

The class name for Short.

BOXED_VOID

public static final ClassNameImpl BOXED_VOID

The class name for Void.

OBJECT

public static final ClassNameImpl OBJECT

The class name for Object.

m_CanonicalName

private final String m_CanonicalName

The full class name like java.util.Map.Entry.

m_EnclosingClassName

private final Optional<ClassNameImpl> m_EnclosingClassName

The enclosing class, or empty if this is not enclosed in another class.

m_PackageName

private final String m_PackageName

The package name of this class, or the empty String if this is in the default package.

m_SimpleName

private final String m_SimpleName

The name for this class name, like Entry for java.util.Map.Entry.

Constructor Details

ClassNameImpl

public ClassNameImpl(CharSequence packageName,
 ClassNameImpl enclosingClassName,
 CharSequence simpleName)

Creates a new ClassNameImpl instance.

Parameters:

packageName - The name of the package for the new class name.

enclosingClassName - The name of the enclosing class; can be null in case of a top level class.

simpleName - The name of the class.

ClassNameImpl

public ClassNameImpl(CharSequence packageName,
 Optional<ClassNameImpl> enclosingClassName,
 CharSequence simpleName)

Creates a new ClassNameImpl instance.

Parameters:

packageName - The name of the package for the new class name.

enclosingClassName - The name of the enclosing class; can be empty in case of a top level class.

simpleName - The name of the class.

ClassNameImpl

public ClassNameImpl(CharSequence packageName,
 ClassNameImpl enclosingClassName,
 CharSequence simpleName,
 List<AnnotationSpecImpl> annotations)

Creates a new ClassNameImpl instance.

Parameters:

packageName - The name of the package for the new class name.

enclosingClassName - The name of the enclosing class; can be null in case of a top level class.

simpleName - The name of the class.

annotations - The annotations for this class name.

ClassNameImpl

public ClassNameImpl(CharSequence packageName,
 Optional<ClassNameImpl> enclosingClassName,
 CharSequence simpleName,
 List<AnnotationSpecImpl> annotations)

Creates a new ClassNameImpl instance.

Parameters:

packageName - The name of the package for the new class name.

enclosingClassName - The name of the enclosing class.

simpleName - The name of the class.

annotations - The annotations for this class name.

Method Details

annotated

public final ClassNameImpl annotated(List<AnnotationSpec> annotations)

Creates a new instance for an implementation of TypeName as a copy of this one, but with the given annotations added.

Specified by:

annotated in interface ClassName

Specified by:

annotated in interface TypeName

Overrides:

annotated in class TypeNameImpl

Parameters:

annotations - The annotations.

Returns:

The new instance.

compareTo

public final int compareTo(ClassName o)

Specified by:

compareTo in interface ClassName

Specified by:

compareTo in interface Comparable<ClassName>

canonicalName

public final String canonicalName()

Returns the canonical form of the class name.

Specified by:

canonicalName in interface ClassName

Returns:

The canonical name.

emit

public final CodeWriter emit(CodeWriter out)
                      throws UncheckedIOException

Emits this type name instance to the given CodeWriter.

Overrides:

emit in class TypeNameImpl

Parameters:

out - The code writer.

Returns:

The code writer.

Throws:

UncheckedIOException - Something went wrong when emitting to the output target.

enclosingClasses

private final List<ClassNameImpl> enclosingClasses()

Returns all enclosing classes in this, outermost first.

Returns:

The enclosing classes.

enclosingClassName

public final Optional<ClassNameImpl> enclosingClassName()

Returns the enclosing class, like Map for java.util.Map.Entry. The return value will be empty if this class is not nested in another class.

Returns:

An instance of Optional that holds the name of the enclosing class.

from

@API(status=STABLE,
     since="0.2.0")
public static final ClassNameImpl from(Class<?> sourceClass)

Creates a new ClassName instance from an instance of Class.

Parameters:

sourceClass - The instance of java.lang.Class.

Returns:

The respective instance of ClassName.

from

@API(status=STABLE,
     since="0.2.0")
public static final ClassNameImpl from(TypeElement element)

Returns the class name for the given TypeElement instance.

Parameters:

element - The type element instance.

Returns:

The new class name instance.

from

@API(status=STABLE,
     since="0.2.0")
public static final ClassNameImpl from(CharSequence packageName,
 CharSequence simpleName,
 CharSequence... simpleNames)

Returns a class name created from the given parts.

For example, calling this method with package name "java.util" and simple names "Map" and "Entry" yields java.util.Map.Entry.

Parameters:

packageName - The package name.

simpleName - The name of the top-level class.

simpleNames - The names of the nested classes, from outer to inner.

Returns:

The new ClassName instance.

isAnnotated

public final boolean isAnnotated()

Checks whether this type name is annotated.

Specified by:

isAnnotated in interface ClassName

Specified by:

isAnnotated in interface TypeName

Overrides:

isAnnotated in class TypeNameImpl

Returns:

true if it is annotated, false otherwise.

nestedClass

public final ClassNameImpl nestedClass(CharSequence name)

Returns a new instance for an implementation of ClassName for the specified name as nested inside this class.

Specified by:

nestedClass in interface ClassName

Parameters:

name - The name for the new nested class.

Returns:

The new instance.

packageName

public final String packageName()

Returns the package name, like java.util for java.util.Map.Entry. Returns the empty String for the default package.

Specified by:

packageName in interface ClassName

Returns:

The package name.

parentClass

public final Optional<ClassName> parentClass()

Returns the enclosing class, like Map for java.util.Map.Entry. The return value will be empty if this class is not nested in another class.

Specified by:

parentClass in interface ClassName

Returns:

An instance of Optional that holds the name of the enclosing class.

peerClass

public final ClassNameImpl peerClass(CharSequence name)

Creates a class that shares the same enclosing package or class. If this class is enclosed by another class, this is equivalent to enclosingClassName().Optional.get().nestedClass(name). Otherwise, it is equivalent to get(packageName(),name).

Specified by:

peerClass in interface ClassName

Parameters:

name - The name of the peer class to create.

Returns:

The new instance for the peer class.

reflectionName

public final String reflectionName()

Returns the binary name of a class, as used by reflection.

Specified by:

reflectionName in interface ClassName

Returns:

The binary name.

simpleName

public final String simpleName()

Returns the simple name of this class, like Entry for java.util.Map.Entry.

Specified by:

simpleName in interface ClassName

Returns:

The simple name.

simpleNames

public final List<String> simpleNames()

Returns a list of the simple names for this nesting group.

Specified by:

simpleNames in interface ClassName

Returns:

The simple names.

topLevelClassName

public final ClassNameImpl topLevelClassName()

Returns the top class in this nesting group. Equivalent to chained calls to enclosingClassName() until the result's enclosing class is not present.

Specified by:

topLevelClassName in interface ClassName

Returns:

The name of the top level class.

withoutAnnotations

public final ClassNameImpl withoutAnnotations()

Creates a new instance for an implementation of TypeName as a copy of this one, but without any annotations.

Specified by:

withoutAnnotations in interface ClassName

Specified by:

withoutAnnotations in interface TypeName

Overrides:

withoutAnnotations in class TypeNameImpl

Returns:

The new instance.