net.e6tech.elements.common.resources

Class Resources

java.lang.Object

net.e6tech.elements.common.resources.Resources

All Implemented Interfaces:

java.lang.AutoCloseable, ResourcePool

public class Resources
extends java.lang.Object
implements java.lang.AutoCloseable, ResourcePool

A Resources instance is use to manage resource level injection and resources. Rules for injection. Only annotate injection for instances that are configured during program start up. During runtime, it is better to store resources via put. This prevents a overly complicated dependency wiring. For dynamically created instances, really the only needed injected resource is the Resources instance and resources provided by ResourceProviders. Created by futeh.

Field Summary

Fields

Modifier and Type	Field and Description
protected Configurator	configurator
protected net.e6tech.elements.common.resources.ResourcesState	state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Resources(ResourceManager resourceManager)

Method Summary

Modifier and Type	Method and Description
Resources	abort()
Resources	addModule(Module module)
Resources	addResourceProvider(ResourceProvider resourceProvider)
Resources	afterAbort(AfterAbort afterAbort)
Resources	afterAbort(java.lang.Runnable runnable)
Resources	afterCommit(AfterCommit afterCommit)
Resources	afterCommit(java.lang.Runnable runnable)
Resources	afterCommitOrAbort(java.lang.Runnable runnable)
<T> T	bind(java.lang.Class<T> cls, T resource)
void	bindClass(java.lang.Class cls, java.lang.Class service) This method is mostly used for unit testing.
<T> T	bindNamedInstance(java.lang.Class<T> cls, java.lang.String name, T resource)
<E extends java.lang.Exception> void	briefly(ConsumerWithException<Bindings,E> consumer)
<T,E extends java.lang.Exception> T	briefly(FunctionWithException<Bindings,T,E> function)
void	cleanup()
void	close()
<R> R	commit()
Configurator	configurator()
Resources	configure(Configurator configurator)
<T> T	getInstance(java.lang.Class<T> cls)
<T> T	getInstance(java.lang.Class<T> cls, java.util.function.Supplier<T> call)
java.lang.Throwable	getLastException()
<T> java.util.Map<java.lang.String,T>	getMapVariable(java.lang.Class<T> key)
<T> T	getMapVariable(java.lang.Class<T> key, java.lang.String name)
Module	getModule()
<T> T	getNamedInstance(java.lang.Class<T> cls, java.lang.String name)
<R,S,T extends Plugin> java.util.Optional<T>	getPlugin(java.lang.Class<R> c1, java.lang.String n1, java.lang.Class<S> c2, java.lang.String n2, java.lang.Class<T> c3, java.lang.Object... args)
<S,T extends Plugin> java.util.Optional<T>	getPlugin(java.lang.Class<S> c1, java.lang.String n1, java.lang.Class<T> c2, java.lang.Object... args)
<T extends Plugin> java.util.Optional<T>	getPlugin(PluginPath<T> path, java.lang.Object... args)
<T extends Plugin> java.util.Optional<T>	getPlugin(PluginPaths<T> paths, java.lang.Object... args)
PluginManager	getPluginManager()
ResourceManager	getResourceManager()
Retry	getRetry()
<T> java.util.Optional<T>	getVariable(java.lang.String key)
boolean	hasInstance(java.lang.Class cls)
<T> T	inject(T object)
boolean	isAborted()
<T> boolean	isBound(java.lang.Class<T> cls)
boolean	isClosed()
boolean	isCommitted()
boolean	isDiscarded()
boolean	isOpen()
<T> T	nullableVar(java.lang.String key)
Resources	onAbort(OnAbort onAbort)
Resources	onAbort(java.lang.Runnable runnable)
Resources	onClosed(OnClosed onClosed)
Resources	onClosed(java.lang.Runnable runnable)
Resources	onCommit(OnCommit onCommit)
Resources	onCommit(java.lang.Runnable runnable)
Resources	onCommitOrAbort(java.lang.Runnable runnable)
Resources	onOpen()
Resources	onOpen(OnOpen onOpen)
Resources	onOpen(java.lang.Runnable runnable)
static Resources	parent(Resources current)
static java.util.Iterator<Resources>	parents(Resources current)
<T extends Provision> T	provision()
<T> T	rebind(java.lang.Class<T> cls, T resource)
<T> T	rebindNamedInstance(java.lang.Class<T> cls, java.lang.String name, T resource)
boolean	remove(ResourceProvider provider)
protected <T extends Resources,R,E extends java.lang.Exception> R	replay(java.lang.Exception th, net.e6tech.elements.common.resources.Resources.Replay<T,R,E> replay)
void	setRetry(Retry retry)
Resources	setVariable(java.lang.String key, java.lang.Object val)
<R extends Resources,E extends java.lang.Exception> void	submit(ConsumerWithException<R,E> work)
<T extends Resources,R,E extends java.lang.Exception> R	submit(FunctionWithException<T,R,E> work)
<T> T	tryBind(java.lang.Class<T> cls, java.util.concurrent.Callable<T> callable)
<T> T	unbind(java.lang.Class<T> cls)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.e6tech.elements.common.resources.ResourcePool

bind, findById, getBean, getBean, getNotificationCenter, mapById, newInstance, rebind

Field Detail

state

protected net.e6tech.elements.common.resources.ResourcesState state

configurator

protected Configurator configurator

Constructor Detail

Resources

protected Resources(ResourceManager resourceManager)

Method Detail

parent

public static Resources parent(Resources current)

parents

public static java.util.Iterator<Resources> parents(Resources current)

nullableVar

public <T> T nullableVar(java.lang.String key)

getVariable

public <T> java.util.Optional<T> getVariable(java.lang.String key)

setVariable

public Resources setVariable(java.lang.String key,
                             java.lang.Object val)

getMapVariable

public <T> java.util.Map<java.lang.String,T> getMapVariable(java.lang.Class<T> key)

getMapVariable

public <T> T getMapVariable(java.lang.Class<T> key,
                            java.lang.String name)

getRetry

public Retry getRetry()

setRetry

@Inject(optional=true)
public void setRetry(Retry retry)

isCommitted

public boolean isCommitted()

isOpen

public boolean isOpen()

isAborted

public boolean isAborted()

isClosed

public boolean isClosed()

isDiscarded

public boolean isDiscarded()

addResourceProvider

public Resources addResourceProvider(ResourceProvider resourceProvider)

onCommit

public Resources onCommit(OnCommit onCommit)

onCommit

public Resources onCommit(java.lang.Runnable runnable)

afterCommit

public Resources afterCommit(AfterCommit afterCommit)

afterCommit

public Resources afterCommit(java.lang.Runnable runnable)

onCommitOrAbort

public Resources onCommitOrAbort(java.lang.Runnable runnable)

onOpen

public Resources onOpen(OnOpen onOpen)

onOpen

public Resources onOpen(java.lang.Runnable runnable)

onAbort

public Resources onAbort(OnAbort onAbort)

onAbort

public Resources onAbort(java.lang.Runnable runnable)

afterAbort

public Resources afterAbort(AfterAbort afterAbort)

afterAbort

public Resources afterAbort(java.lang.Runnable runnable)

afterCommitOrAbort

public Resources afterCommitOrAbort(java.lang.Runnable runnable)

onClosed

public Resources onClosed(OnClosed onClosed)

onClosed

public Resources onClosed(java.lang.Runnable runnable)

remove

public boolean remove(ResourceProvider provider)

getResourceManager

public ResourceManager getResourceManager()

Specified by:

getResourceManager in interface ResourcePool

getPluginManager

public PluginManager getPluginManager()

getPlugin

public <S,T extends Plugin> java.util.Optional<T> getPlugin(java.lang.Class<S> c1,
                                                            java.lang.String n1,
                                                            java.lang.Class<T> c2,
                                                            java.lang.Object... args)

getPlugin

public <R,S,T extends Plugin> java.util.Optional<T> getPlugin(java.lang.Class<R> c1,
                                                              java.lang.String n1,
                                                              java.lang.Class<S> c2,
                                                              java.lang.String n2,
                                                              java.lang.Class<T> c3,
                                                              java.lang.Object... args)

getPlugin

public <T extends Plugin> java.util.Optional<T> getPlugin(PluginPath<T> path,
                                                          java.lang.Object... args)

getPlugin

public <T extends Plugin> java.util.Optional<T> getPlugin(PluginPaths<T> paths,
                                                          java.lang.Object... args)

getModule

public Module getModule()

addModule

public Resources addModule(Module module)

briefly

public <E extends java.lang.Exception> void briefly(ConsumerWithException<Bindings,E> consumer)
                                             throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

briefly

public <T,E extends java.lang.Exception> T briefly(FunctionWithException<Bindings,T,E> function)
                                            throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

tryBind

public <T> T tryBind(java.lang.Class<T> cls,
                     java.util.concurrent.Callable<T> callable)

isBound

public <T> boolean isBound(java.lang.Class<T> cls)

bind

public <T> T bind(java.lang.Class<T> cls,
                  T resource)

Specified by:

bind in interface ResourcePool

rebind

public <T> T rebind(java.lang.Class<T> cls,
                    T resource)

Specified by:

rebind in interface ResourcePool

unbind

public <T> T unbind(java.lang.Class<T> cls)

Specified by:

unbind in interface ResourcePool

bindClass

public void bindClass(java.lang.Class cls,
                      java.lang.Class service)

This method is mostly used for unit testing. the bound class disappear once resources is closed. Unless you know what you are doing, please don't use.

Specified by:

bindClass in interface ResourcePool

Parameters:

cls - Class to bind to

service - service class

bindNamedInstance

public <T> T bindNamedInstance(java.lang.Class<T> cls,
                               java.lang.String name,
                               T resource)

Specified by:

bindNamedInstance in interface ResourcePool

rebindNamedInstance

public <T> T rebindNamedInstance(java.lang.Class<T> cls,
                                 java.lang.String name,
                                 T resource)

Specified by:

rebindNamedInstance in interface ResourcePool

getNamedInstance

public <T> T getNamedInstance(java.lang.Class<T> cls,
                              java.lang.String name)

inject

public <T> T inject(T object)

Specified by:

inject in interface ResourcePool

hasInstance

public boolean hasInstance(java.lang.Class cls)

getInstance

public <T> T getInstance(java.lang.Class<T> cls)

getInstance

public <T> T getInstance(java.lang.Class<T> cls,
                         java.util.function.Supplier<T> call)

configurator

public Configurator configurator()

configure

public Resources configure(Configurator configurator)

onOpen

public Resources onOpen()

replay

protected <T extends Resources,R,E extends java.lang.Exception> R replay(java.lang.Exception th,
                                                                         net.e6tech.elements.common.resources.Resources.Replay<T,R,E> replay)

submit

public <R extends Resources,E extends java.lang.Exception> void submit(ConsumerWithException<R,E> work)

submit

public <T extends Resources,R,E extends java.lang.Exception> R submit(FunctionWithException<T,R,E> work)

getLastException

public java.lang.Throwable getLastException()

commit

public <R> R commit()

abort

public Resources abort()

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

cleanup

public void cleanup()

provision

public <T extends Provision> T provision()