A B C E F G H I L O P R S T V W
All Classes All Packages

A

accept(Context) - Method in interface cloud.commandframework.services.types.ConsumerService

Accept the context.

ACCEPTED - cloud.commandframework.services.State

The service consumed the context successfully and the execution should stop

apply(Context) - Method in interface cloud.commandframework.services.types.Service

B

build() - Method in class cloud.commandframework.services.ServicePipelineBuilder

Construct a new ServicePipeline using the options specified in the builder

builder() - Static method in class cloud.commandframework.services.ServicePipeline

Create a new ServicePipelineBuilder

C

ChunkedRequestContext<Context,Result> - Class in cloud.commandframework.services

This class represents a request that can be fulfilled by one, or multiple services, for one or more objects

ChunkedRequestContext(Collection<Context>) - Constructor for class cloud.commandframework.services.ChunkedRequestContext

Initialize a new request

cloud.commandframework.services - package cloud.commandframework.services

IntellectualSites service pipeline system

cloud.commandframework.services.annotations - package cloud.commandframework.services.annotations

Service related annotations

cloud.commandframework.services.types - package cloud.commandframework.services.types

Service implementation types

ConsumerService<Context> - Interface in cloud.commandframework.services.types

Service type where each implementation gets a chance to consume the context.

ConsumerService.PipeBurst - Exception in cloud.commandframework.services.types

E

ExecutionOrder - Enum in cloud.commandframework.services

Used to specify the relative priority of a service implementation

F

fillInStackTrace() - Method in exception cloud.commandframework.services.types.ConsumerService.PipeBurst

FIRST - cloud.commandframework.services.ExecutionOrder

forward() - Method in class cloud.commandframework.services.ServiceSpigot

Forward the request through the original pipeline.

forwardAsynchronously() - Method in class cloud.commandframework.services.ServiceSpigot

Forward the request through the original pipeline.

G

getAvailableResults() - Method in class cloud.commandframework.services.ChunkedRequestContext

Get a view of the (currently) available results

getImplementations(TypeToken<S>) - Method in class cloud.commandframework.services.ServicePipeline

Get a collection of all the TypeToken of all implementations for a given type.

getRecognizedTypes() - Method in class cloud.commandframework.services.ServicePipeline

Get a collection of all the recognised service types.

getRemaining() - Method in class cloud.commandframework.services.ChunkedRequestContext

Get all remaining requests

getResult() - Method in class cloud.commandframework.services.ServiceSpigot

Get the first result that is generated for the given context.

getResult(BiConsumer<Result, Throwable>) - Method in class cloud.commandframework.services.ServiceSpigot

Get the first result that is generated for the given context.

getResultAsynchronously() - Method in class cloud.commandframework.services.ServiceSpigot

Get the first result that is generated for the given context.

H

handle(Chunked) - Method in interface cloud.commandframework.services.types.PartialResultService

handle(Context) - Method in interface cloud.commandframework.services.types.ConsumerService

handle(Context) - Method in interface cloud.commandframework.services.types.Service

Provide a response for the given context.

handle(Context) - Method in interface cloud.commandframework.services.types.SideEffectService

Consumes the context, if possible.

handleRequests(List<Context>) - Method in interface cloud.commandframework.services.types.PartialResultService

Attempt to generate results for a list of requests, and return a map of all successful requests

I

initCause(Throwable) - Method in exception cloud.commandframework.services.types.ConsumerService.PipeBurst

interrupt() - Static method in interface cloud.commandframework.services.types.ConsumerService

Immediately terminate the execution and return State.ACCEPTED

isCompleted() - Method in class cloud.commandframework.services.ChunkedRequestContext

Check if the request has been completed

L

LAST - cloud.commandframework.services.ExecutionOrder

LATE - cloud.commandframework.services.ExecutionOrder

LATER - cloud.commandframework.services.ExecutionOrder

O

order() - Method in interface cloud.commandframework.services.types.Service

Get the execution order of the service.

Order - Annotation Type in cloud.commandframework.services.annotations

Used to specify the relative priority of a service implementation

P

PartialResultService<Context,Result,Chunked extends ChunkedRequestContext<Context,Result>> - Interface in cloud.commandframework.services.types

Service type that allows service to generate partial results for bigger requests

PipelineException - Exception in cloud.commandframework.services

Wrapper for exceptions thrown during pipeline execution.

PipelineException(Exception) - Constructor for exception cloud.commandframework.services.PipelineException

Construct a new pipeline exception

PipelineException(String, Exception) - Constructor for exception cloud.commandframework.services.PipelineException

Construct a new pipeline exception

pump(Context) - Method in class cloud.commandframework.services.ServicePipeline

Start traversing the pipeline by providing the context that will be used to generate the results

R

registerMethods(T) - Method in class cloud.commandframework.services.ServicePipeline

Scan a given class for methods annotated with ServiceImplementation and register them as service implementations.

registerServiceImplementation(TypeToken<? extends Service<Context, Result>>, Service<Context, Result>, Collection<Predicate<Context>>) - Method in class cloud.commandframework.services.ServicePipeline

Register a service implementation for a type that is recognized by the pipeline.

registerServiceImplementation(Class<? extends Service<Context, Result>>, Service<Context, Result>, Collection<Predicate<Context>>) - Method in class cloud.commandframework.services.ServicePipeline

Register a service implementation for a type that is recognized by the pipeline.

registerServiceType(TypeToken<? extends Service<Context, Result>>, Service<Context, Result>) - Method in class cloud.commandframework.services.ServicePipeline

Register a service type so that it is recognized by the pipeline

REJECTED - cloud.commandframework.services.State

The service did not consume the context and the execution should continue

S

Service<Context,Result> - Interface in cloud.commandframework.services.types

A service is anything that can take in a context, and produce a response.

ServiceImplementation - Annotation Type in cloud.commandframework.services.annotations

Used to bind methods to services, like such:

ServicePipeline - Class in cloud.commandframework.services

Service pipeline

ServicePipelineBuilder - Class in cloud.commandframework.services

Builder for ServicePipeline

ServicePump<Context> - Class in cloud.commandframework.services

Class that forwards a context to a service type that consumes said context

ServiceRepository<Context,Response> - Class in cloud.commandframework.services

Repository that contains implementations for a given service type

ServiceSpigot<Context,Result> - Class in cloud.commandframework.services

Class that outputs results from the given context, using the specified service type

SideEffectService<Context> - Interface in cloud.commandframework.services.types

Service implementation that alters the state of the owning application in some way.

SOON - cloud.commandframework.services.ExecutionOrder

SOONER - cloud.commandframework.services.ExecutionOrder

State - Enum in cloud.commandframework.services

This indicates how a Service responded to a given context

storeResult(Context, Result) - Method in class cloud.commandframework.services.ChunkedRequestContext

Store a result for a specific context

T

through(TypeToken<? extends Service<Context, Result>>) - Method in class cloud.commandframework.services.ServicePump

Specify the service type that the context will be pumped through

through(Class<? extends Service<Context, Result>>) - Method in class cloud.commandframework.services.ServicePump

Specify the service type that the context will be pumped through

V

value() - Method in annotation type cloud.commandframework.services.annotations.Order

The priority of the implementation

value() - Method in annotation type cloud.commandframework.services.annotations.ServiceImplementation

The service class that the method implements

valueOf(String) - Static method in enum cloud.commandframework.services.ExecutionOrder

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum cloud.commandframework.services.State

Returns the enum constant of this type with the specified name.

values() - Static method in enum cloud.commandframework.services.ExecutionOrder

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum cloud.commandframework.services.State

Returns an array containing the constants of this enum type, in the order they are declared.

W

withExecutor(Executor) - Method in class cloud.commandframework.services.ServicePipelineBuilder

Set the executor that will be used by the pipeline when evaluating results asynchronously.

A B C E F G H I L O P R S T V W
All Classes All Packages