com.google.auto.value.processor

Class Optionalish

java.lang.Object

com.google.auto.value.processor.Optionalish

public class Optionalish
extends java.lang.Object

A wrapper for properties of Optional-like classes. This can be com.google.common.base.Optional, or any of Optional, OptionalDouble, OptionalInt, OptionalLong in java.util.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.google.common.collect.ImmutableSet<java.lang.String>	OPTIONAL_CLASS_NAMES
private javax.lang.model.type.DeclaredType	optionalType
private static com.google.common.collect.ImmutableMap<java.lang.String,javax.lang.model.type.TypeKind>	PRIMITIVE_TYPE_KINDS
private java.lang.String	rawTypeSpelling

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Optionalish(javax.lang.model.type.DeclaredType optionalType, java.lang.String rawTypeSpelling)

Method Summary

Modifier and Type	Method and Description
(package private) static Optionalish	createIfOptional(javax.lang.model.type.TypeMirror type, java.lang.String rawTypeSpelling) Returns an instance wrapping the given TypeMirror, or null if it is not any kind of Optional.
private javax.lang.model.type.TypeMirror	getContainedPrimitiveType(javax.lang.model.util.Types typeUtils)
(package private) javax.lang.model.type.TypeMirror	getContainedType(javax.lang.model.util.Types typeUtils)
java.lang.String	getEmpty() Returns a string representing the method call to obtain the empty version of this Optional.
java.lang.String	getRawType() Returns a string representing the raw type of this Optional.
(package private) static boolean	isOptional(javax.lang.model.type.TypeMirror type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPTIONAL_CLASS_NAMES

private static final com.google.common.collect.ImmutableSet<java.lang.String> OPTIONAL_CLASS_NAMES

optionalType

private final javax.lang.model.type.DeclaredType optionalType

rawTypeSpelling

private final java.lang.String rawTypeSpelling

PRIMITIVE_TYPE_KINDS

private static final com.google.common.collect.ImmutableMap<java.lang.String,javax.lang.model.type.TypeKind> PRIMITIVE_TYPE_KINDS

Constructor Detail

Optionalish

private Optionalish(javax.lang.model.type.DeclaredType optionalType,
                    java.lang.String rawTypeSpelling)

Method Detail

createIfOptional

static Optionalish createIfOptional(javax.lang.model.type.TypeMirror type,
                                    java.lang.String rawTypeSpelling)

Returns an instance wrapping the given TypeMirror, or null if it is not any kind of Optional.

Parameters:

type - the TypeMirror for the original optional type, for example Optional<String>.

rawTypeSpelling - the representation of the base Optional type in source code, given the imports that will be present. Usually this will be Optional, OptionalInt, etc. In cases of ambiguity it might be java.util.Optional etc.

isOptional

static boolean isOptional(javax.lang.model.type.TypeMirror type)

getRawType

public java.lang.String getRawType()

Returns a string representing the raw type of this Optional. This will typically be just "Optional", but it might be "OptionalInt" or "java.util.Optional" for example.

getEmpty

public java.lang.String getEmpty()

Returns a string representing the method call to obtain the empty version of this Optional. This will be something like "Optional.empty()" or possibly "java.util.Optional.empty()". It does not have a final semicolon.

This method is public so that it can be referenced as p.optional.empty from templates.

getContainedType

javax.lang.model.type.TypeMirror getContainedType(javax.lang.model.util.Types typeUtils)

getContainedPrimitiveType

private javax.lang.model.type.TypeMirror getContainedPrimitiveType(javax.lang.model.util.Types typeUtils)