Package com.squareup.javapoet
Class ClassName
java.lang.Object
com.squareup.javapoet.TypeName
com.squareup.javapoet.ClassName
- All Implemented Interfaces:
Comparable<ClassName>
A fully-qualified class name for top-level and member classes.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionannotated
(List<AnnotationSpec> annotations) static ClassName
Returns a newClassName
instance for the given fully-qualified class name string.int
(package private) CodeWriter
emit
(CodeWriter out) Returns the enclosing class, likeMap
forMap.Entry
.static ClassName
static ClassName
Returns a class name created from the given parts.static ClassName
get
(TypeElement element) Returns the class name forelement
.private static PackageElement
getPackage
(Element type) private static boolean
nestedClass
(String name) Returns a newClassName
instance for the specifiedname
as nested inside this class.Returns the package name, like"java.util"
forMap.Entry
.Returns a class that shares the same enclosing package or class.Returns the simple name of this class, like"Entry"
forMap.Entry
.Returns the top class in this nesting group.Methods inherited from class com.squareup.javapoet.TypeName
annotated, arrayComponent, box, concatAnnotations, emitAnnotations, equals, get, get, get, get, hashCode, isAnnotated, isBoxedPrimitive, isPrimitive, list, list, toString, unbox
-
Field Details
-
OBJECT
-
names
From top to bottom. This will be ["java.util", "Map", "Entry"] forMap.Entry
. -
canonicalName
-
-
Constructor Details
-
ClassName
-
ClassName
-
-
Method Details
-
annotated
-
withoutAnnotations
- Overrides:
withoutAnnotations
in classTypeName
-
packageName
Returns the package name, like"java.util"
forMap.Entry
. -
enclosingClassName
Returns the enclosing class, likeMap
forMap.Entry
. Returns null if this class is not nested in another class. -
topLevelClassName
Returns the top class in this nesting group. Equivalent to chained calls toenclosingClassName()
until the result's enclosing class is null. -
nestedClass
Returns a newClassName
instance for the specifiedname
as nested inside this class. -
simpleNames
-
peerClass
Returns a class that shares the same enclosing package or class. If this class is enclosed by another class, this is equivalent toenclosingClassName().nestedClass(name)
. Otherwise it is equivalent toget(packageName(), name)
. -
simpleName
Returns the simple name of this class, like"Entry"
forMap.Entry
. -
get
-
bestGuess
Returns a newClassName
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 throwIllegalArgumentException
otherwise. For that reason,get(Class)
andget(Class)
should be preferred as they can correctly createClassName
instances without such restrictions. -
get
Returns a class name created from the given parts. For example, calling this with package name"java.util"
and simple names"Map"
,"Entry"
yieldsMap.Entry
. -
get
Returns the class name forelement
. -
isClassOrInterface
-
getPackage
-
compareTo
- Specified by:
compareTo
in interfaceComparable<ClassName>
-
emit
- Overrides:
emit
in classTypeName
- Throws:
IOException
-