com.asakusafw.runtime.core.api

Class ApiStub<T>

java.lang.Object

com.asakusafw.runtime.core.api.ApiStub<T>

Type Parameters:

T - the API type

public class ApiStub<T>
extends Object

An Asakusa Framework API stub.

Since:

0.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiStub.Reference<T> A reference of API implementation.

Constructor Summary

Constructors

Constructor and Description
ApiStub() Creates a new instance without default implementation.
ApiStub(T defaultImplementation) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
ApiStub.Reference<T>	activate(T implementation) Activates the given API implementation on this stub.
T	get() Returns the current active implementation on this API stub.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiStub

public ApiStub()

Creates a new instance without default implementation.

ApiStub

public ApiStub(T defaultImplementation)

Creates a new instance.

Parameters:

defaultImplementation - the default implementation (nullable)

Method Detail

get

public T get()

Returns the current active implementation on this API stub.

Returns:

the active implementation

Throws:

IllegalStateException - if there are no available implementations

activate

public ApiStub.Reference<T> activate(T implementation)

Activates the given API implementation on this stub.

Parameters:

implementation - the target implementation

Returns:

the reference of the implementation, must be closed after the API was disposed

Throws:

IllegalStateException - if another implementation has been activated