dagger.model

Class ComponentPath

java.lang.Object

dagger.model.ComponentPath

public abstract class ComponentPath
extends java.lang.Object

A path containing a component and all of its ancestor components.

Constructor Summary

Constructors

Constructor and Description
ComponentPath()

Method Summary

Modifier and Type	Method and Description
boolean	atRoot() Returns true if the currentComponent() current component} is the rootComponent() root component}.
ComponentPath	childPath(javax.lang.model.element.TypeElement child) Returns the path from the root component to the child of the current component.
abstract com.google.common.collect.ImmutableList<javax.lang.model.element.TypeElement>	components() Returns the component types, starting from the root component and ending with the current component.
static ComponentPath	create(java.lang.Iterable<javax.lang.model.element.TypeElement> components) Returns a new ComponentPath from components.
javax.lang.model.element.TypeElement	currentComponent() Returns the component at the end of the path.
abstract boolean	equals(java.lang.Object obj)
abstract int	hashCode()
ComponentPath	parent() Returns this path's parent path.
javax.lang.model.element.TypeElement	parentComponent() Returns the parent of the currentComponent() current component}.
javax.lang.model.element.TypeElement	rootComponent() Returns the root Component- or ProductionComponent-annotated type
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentPath

public ComponentPath()

Method Detail

create

public static ComponentPath create(java.lang.Iterable<javax.lang.model.element.TypeElement> components)

Returns a new ComponentPath from components.

components

public abstract com.google.common.collect.ImmutableList<javax.lang.model.element.TypeElement> components()

Returns the component types, starting from the root component and ending with the current component.

rootComponent

public final javax.lang.model.element.TypeElement rootComponent()

Returns the root Component- or ProductionComponent-annotated type

currentComponent

@Memoized
public javax.lang.model.element.TypeElement currentComponent()

Returns the component at the end of the path.

parentComponent

public final javax.lang.model.element.TypeElement parentComponent()

Returns the parent of the currentComponent() current component}.

Throws:

java.lang.IllegalStateException - if the current graph is the root component

parent

public final ComponentPath parent()

Returns this path's parent path.

Throws:

java.lang.IllegalStateException - if the current graph is the root component

childPath

public final ComponentPath childPath(javax.lang.model.element.TypeElement child)

Returns the path from the root component to the child of the current component.

atRoot

public final boolean atRoot()

Returns true if the currentComponent() current component} is the rootComponent() root component}.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

@Memoized
public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public abstract boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object