dagger.internal.codegen.writer

Class ClassName

java.lang.Object

dagger.internal.codegen.writer.ClassName

All Implemented Interfaces:

HasClassReferences, TypeName, Comparable<ClassName>

public final class ClassName
extends Object
implements TypeName, Comparable<ClassName>

Represents a fully-qualified class name for NestingKind.TOP_LEVEL and NestingKind.MEMBER classes.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Writable.Context

Method Summary

Methods

Modifier and Type	Method and Description
static ClassName	bestGuessFromString(String classNameString) Returns a new ClassName instance for the given fully-qualified class name string.
String	canonicalName()
String	classFileName()
int	compareTo(ClassName o)
static ClassName	create(String packageName, List<String> enclosingSimpleNames, String simpleName)
static ClassName	create(String packageName, String simpleName)
com.google.common.base.Optional<ClassName>	enclosingClassName()
com.google.common.collect.ImmutableList<String>	enclosingSimpleNames()
boolean	equals(Object obj)
static ClassName	fromClass(Class<?> clazz)
static ClassName	fromTypeElement(TypeElement element)
int	hashCode()
ClassName	nestedClassNamed(String memberClassName)
String	packageName()
ClassName	peerNamed(String peerClassName)
Set<ClassName>	referencedClasses()
String	simpleName()
ClassName	topLevelClassName()
String	toString()
Appendable	write(Appendable appendable, Writable.Context context)

Methods inherited from class java.lang.Object

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

Method Detail

packageName

public String packageName()

enclosingSimpleNames

public com.google.common.collect.ImmutableList<String> enclosingSimpleNames()

enclosingClassName

public com.google.common.base.Optional<ClassName> enclosingClassName()

simpleName

public String simpleName()

canonicalName

public String canonicalName()

classFileName

public String classFileName()

topLevelClassName

public ClassName topLevelClassName()

nestedClassNamed

public ClassName nestedClassNamed(String memberClassName)

peerNamed

public ClassName peerNamed(String peerClassName)

fromTypeElement

public static ClassName fromTypeElement(TypeElement element)

fromClass

public static ClassName fromClass(Class<?> clazz)

bestGuessFromString

public static ClassName bestGuessFromString(String classNameString)

Returns a new ClassName instance for the given fully-qualified class name string. This method assumes that the input is ASCII and follows typical Java style (lower-case package names, upper-camel-case class names) and may produce incorrect results or throw IllegalArgumentException otherwise. For that reason, fromClass(Class) and fromClass(Class) should be preferred as they can correctly create ClassName instances without such restrictions.

create

public static ClassName create(String packageName,
               List<String> enclosingSimpleNames,
               String simpleName)

create

public static ClassName create(String packageName,
               String simpleName)

toString

public String toString()

Overrides:

toString in class Object

write

public Appendable write(Appendable appendable,
               Writable.Context context)
                 throws IOException

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ClassName o)

Specified by:

compareTo in interface Comparable<ClassName>

referencedClasses

public Set<ClassName> referencedClasses()

Specified by:

referencedClasses in interface HasClassReferences