JavaPoet 1.13.0 · com.squareup.javapoet.ClassName

Field Summary

Modifier and Type	Field and Description
pack-priv final String	canonicalName The full class name like "java.util.Map.Entry".
pack-priv final ClassName	enclosingClassName The enclosing class, or null if this is not enclosed in another class.
private static final String	NO_PACKAGE The name representing the default Java package.
public static final ClassName	OBJECT Hides com.squareup.javapoet.TypeName.OBJECT.
pack-priv final String	packageName The package name of this class, or "" if this is in the default package.
pack-priv final String	simpleName This class name, like "Entry" for java.util.Map.Entry.
private List<String>	simpleNames

Inherited from com.squareup.javapoet.TypeName:: annotations BOOLEAN BYTE CHAR DOUBLE FLOAT INT LONG SHORT VOID

Constructor Summary

Access	Constructor and Description
private	ClassName(String packageName, ClassName enclosingClassName, String simpleName)
private	ClassName(String packageName, ClassName enclosingClassName, String simpleName, List<AnnotationSpec> annotations)

Method Summary

Modifier and Type	Method and Description
public ClassName	annotated(List<AnnotationSpec> annotations) Overrides com.squareup.javapoet.TypeName.annotated.
public static ClassName	bestGuess(String classNameString) Returns a new `ClassName` instance for the given fully-qualified class name string.
public String	canonicalName() Returns the full class name of this class.
public int	compareTo(ClassName the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
pack-priv CodeWriter	emit(CodeWriter out) Overrides com.squareup.javapoet.TypeName.emit.
private List<ClassName>	enclosingClasses() Returns all enclosing classes in this, outermost first.
public ClassName	enclosingClassName() Returns the enclosing class, like `Map` for `Map.Entry`.
public static ClassName	get(Class<?> clazz)
public static ClassName	get(String packageName, String simpleName, String... simpleNames) Returns a class name created from the given parts.
public static ClassName	get(TypeElement element) Returns the class name for `element`.
public boolean	isAnnotated() Overrides com.squareup.javapoet.TypeName.isAnnotated.
public ClassName	nestedClass(String name) Returns a new `ClassName` instance for the specified `name` as nested inside this class.
public String	packageName() Returns the package name, like `"java.util"` for `Map.Entry`.
public ClassName	peerClass(String name) Returns a class that shares the same enclosing package or class.
public String	reflectionName() Return the binary name of a class.
public String	simpleName() Returns the simple name of this class, like `"Entry"` for `Map.Entry`.
public List<String>	simpleNames()
public ClassName	topLevelClassName() Returns the top class in this nesting group.
public ClassName	withoutAnnotations() Overrides com.squareup.javapoet.TypeName.withoutAnnotations.

Inherited from com.squareup.javapoet.TypeName:: annotated arrayComponent asArray box concatAnnotations emitAnnotations equals get get get get hashCode isBoxedPrimitive isPrimitive list list toString unbox

Field Detail

canonicalName	back to summary
pack-priv final String canonicalName The full class name like "java.util.Map.Entry".

enclosingClassName	back to summary
pack-priv final ClassName enclosingClassName The enclosing class, or null if this is not enclosed in another class.

NO_PACKAGE	back to summary
private static final String NO_PACKAGE The name representing the default Java package.

OBJECT	back to summary
public static final ClassName OBJECT Hides com.squareup.javapoet.TypeName.OBJECT.

packageName	back to summary
pack-priv final String packageName The package name of this class, or "" if this is in the default package.

simpleName	back to summary
pack-priv final String simpleName This class name, like "Entry" for java.util.Map.Entry.

simpleNames	back to summary
private List<String> simpleNames

Constructor Detail

ClassName	back to summary
private ClassName(String packageName, ClassName enclosingClassName, String simpleName)

ClassName	back to summary
private ClassName(String packageName, ClassName enclosingClassName, String simpleName, List<AnnotationSpec> annotations)

Method Detail

annotated	back to summary
public ClassName annotated(List<AnnotationSpec> annotations) Overrides com.squareup.javapoet.TypeName.annotated. Annotations @Override

annotated

back to summary

public ClassName annotated(List<AnnotationSpec> annotations)

Overrides com.squareup.javapoet.TypeName.annotated.

Annotations

@Override

bestGuess back to summary

bestGuess	back to summary
public static ClassName bestGuess(String classNameString) Returns a new `ClassName` instance for the given fully-qualified class name string. This method assumes that the input is ASCII and follows typical Java style (lowercase package names, UpperCamelCase class names) and may produce incorrect results or throw `IllegalArgumentException` otherwise. For that reason, `get(Class)` and `get(Class)` should be preferred as they can correctly create `ClassName` instances without such restrictions.

public static ClassName bestGuess(String classNameString)

Returns a new ClassName instance for the given fully-qualified class name string. This method assumes that the input is ASCII and follows typical Java style (lowercase package names, UpperCamelCase class names) and may produce incorrect results or throw IllegalArgumentException otherwise. For that reason, get(Class) and get(Class) should be preferred as they can correctly create ClassName instances without such restrictions.

canonicalName	back to summary
public String canonicalName() Returns the full class name of this class. Like `"java.util.Map.Entry"` for `Map.Entry`.

compareTo back to summary

compareTo	back to summary
public int compareTo(ClassName o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:ClassName the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(ClassName o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:ClassName: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

emit	back to summary
pack-priv CodeWriter emit(CodeWriter out) throws IOException Overrides com.squareup.javapoet.TypeName.emit. Annotations @Override

emit

back to summary

pack-priv CodeWriter emit(CodeWriter out) throws IOException

Overrides com.squareup.javapoet.TypeName.emit.

Annotations

@Override

enclosingClasses	back to summary
private List<ClassName> enclosingClasses() Returns all enclosing classes in this, outermost first.

enclosingClassName	back to summary
public ClassName enclosingClassName() Returns the enclosing class, like `Map` for `Map.Entry`. Returns null if this class is not nested in another class.

get	back to summary
public static ClassName get(Class<?> clazz)

get	back to summary
public static ClassName get(String packageName, String simpleName, String... simpleNames) Returns a class name created from the given parts. For example, calling this with package name `"java.util"` and simple names `"Map"`, `"Entry"` yields `Map.Entry`.

get	back to summary
public static ClassName get(TypeElement element) Returns the class name for `element`.

isAnnotated	back to summary
public boolean isAnnotated() Overrides com.squareup.javapoet.TypeName.isAnnotated. Annotations @Override

isAnnotated

back to summary

public boolean isAnnotated()

Overrides com.squareup.javapoet.TypeName.isAnnotated.

Annotations

@Override

nestedClass	back to summary
public ClassName nestedClass(String name) Returns a new `ClassName` instance for the specified `name` as nested inside this class.

packageName	back to summary
public String packageName() Returns the package name, like `"java.util"` for `Map.Entry`. Returns the empty string for the default package.

peerClass	back to summary
public ClassName peerClass(String name) Returns a class that shares the same enclosing package or class. If this class is enclosed by another class, this is equivalent to `enclosingClassName().nestedClass(name)`. Otherwise it is equivalent to `get(packageName(), name)`.

reflectionName	back to summary
public String reflectionName() Return the binary name of a class.

simpleName	back to summary
public String simpleName() Returns the simple name of this class, like `"Entry"` for `Map.Entry`.

simpleNames	back to summary
public List<String> simpleNames()

topLevelClassName	back to summary
public ClassName topLevelClassName() Returns the top class in this nesting group. Equivalent to chained calls to `enclosingClassName()` until the result's enclosing class is null.

withoutAnnotations	back to summary
public ClassName withoutAnnotations() Overrides com.squareup.javapoet.TypeName.withoutAnnotations. Annotations @Override

withoutAnnotations

back to summary

public ClassName withoutAnnotations()

Overrides com.squareup.javapoet.TypeName.withoutAnnotations.

Annotations

@Override

public final Class ClassName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail