TypeName (JavaPoet 1.13.0 API)

java.lang.Object
- com.squareup.javapoet.TypeName

Direct Known Subclasses:

ArrayTypeName, ClassName, ParameterizedTypeName, TypeVariableName, WildcardTypeName
```
public class TypeName
extends java.lang.Object
```
Any type in Java's type system, plus void. This class is an identifier for primitive types like int and raw reference types like String and List. It also identifies composite types like char[] and Set<Long>.
Type names are dumb identifiers only and do not model the values they name. For example, the type name for java.util.List doesn't know about the size() method, the fact that lists are collections, or even that it accepts a single type parameter.
Instances of this class are immutable value objects that implement equals() and hashCode() properly.
Referencing existing types

Primitives and void are constants that you can reference directly: see INT, DOUBLE, and VOID.
In an annotation processor you can get a type name instance for a type mirror by calling get(TypeMirror). In reflection code, you can use get(Type).
Defining new types

Create new reference types like com.example.HelloWorld with ClassName.get(String, String, String...). To build composite types like char[] and Set<Long>, use the factory methods on ArrayTypeName, ParameterizedTypeName, TypeVariableName, and WildcardTypeName.

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.List<AnnotationSpec>`	`annotations`
`static TypeName`	`BOOLEAN`
`static TypeName`	`BYTE`
`static TypeName`	`CHAR`
`static TypeName`	`DOUBLE`
`static TypeName`	`FLOAT`
`static TypeName`	`INT`
`static TypeName`	`LONG`
`static ClassName`	`OBJECT`
`static TypeName`	`SHORT`
`static TypeName`	`VOID`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TypeName`	`annotated(AnnotationSpec... annotations)`
`TypeName`	`annotated(java.util.List<AnnotationSpec> annotations)`
`TypeName`	`box()` Returns a boxed type if this is a primitive type (like `Integer` for `int`) or `void`.
`protected java.util.List<AnnotationSpec>`	`concatAnnotations(java.util.List<AnnotationSpec> annotations)`
`boolean`	`equals(java.lang.Object o)`
`static TypeName`	`get(java.lang.reflect.Type type)` Returns a type name equivalent to `type`.
`static TypeName`	`get(javax.lang.model.type.TypeMirror mirror)` Returns a type name equivalent to `mirror`.
`int`	`hashCode()`
`boolean`	`isAnnotated()`
`boolean`	`isBoxedPrimitive()` Returns true if this is a boxed primitive type like `Integer`.
`boolean`	`isPrimitive()` Returns true if this is a primitive type like `int`.
`java.lang.String`	`toString()`
`TypeName`	`unbox()` Returns an unboxed type if this is a boxed primitive type (like `int` for `Integer`) or `Void`.
`TypeName`	`withoutAnnotations()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VOID
```
public static final TypeName VOID
```

BOOLEAN
```
public static final TypeName BOOLEAN
```

BYTE
```
public static final TypeName BYTE
```

SHORT
```
public static final TypeName SHORT
```

INT
```
public static final TypeName INT
```

LONG
```
public static final TypeName LONG
```

CHAR
```
public static final TypeName CHAR
```

FLOAT
```
public static final TypeName FLOAT
```

DOUBLE
```
public static final TypeName DOUBLE
```

OBJECT
```
public static final ClassName OBJECT
```

annotations

public final java.util.List<AnnotationSpec> annotations

Method Detail
- annotated
```
public final TypeName annotated(AnnotationSpec... annotations)
```
- annotated
```
public TypeName annotated(java.util.List<AnnotationSpec> annotations)
```
- withoutAnnotations
```
public TypeName withoutAnnotations()
```
- concatAnnotations
```
protected final java.util.List<AnnotationSpec> concatAnnotations(java.util.List<AnnotationSpec> annotations)
```
- isAnnotated
```
public boolean isAnnotated()
```
- isPrimitive
```
public boolean isPrimitive()
```
  Returns true if this is a primitive type like int. Returns false for all other types types including boxed primitives and void.
- isBoxedPrimitive
```
public boolean isBoxedPrimitive()
```
  Returns true if this is a boxed primitive type like Integer. Returns false for all other types types including unboxed primitives and java.lang.Void.
- box
```
public TypeName box()
```
  Returns a boxed type if this is a primitive type (like Integer for int) or void. Returns this type if boxing doesn't apply.
- unbox
```
public TypeName unbox()
```
  Returns an unboxed type if this is a boxed primitive type (like int for Integer) or Void. Returns this type if it is already unboxed.
  
  Throws:
  
  java.lang.UnsupportedOperationException - if this type isn't eligible for unboxing.
- equals
```
public final boolean equals(java.lang.Object o)
```
  Overrides:
  
  equals in class java.lang.Object
- hashCode
```
public final int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- toString
```
public final java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object
- get
```
public static TypeName get(javax.lang.model.type.TypeMirror mirror)
```
  Returns a type name equivalent to mirror.
- get
```
public static TypeName get(java.lang.reflect.Type type)
```
  Returns a type name equivalent to type.

Class TypeName

Referencing existing types

Defining new types

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VOID

BOOLEAN

BYTE

SHORT

INT

LONG

CHAR

FLOAT

DOUBLE

OBJECT

annotations

Method Detail

annotated

annotated

withoutAnnotations

concatAnnotations

isAnnotated

isPrimitive

isBoxedPrimitive

box

unbox

equals

hashCode

toString

get

get