Package net.officefloor.plugin.clazz.state

Interface StatePoint

All Known Subinterfaces:

ClassDependencyManufacturerContext, TypeQualifierInterrogatorContext

All Known Implementing Classes:

StatePointImpl, TypeQualifierInterrogation

public interface StatePoint

Identifies a state point.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
default java.lang.reflect.AnnotatedElement	getAnnotatedElement()	Convenience to obtain the AnnotatedElement.
java.lang.reflect.Executable	getExecutable()	Obtains the Executable.
int	getExecutableParameterIndex()	Obtains the index of the parameter on the Executable.
java.lang.reflect.Field	getField()	Obtains the Field.
static StatePoint	of(java.lang.reflect.Executable executable, int parameterIndex)	Creates a StatePoint for Executable Parameter.
static StatePoint	of(java.lang.reflect.Field field)	Creates StatePoint for a Field.
default java.lang.String	toLocation()	Obtains the location of this StatePoint.
static java.lang.String	toLocation(StatePoint statePoint)	Obtains the location of the StatePoint.

Method Detail

getField

java.lang.reflect.Field getField()

Obtains the Field.

Returns:

Field. Will be null if Executable.

getExecutable

java.lang.reflect.Executable getExecutable()

Obtains the Executable. Typically this is either the Constructor or Method loading the dependency.

Returns:

Executable. Will be null if Field.

getExecutableParameterIndex

int getExecutableParameterIndex()

Obtains the index of the parameter on the Executable.

Returns:

Index of the parameter on the Executable.

getAnnotatedElement

default java.lang.reflect.AnnotatedElement getAnnotatedElement()

Convenience to obtain the AnnotatedElement.

This is the Field or Parameter.

Returns:

AnnotatedElement.

toLocation

default java.lang.String toLocation()

Obtains the location of this StatePoint.

Returns:

Location of this StatePoint.

of

static StatePoint of(java.lang.reflect.Field field)

Creates StatePoint for a Field.

Parameters:

field - Field.

Returns:

StatePoint.

of

static StatePoint of(java.lang.reflect.Executable executable,
                     int parameterIndex)

Creates a StatePoint for Executable Parameter.

Parameters:

executable - Executable.

parameterIndex - Parameter index.

Returns:

StatePoint.

toLocation

static java.lang.String toLocation(StatePoint statePoint)

Obtains the location of the StatePoint. This is typically for logging.

Parameters:

statePoint - StatePoint.

Returns:

Location of the StatePoint.