Module io.inverno.core.compiler

Package io.inverno.core.compiler.spi

Interface SocketInfo

All Superinterfaces:

Info, ReporterInfo

All Known Subinterfaces:

ModuleBeanMultiSocketInfo, ModuleBeanSingleSocketInfo, ModuleBeanSocketInfo, MultiSocketBeanInfo, MultiSocketInfo, OverridingSocketBeanInfo, SingleSocketBeanInfo, SingleSocketInfo, SocketBeanInfo

public interface SocketInfo
extends Info

Base socket info interface specifying data and services common to all info.

A socket represents an injection point for a single bean or multiple beans on modules or beans.

Author:

Jeremy Kuhn

Method Summary

Modifier and Type	Method	Description
AnnotationMirror[]	getSelectors()	Returns the Selector annotations defined on the socket.
Optional<ExecutableElement>	getSocketElement()	Returns the executable element to use to plug beans into the socket.
TypeMirror	getType()	Returns the type of bean that can be plugged into the socket.
boolean	isOptional()	Determines whether the socket is optional.
boolean	isResolved()	Determines whether the socket is resolved.

Methods inherited from interface io.inverno.core.compiler.spi.Info

getQualifiedName

Methods inherited from interface io.inverno.core.compiler.spi.ReporterInfo

error, hasError, hasWarning, warning

Method Details

getType

TypeMirror getType()

Returns the type of bean that can be plugged into the socket.

Returns:

a type

getSocketElement

Optional<ExecutableElement> getSocketElement()

Returns the executable element to use to plug beans into the socket.

Note that this is not applicable to socket beans in a module being generated.

Returns:

an optional providing the executable element or an empty optional if not applicable

getSelectors

AnnotationMirror[] getSelectors()

Returns the Selector annotations defined on the socket.

Returns:

an array of selector annotations

isOptional

boolean isOptional()

Determines whether the socket is optional.

An optional socket is not required to be resolved for a module to operate properly.

Returns:

true if the socket is optional, false otherwise

isResolved

boolean isResolved()

Determines whether the socket is resolved.

A socket is resolved if the dependency it represents has been resolved (ie. a bean has been plugged into the socket).

Returns:

true if the socket is resolved, false otherwise