org.granite.client.tide

Interface InstanceStore

All Known Implementing Classes:

SimpleInjectInstanceStore, SimpleInstanceStore

public interface InstanceStore

SPI to integrate with DI containers

Author:

William DRAI

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	allByAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass, Context context) Return a map of all bean instances annotated with the specified annotation
<T> T[]	allByType(java.lang.Class<T> type, Context context, boolean create) Return an array of all bean instances implementing the expected type
java.util.List<java.lang.String>	allNames() Return all bean names set in this container
<T> T	byName(java.lang.String name, Context context) Lookup a bean by its name The implementation is free to create and return a default instance (such as a service proxy) if no bean exists
<T> T	byType(java.lang.Class<T> type, Context context) Lookup a bean by its type If more than one instance is found, should throw a runtime exception
void	clear() Clear all beans from the container Not applicable to statically configured containers (Spring/CDI)
boolean	exists(java.lang.String name) Indicate if a bean of the specified name exists in the store
<T> T	getNoProxy(java.lang.String name, Context context) Lookup a bean by its name Does not create a proxy if no bean found
void	init()
void	inject(java.lang.Object instance, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> properties) Inject context value into provided instance
void	remove(java.lang.Object instance) Remove a bean from the container Not applicable to statically configured containers (Spring/CDI)
void	remove(java.lang.String name) Remove a bean from the container Not applicable to statically configured containers (Spring/CDI)
<T> T	set(java.lang.String name, T instance) Set a named bean in the container Not applicable to statically configured containers (Spring/CDI)
<T> T	set(T instance) Set a bean in the container without specifying a name Not applicable to statically configured containers (Spring/CDI) The bean will be accessible only by its type

Method Detail

init

void init()

set

<T> T set(java.lang.String name,
        T instance)

Set a named bean in the container Not applicable to statically configured containers (Spring/CDI)

Type Parameters:

T - bean type

Parameters:

name - bean name

instance - bean instance

Returns:

the attached bean instance (usually the same instance as the one provided)

set

<T> T set(T instance)

Set a bean in the container without specifying a name Not applicable to statically configured containers (Spring/CDI) The bean will be accessible only by its type

Type Parameters:

T - bean type

Parameters:

instance - bean instance

Returns:

the attached bean instance (usually the same instance as the one provided)

remove

void remove(java.lang.String name)

Remove a bean from the container Not applicable to statically configured containers (Spring/CDI)

Parameters:

name - bean name

remove

void remove(java.lang.Object instance)

Remove a bean from the container Not applicable to statically configured containers (Spring/CDI)

Parameters:

instance - bean instance

inject

void inject(java.lang.Object instance,
          java.lang.String name,
          java.util.Map<java.lang.String,java.lang.Object> properties)

Inject context value into provided instance

Parameters:

instance - instance to inject into

name - component name

properties - properties defined on the context

clear

void clear()

Clear all beans from the container Not applicable to statically configured containers (Spring/CDI)

allNames

java.util.List<java.lang.String> allNames()

Return all bean names set in this container

Returns:

list of bean names

exists

boolean exists(java.lang.String name)

Indicate if a bean of the specified name exists in the store

Parameters:

name - component name

Returns:

true if exists

byName

<T> T byName(java.lang.String name,
           Context context)

Lookup a bean by its name The implementation is free to create and return a default instance (such as a service proxy) if no bean exists

Type Parameters:

T - expected bean type

Parameters:

name - bean name

context - context to lookup

Returns:

bean instance or null if not found

getNoProxy

<T> T getNoProxy(java.lang.String name,
               Context context)

Lookup a bean by its name Does not create a proxy if no bean found

Type Parameters:

T - bean type

Parameters:

name - bean name

context - context to lookup

Returns:

bean instance or null if not found

byType

<T> T byType(java.lang.Class<T> type,
           Context context)

Lookup a bean by its type If more than one instance is found, should throw a runtime exception

Type Parameters:

T - expected bean type

Parameters:

type - expected bean type

context - context to lookup

Returns:

bean instance

allByType

<T> T[] allByType(java.lang.Class<T> type,
                Context context,
                boolean create)

Return an array of all bean instances implementing the expected type

Type Parameters:

T - expected bean type

Parameters:

type - expected bean type

context - context to lookup

create - if true, should create an instance if none is existing

Returns:

array of bean instances or null if no bean found

allByAnnotatedWith

java.util.Map<java.lang.String,java.lang.Object> allByAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass,
                                                                  Context context)

Return a map of all bean instances annotated with the specified annotation

Parameters:

annotationClass - annotation

context - context to lookup

Returns:

map of bean instances keyed by name