Package org.inferred.freebuilder.processor.source

Class QualifiedName

java.lang.Object

org.inferred.freebuilder.processor.source.ValueType

org.inferred.freebuilder.processor.source.QualifiedName

All Implemented Interfaces:

java.lang.Comparable<QualifiedName>

public class QualifiedName
extends ValueType
implements java.lang.Comparable<QualifiedName>

The qualified name of a type. Lets us pass a type to a TypeShortener without a Class or javax.lang.model reference.

Nested Class Summary

Nested classes/interfaces inherited from class org.inferred.freebuilder.processor.source.ValueType

ValueType.FieldReceiver

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	packageName
private com.google.common.collect.ImmutableList<java.lang.String>	simpleNames

Constructor Summary

Constructors

Modifier	Constructor	Description
private	QualifiedName(java.lang.String packageName, com.google.common.collect.ImmutableList<java.lang.String> simpleNames)

Method Summary

Modifier and Type	Method	Description
protected void	addFields(ValueType.FieldReceiver fields)	Implement this method to report the name and value of each field.
int	compareTo(QualifiedName o)
QualifiedName	enclosingType()	Returns the QualifiedName of the type enclosing this one.
java.lang.String	getPackage()
java.lang.String	getSimpleName()
com.google.common.collect.ImmutableList<java.lang.String>	getSimpleNames()
boolean	isNestedIn(QualifiedName other)
boolean	isTopLevel()
QualifiedName	nestedType(java.lang.String simpleName)	Returns the QualifiedName of a type called simpleName nested in this one.
static QualifiedName	of(java.lang.Class<?> cls)	Returns a QualifiedName for cls, unshading if necessary.
static QualifiedName	of(java.lang.String packageName, java.lang.String topLevelType, java.lang.String... nestedTypes)	Returns a QualifiedName for a type in packageName.
static QualifiedName	of(javax.lang.model.element.TypeElement type)	Returns a QualifiedName for type.
java.lang.String	toString()	Returns this qualified name as a string.
TypeClass	withParameters(java.lang.Iterable<? extends javax.lang.model.element.TypeParameterElement> typeParameters)
TypeClass	withParameters(javax.lang.model.element.TypeParameterElement... parameters)
Type	withParameters(javax.lang.model.type.TypeMirror first, javax.lang.model.type.TypeMirror... rest)

Methods inherited from class org.inferred.freebuilder.processor.source.ValueType

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

packageName

private final java.lang.String packageName

simpleNames

private final com.google.common.collect.ImmutableList<java.lang.String> simpleNames

Constructor Detail

QualifiedName

private QualifiedName(java.lang.String packageName,
                      com.google.common.collect.ImmutableList<java.lang.String> simpleNames)

Method Detail

of

public static QualifiedName of(java.lang.String packageName,
                               java.lang.String topLevelType,
                               java.lang.String... nestedTypes)

Returns a QualifiedName for a type in packageName. If nestedTypes is empty, it is a top level type called topLevelType; otherwise, it is nested in that type.

of

public static QualifiedName of(java.lang.Class<?> cls)

Returns a QualifiedName for cls, unshading if necessary.

of

public static QualifiedName of(javax.lang.model.element.TypeElement type)

Returns a QualifiedName for type.

toString

public java.lang.String toString()

Returns this qualified name as a string.

Returns the same as Class.getName() and TypeElement.getQualifiedName() would for the same type, e.g. "java.lang.Integer" or "com.example.OuterType.InnerType".

Overrides:

toString in class ValueType

getPackage

public java.lang.String getPackage()

enclosingType

public QualifiedName enclosingType()

Returns the QualifiedName of the type enclosing this one.

Throws:

java.lang.IllegalStateException - if isTopLevel() returns true

getSimpleNames

public com.google.common.collect.ImmutableList<java.lang.String> getSimpleNames()

getSimpleName

public java.lang.String getSimpleName()

isTopLevel

public boolean isTopLevel()

isNestedIn

public boolean isNestedIn(QualifiedName other)

nestedType

public QualifiedName nestedType(java.lang.String simpleName)

Returns the QualifiedName of a type called simpleName nested in this one.

withParameters

public TypeClass withParameters(javax.lang.model.element.TypeParameterElement... parameters)

withParameters

public Type withParameters(javax.lang.model.type.TypeMirror first,
                           javax.lang.model.type.TypeMirror... rest)

withParameters

public TypeClass withParameters(java.lang.Iterable<? extends javax.lang.model.element.TypeParameterElement> typeParameters)

compareTo

public int compareTo(QualifiedName o)

Specified by:

compareTo in interface java.lang.Comparable<QualifiedName>

addFields

protected void addFields(ValueType.FieldReceiver fields)

Description copied from class: ValueType

Implement this method to report the name and value of each field.

Specified by:

addFields in class ValueType