Module io.helidon.service.registry

Package io.helidon.service.registry

Interface ActivationResult

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ActivationResult.BuilderBase.ActivationResultImpl

public interface ActivationResult
extends Prototype.Api

Represents the result of a service activation or deactivation.

See Also:

• Activator
• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ActivationResult.Builder	Fluent API builder for ActivationResult.
static class	ActivationResult.BuilderBase<BUILDER extends ActivationResult.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ActivationResult>	Fluent API builder base for ActivationResult.

Method Summary

Modifier and Type	Method	Description
static ActivationResult.Builder	builder()	Create a new fluent API builder to customize configuration.
static ActivationResult.Builder	builder(ActivationResult instance)	Create a new fluent API builder from an existing instance.
static ActivationResult	create()	Create a new instance with default values.
Optional<Throwable>	error()	Any throwable/exceptions that were observed during activation.
default boolean	failure()	Returns true if this result was unsuccessful.
ActivationPhase	finishingActivationPhase()	The activation phase we finished successfully on, or are otherwise currently in if not yet finished.
ActivationPhase	startingActivationPhase()	The activation phase that was found at onset of the phase transition.
boolean	success()	Returns true if this result was successful.
ActivationPhase	targetActivationPhase()	The activation phase that was requested at the onset of the phase transition.

Method Details

builder

static ActivationResult.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ActivationResult.Builder builder(ActivationResult instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ActivationResult create()

Create a new instance with default values.

Returns:

a new instance

startingActivationPhase

ActivationPhase startingActivationPhase()

The activation phase that was found at onset of the phase transition.

Returns:

the starting phase

targetActivationPhase

ActivationPhase targetActivationPhase()

The activation phase that was requested at the onset of the phase transition.

Returns:

the target, desired, ultimate phase requested

finishingActivationPhase

ActivationPhase finishingActivationPhase()

The activation phase we finished successfully on, or are otherwise currently in if not yet finished.

Returns:

the finishing phase

error

Optional<Throwable> error()

Any throwable/exceptions that were observed during activation.

Returns:

any captured error

success

boolean success()

Returns true if this result was successful.

Returns:

true if successful

failure

default boolean failure()

Returns true if this result was unsuccessful.

Returns:

true if unsuccessful