Encodes types so they can later be decoded to incorporate imports.

The idea is that types that appear in generated source code use encode, which will spell out a type like java.util.List<? extends java.lang.Number>, except that wherever a class name appears it is replaced by a special token. So the spelling might actually be `java.util.List`<? extends `java.lang.Number`>. Then once the entire class has been generated, #decode scans for these tokens to determine what classes need to be imported, and replaces the tokens with the correct spelling given the imports. So here, java.util.List would be imported, and the final spelling would be List<? extends Number> (knowing that Number is implicitly imported). The special token `import` marks where the imports should be, and decode replaces it with the correct list of imports.

The funky syntax for type annotations on qualified type names requires an adjustment to this scheme. `«java.util.Map` stands for java.util. and `»java.util.Map` stands for Map. If java.util.Map is imported, then `«java.util.Map` will eventually be empty, but if java.util.Map is not imported (perhaps because there is another Map in scope) then `«java.util.Map` will be java.util.. The end result is that the code can contain `«java.util.Map`@`javax.annotation.Nullable` `»java.util.Map`. That might decode to @Nullable Map or to java.util.@Nullable Map or even to java.util.@javax.annotation.Nullable Map.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	TypeEncoder.AnnotatedEncodingTypeVisitor Like `EncodingTypeVisitor` except that annotations on the visited type are also included in the resultant string.
private static class	TypeEncoder.EncodingTypeVisitor Converts a type into a string, using standard Java syntax, except that every class name is wrapped in backquotes, like `java.util.List`.
private static class	TypeEncoder.RawEncodingTypeVisitor Like `EncodingTypeVisitor` except that type parameters are omitted from the result.
private static class	TypeEncoder.TypeRewriter

Field Summary

Modifier and Type	Field and Description
private static final TypeEncoder.EncodingTypeVisitor	ENCODING_TYPE_VISITOR
private static final TypeEncoder.RawEncodingTypeVisitor	RAW_ENCODING_TYPE_VISITOR

Constructor Summary

Access	Constructor and Description
private	TypeEncoder()

Method Summary

Modifier and Type	Method and Description
private static void	appendAnnotations(List<? extends javax.lang.model.element.AnnotationMirror> annotationMirrors, StringBuilder sb)
private static void	appendTypeParameterWithBounds(javax.lang.model.element.TypeParameterElement typeParameter, StringBuilder sb)
private static String	className(javax.lang.model.type.DeclaredType declaredType)
pack-priv static String	decode(String the text to be decoded. text, javax.annotation.processing.ProcessingEnvironment processingEnv, String the package of the generated class. Other classes in the same package do not need to be imported. packageName, javax.lang.model.type.TypeMirror a class or interface that the generated class inherits from. Nested classes in that type do not need to be imported, and if another class has the same name as one of those nested classes then it will need to be qualified. baseType) Decodes the given string, respelling class names appropriately.
pack-priv static String	decode(String text, javax.lang.model.util.Elements elementUtils, javax.lang.model.util.Types typeUtils, String pkg, javax.lang.model.type.TypeMirror baseType)
pack-priv static String	encode(javax.lang.model.type.TypeMirror type) Returns the encoding for the given type, where class names are marked by special tokens.
pack-priv static String	encodeRaw(javax.lang.model.type.TypeMirror type) Like `encode`, except that only the raw type is encoded.
pack-priv static String	encodeWithAnnotations(javax.lang.model.type.TypeMirror type) Encodes the given type and its type annotations.
pack-priv static String	encodeWithAnnotations(javax.lang.model.type.TypeMirror type, ImmutableList<javax.lang.model.element.AnnotationMirror> additional type annotations to include with the type extraAnnotations) Encodes the given type and its type annotations.
pack-priv static String	encodeWithAnnotations(javax.lang.model.type.TypeMirror type, ImmutableList<javax.lang.model.element.AnnotationMirror> additional type annotations to include with the type extraAnnotations, Set<javax.lang.model.type.TypeMirror> annotations not to include in the encoding. For example, if `com.example.Nullable` is in this set then the encoding will not include this `@Nullable` annotation. excludedAnnotationTypes) Encodes the given type and its type annotations.
private static boolean	isUnannotatedJavaLangObject(javax.lang.model.type.TypeMirror type)
pack-priv static String	typeParametersString(List<? extends javax.lang.model.element.TypeParameterElement> typeParameters) Returns a string representing the given type parameters as they would appear in a class declaration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ENCODING_TYPE_VISITOR	back to summary
private static final TypeEncoder.EncodingTypeVisitor ENCODING_TYPE_VISITOR

RAW_ENCODING_TYPE_VISITOR	back to summary
private static final TypeEncoder.RawEncodingTypeVisitor RAW_ENCODING_TYPE_VISITOR

Constructor Detail

TypeEncoder	back to summary
private TypeEncoder()

Method Detail

appendAnnotations	back to summary
private static void appendAnnotations(List<? extends javax.lang.model.element.AnnotationMirror> annotationMirrors, StringBuilder sb)

appendTypeParameterWithBounds	back to summary
private static void appendTypeParameterWithBounds(javax.lang.model.element.TypeParameterElement typeParameter, StringBuilder sb)

className	back to summary
private static String className(javax.lang.model.type.DeclaredType declaredType)

decode back to summary

decode	back to summary
pack-priv static String decode(String text, javax.annotation.processing.ProcessingEnvironment processingEnv, String packageName, javax.lang.model.type.TypeMirror baseType) Decodes the given string, respelling class names appropriately. The text is scanned for tokens like `java.util.Locale` or `«java.util.Locale` to determine which classes are referenced. An appropriate set of imports is computed based on the set of those types. If the special token `import` appears in `text` then it will be replaced by this set of import statements. Then all of the tokens are replaced by the class names they represent, spelled appropriately given the import statements. Parameters text:String the text to be decoded. packageName:String the package of the generated class. Other classes in the same package do not need to be imported. baseType:javax.lang.model.type.TypeMirror a class or interface that the generated class inherits from. Nested classes in that type do not need to be imported, and if another class has the same name as one of those nested classes then it will need to be qualified.

pack-priv static String decode(String text, javax.annotation.processing.ProcessingEnvironment processingEnv, String packageName, javax.lang.model.type.TypeMirror baseType)

Decodes the given string, respelling class names appropriately. The text is scanned for tokens like `java.util.Locale` or `«java.util.Locale` to determine which classes are referenced. An appropriate set of imports is computed based on the set of those types. If the special token `import` appears in text then it will be replaced by this set of import statements. Then all of the tokens are replaced by the class names they represent, spelled appropriately given the import statements.

Parameters

text:String: the text to be decoded.
packageName:String: the package of the generated class. Other classes in the same package do not need to be imported.
baseType:javax.lang.model.type.TypeMirror: a class or interface that the generated class inherits from. Nested classes in that type do not need to be imported, and if another class has the same name as one of those nested classes then it will need to be qualified.

decode	back to summary
pack-priv static String decode(String text, javax.lang.model.util.Elements elementUtils, javax.lang.model.util.Types typeUtils, String pkg, javax.lang.model.type.TypeMirror baseType)

encode	back to summary
pack-priv static String encode(javax.lang.model.type.TypeMirror type) Returns the encoding for the given type, where class names are marked by special tokens. The encoding for `int` will be `int`, but the encoding for `java.util.List<java.lang.Integer>` will be `java.util.List`<`java.lang.Integer`>.

encodeRaw	back to summary
pack-priv static String encodeRaw(javax.lang.model.type.TypeMirror type) Like `encode`, except that only the raw type is encoded. So if the given type is `java.util.List<java.lang.Integer>` the result will be `java.util.List`.

encodeWithAnnotations	back to summary
pack-priv static String encodeWithAnnotations(javax.lang.model.type.TypeMirror type) Encodes the given type and its type annotations. The class comment for `TypeEncoder` covers the details of annotation encoding.

encodeWithAnnotations back to summary

encodeWithAnnotations	back to summary
pack-priv static String encodeWithAnnotations(javax.lang.model.type.TypeMirror type, ImmutableList<javax.lang.model.element.AnnotationMirror> extraAnnotations) Encodes the given type and its type annotations. The class comment for `TypeEncoder` covers the details of annotation encoding. Parameters extraAnnotations:ImmutableList<javax.lang.model.element.AnnotationMirror> additional type annotations to include with the type

pack-priv static String encodeWithAnnotations(javax.lang.model.type.TypeMirror type, ImmutableList<javax.lang.model.element.AnnotationMirror> extraAnnotations)

Encodes the given type and its type annotations. The class comment for TypeEncoder covers the details of annotation encoding.

Parameters

extraAnnotations:ImmutableList<javax.lang.model.element.AnnotationMirror>: additional type annotations to include with the type

encodeWithAnnotations back to summary

encodeWithAnnotations	back to summary
pack-priv static String encodeWithAnnotations(javax.lang.model.type.TypeMirror type, ImmutableList<javax.lang.model.element.AnnotationMirror> extraAnnotations, Set<javax.lang.model.type.TypeMirror> excludedAnnotationTypes) Encodes the given type and its type annotations. The class comment for `TypeEncoder` covers the details of annotation encoding. Parameters extraAnnotations:ImmutableList<javax.lang.model.element.AnnotationMirror> additional type annotations to include with the type excludedAnnotationTypes:Set<javax.lang.model.type.TypeMirror> annotations not to include in the encoding. For example, if `com.example.Nullable` is in this set then the encoding will not include this `@Nullable` annotation.

pack-priv static String encodeWithAnnotations(javax.lang.model.type.TypeMirror type, ImmutableList<javax.lang.model.element.AnnotationMirror> extraAnnotations, Set<javax.lang.model.type.TypeMirror> excludedAnnotationTypes)

Encodes the given type and its type annotations. The class comment for TypeEncoder covers the details of annotation encoding.

Parameters

extraAnnotations:ImmutableList<javax.lang.model.element.AnnotationMirror>: additional type annotations to include with the type
excludedAnnotationTypes:Set<javax.lang.model.type.TypeMirror>: annotations not to include in the encoding. For example, if com.example.Nullable is in this set then the encoding will not include this @Nullable annotation.

isUnannotatedJavaLangObject	back to summary
private static boolean isUnannotatedJavaLangObject(javax.lang.model.type.TypeMirror type)

typeParametersString back to summary

typeParametersString	back to summary
pack-priv static String typeParametersString(List<? extends javax.lang.model.element.TypeParameterElement> typeParameters) Returns a string representing the given type parameters as they would appear in a class declaration. For example, if we have `@AutoValue abstract class Foo<T extends SomeClass>` then if we call `TypeElement#getTypeParameters()` on the representation of `Foo`, this method will return an encoding of `<T extends SomeClass>`. Likewise it will return an encoding of the angle-bracket part of: `Foo<SomeClass>` `Foo<T extends Number>` `Foo<E extends Enum<E>>` `Foo<K, V extends Comparable<? extends K>>`. The encoding is simply that classes in the "extends" part are marked, so the examples will actually look something like this: <`bar.baz.SomeClass`> <T extends `java.lang.Number`> <E extends `java.lang.Enum`<E>> <K, V extends `java.lang.Comparable`<? extends K>>.

pack-priv static String typeParametersString(List<? extends javax.lang.model.element.TypeParameterElement> typeParameters)

Returns a string representing the given type parameters as they would appear in a class declaration. For example, if we have @AutoValue abstract class Foo<T extends SomeClass> then if we call TypeElement#getTypeParameters() on the representation of Foo, this method will return an encoding of <T extends SomeClass>. Likewise it will return an encoding of the angle-bracket part of:
Foo<SomeClass>
Foo<T extends Number>
Foo<E extends Enum<E>>
Foo<K, V extends Comparable<? extends K>>.

The encoding is simply that classes in the "extends" part are marked, so the examples will actually look something like this:
<`bar.baz.SomeClass`>
<T extends `java.lang.Number`>
<E extends `java.lang.Enum`<E>>
<K, V extends `java.lang.Comparable`<? extends K>>.

com.google.auto.value.processor back to summary

private Class TypeEncoder.AnnotatedEncodingTypeVisitor

Class Inheritance

extends EncodingTypeVisitor

java.lang.Object
⋱
javax.lang.model.util.SimpleTypeVisitor8
com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor
com.google.auto.value.processor.TypeEncoder.AnnotatedEncodingTypeVisitor

Like EncodingTypeVisitor except that annotations on the visited type are also included in the resultant string. Class names in those annotations are also encoded using the `java.util.List` form.

Field Summary

Modifier and Type	Field and Description
private final Set<javax.lang.model.type.TypeMirror>	excludedAnnotationTypes
private final Function<javax.lang.model.type.TypeMirror, List<? extends javax.lang.model.element.AnnotationMirror>>	getTypeAnnotations

Constructor Summary

Access	Constructor and Description
pack-priv	AnnotatedEncodingTypeVisitor(Set<javax.lang.model.type.TypeMirror> excludedAnnotationTypes, Function<javax.lang.model.type.TypeMirror, List<? extends javax.lang.model.element.AnnotationMirror>> getTypeAnnotations)

Method Summary

Modifier and Type	Method and Description
private void	appendAnnotationsWithExclusions(List<? extends javax.lang.model.element.AnnotationMirror> annotations, StringBuilder sb)
public StringBuilder	visitArray(javax.lang.model.type.ArrayType type, StringBuilder sb) Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.visitArray. The result respects the Java syntax, whereby `Foo @Bar []` is an annotation on the array type itself, while `@Bar Foo[]` would be an annotation on the component type.
public StringBuilder	visitDeclared(javax.lang.model.type.DeclaredType type, StringBuilder sb) Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.visitDeclared.
public StringBuilder	visitPrimitive(javax.lang.model.type.PrimitiveType type, StringBuilder sb)
public StringBuilder	visitTypeVariable(javax.lang.model.type.TypeVariable type, StringBuilder sb)

Inherited from com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor:: appendTypeArguments appendTypeName defaultAction visit2 visitError visitWildcard

Field Detail

excludedAnnotationTypes	back to summary
private final Set<javax.lang.model.type.TypeMirror> excludedAnnotationTypes

getTypeAnnotations	back to summary
private final Function<javax.lang.model.type.TypeMirror, List<? extends javax.lang.model.element.AnnotationMirror>> getTypeAnnotations

Constructor Detail

AnnotatedEncodingTypeVisitor	back to summary
pack-priv AnnotatedEncodingTypeVisitor(Set<javax.lang.model.type.TypeMirror> excludedAnnotationTypes, Function<javax.lang.model.type.TypeMirror, List<? extends javax.lang.model.element.AnnotationMirror>> getTypeAnnotations)

Method Detail

appendAnnotationsWithExclusions	back to summary
private void appendAnnotationsWithExclusions(List<? extends javax.lang.model.element.AnnotationMirror> annotations, StringBuilder sb)

visitArray back to summary

visitArray	back to summary
public StringBuilder visitArray(javax.lang.model.type.ArrayType type, StringBuilder sb) Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.visitArray. The result respects the Java syntax, whereby `Foo @Bar []` is an annotation on the array type itself, while `@Bar Foo[]` would be an annotation on the component type. Annotations @Override

public StringBuilder visitArray(javax.lang.model.type.ArrayType type, StringBuilder sb)

Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.visitArray.

The result respects the Java syntax, whereby Foo @Bar [] is an annotation on the array type itself, while @Bar Foo[] would be an annotation on the component type.

Annotations

@Override

visitDeclared	back to summary
public StringBuilder visitDeclared(javax.lang.model.type.DeclaredType type, StringBuilder sb) Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.visitDeclared. Annotations @Override

visitDeclared

back to summary

public StringBuilder visitDeclared(javax.lang.model.type.DeclaredType type, StringBuilder sb)

Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.visitDeclared.

Annotations

@Override

visitPrimitive	back to summary
public StringBuilder visitPrimitive(javax.lang.model.type.PrimitiveType type, StringBuilder sb) Annotations @Override

visitTypeVariable	back to summary
public StringBuilder visitTypeVariable(javax.lang.model.type.TypeVariable type, StringBuilder sb) Annotations @Override

com.google.auto.value.processor back to summary

private Class TypeEncoder.EncodingTypeVisitor

Class Inheritance

extends javax.lang.model.util.SimpleTypeVisitor8

java.lang.Object
⋱
javax.lang.model.util.SimpleTypeVisitor8
com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor

Known Direct Subclasses

com.google.auto.value.processor.TypeEncoder.RawEncodingTypeVisitor, com.google.auto.value.processor.TypeEncoder.AnnotatedEncodingTypeVisitor

Converts a type into a string, using standard Java syntax, except that every class name is wrapped in backquotes, like `java.util.List`.

Constructor Summary

Access	Constructor and Description
private	EncodingTypeVisitor()

Method Summary

Modifier and Type	Method and Description
pack-priv void	appendTypeArguments(javax.lang.model.type.DeclaredType type, StringBuilder sb)
pack-priv void	appendTypeName(javax.lang.model.type.DeclaredType type, StringBuilder sb)
protected StringBuilder	defaultAction(javax.lang.model.type.TypeMirror type, StringBuilder sb)
pack-priv StringBuilder	visit2(javax.lang.model.type.TypeMirror type, StringBuilder sb) Equivalent to `visit(type, sb)` or `type.accept(sb)`, except that it fixes a bug with javac versions up to JDK 8, whereby if the type is a `DeclaredType` then the visitor is called with a version of the type where any annotations have been lost.
public StringBuilder	visitArray(javax.lang.model.type.ArrayType type, StringBuilder sb)
public StringBuilder	visitDeclared(javax.lang.model.type.DeclaredType type, StringBuilder sb)
public StringBuilder	visitError(javax.lang.model.type.ErrorType t, StringBuilder p)
public StringBuilder	visitWildcard(javax.lang.model.type.WildcardType type, StringBuilder sb)

Constructor Detail

EncodingTypeVisitor	back to summary
private EncodingTypeVisitor()

Method Detail

appendTypeArguments	back to summary
pack-priv void appendTypeArguments(javax.lang.model.type.DeclaredType type, StringBuilder sb)

appendTypeName	back to summary
pack-priv void appendTypeName(javax.lang.model.type.DeclaredType type, StringBuilder sb)

defaultAction	back to summary
protected StringBuilder defaultAction(javax.lang.model.type.TypeMirror type, StringBuilder sb) Annotations @Override

visit2	back to summary
pack-priv StringBuilder visit2(javax.lang.model.type.TypeMirror type, StringBuilder sb) Equivalent to `visit(type, sb)` or `type.accept(sb)`, except that it fixes a bug with javac versions up to JDK 8, whereby if the type is a `DeclaredType` then the visitor is called with a version of the type where any annotations have been lost. We can't override `visit` because it is final.

visitArray	back to summary
public StringBuilder visitArray(javax.lang.model.type.ArrayType type, StringBuilder sb) Annotations @Override

visitDeclared	back to summary
public StringBuilder visitDeclared(javax.lang.model.type.DeclaredType type, StringBuilder sb) Annotations @Override

visitError	back to summary
public StringBuilder visitError(javax.lang.model.type.ErrorType t, StringBuilder p) Annotations @Override

visitWildcard	back to summary
public StringBuilder visitWildcard(javax.lang.model.type.WildcardType type, StringBuilder sb) Annotations @Override

com.google.auto.value.processor back to summary

private Class TypeEncoder.RawEncodingTypeVisitor

Class Inheritance

extends EncodingTypeVisitor

java.lang.Object
⋱
javax.lang.model.util.SimpleTypeVisitor8
com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor
com.google.auto.value.processor.TypeEncoder.RawEncodingTypeVisitor

Like EncodingTypeVisitor except that type parameters are omitted from the result.

Constructor Summary

Access	Constructor and Description
private	RawEncodingTypeVisitor()

Method Summary

Modifier and Type	Method and Description
pack-priv void	appendTypeArguments(javax.lang.model.type.DeclaredType type, StringBuilder sb) Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.appendTypeArguments.

Inherited from com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor:: appendTypeName defaultAction visit2 visitArray visitDeclared visitError visitWildcard

Constructor Detail

RawEncodingTypeVisitor	back to summary
private RawEncodingTypeVisitor()

Method Detail

appendTypeArguments	back to summary
pack-priv void appendTypeArguments(javax.lang.model.type.DeclaredType type, StringBuilder sb) Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.appendTypeArguments. Annotations @Override

appendTypeArguments

back to summary

pack-priv void appendTypeArguments(javax.lang.model.type.DeclaredType type, StringBuilder sb)

Overrides com.google.auto.value.processor.TypeEncoder.EncodingTypeVisitor.appendTypeArguments.

Annotations

@Override

com.google.auto.value.processor back to summary

private Class TypeEncoder.TypeRewriter

Class Inheritance

extends Object

java.lang.Object
com.google.auto.value.processor.TypeEncoder.TypeRewriter

Field Summary

Modifier and Type	Field and Description
private final javax.lang.model.type.TypeMirror	baseType
private final javax.lang.model.util.Elements	elementUtils
private final String	packageName
private final JavaScanner	scanner
private final String	text
private final int	textLength
private final javax.lang.model.util.Types	typeUtils

Constructor Summary

Access	Constructor and Description
pack-priv	TypeRewriter(String text, javax.lang.model.util.Elements elementUtils, javax.lang.model.util.Types typeUtils, String pkg, javax.lang.model.type.TypeMirror baseType)

Method Summary

Modifier and Type	Method and Description
private javax.lang.model.type.DeclaredType	classForName(String className)
private String	classNameAt(int token)
private void	decode(StringBuilder output, TypeSimplifier typeSimplifier, int token)
private OptionalInt	findImportMarker()
private Set<javax.lang.model.type.TypeMirror>	findReferencedClasses()
pack-priv String	rewrite()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

baseType	back to summary
private final javax.lang.model.type.TypeMirror baseType

elementUtils	back to summary
private final javax.lang.model.util.Elements elementUtils

packageName	back to summary
private final String packageName

scanner	back to summary
private final JavaScanner scanner

text	back to summary
private final String text

textLength	back to summary
private final int textLength

typeUtils	back to summary
private final javax.lang.model.util.Types typeUtils

Constructor Detail

TypeRewriter	back to summary
pack-priv TypeRewriter(String text, javax.lang.model.util.Elements elementUtils, javax.lang.model.util.Types typeUtils, String pkg, javax.lang.model.type.TypeMirror baseType)

Method Detail

classForName	back to summary
private javax.lang.model.type.DeclaredType classForName(String className)

classNameAt	back to summary
private String classNameAt(int token)

decode	back to summary
private void decode(StringBuilder output, TypeSimplifier typeSimplifier, int token)

findImportMarker	back to summary
private OptionalInt findImportMarker()

findReferencedClasses	back to summary
private Set<javax.lang.model.type.TypeMirror> findReferencedClasses()

rewrite	back to summary
pack-priv String rewrite()

pack-priv final Class TypeEncoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TypeEncoder.AnnotatedEncodingTypeVisitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TypeEncoder.EncodingTypeVisitor

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class TypeEncoder.RawEncodingTypeVisitor

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class TypeEncoder.TypeRewriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail