Factory (restx-factory 0.35-rc4 API)

java.lang.Object
- restx.factory.Factory

All Implemented Interfaces:

AutoCloseable
```
public class Factory
extends Object
implements AutoCloseable
```
User: xavierhanin Date: 1/31/13 Time: 5:42 PM

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Factory.Builder`
`static class`	`Factory.ClassQuery<T>`
`static class`	`Factory.FactoryQuery`
`static class`	`Factory.LocalMachines`
`static class`	`Factory.MultipleQuery<T>`
`static class`	`Factory.NameQuery<T>`
`static class`	`Factory.Query<T>`
`static class`	`Factory.SatisfiedQuery<T>`
`static class`	`Factory.SingleQuery<T>`
`static class`	`Factory.UnsatisfiedDependencies`
`static class`	`Factory.UnsatisfiedDependenciesException`
`static class`	`Factory.UnsatisfiedDependency`

Field Summary

Fields
Modifier and Type	Field and Description
`static Comparator<MachineEngine<?>>`	`ENGINE_COMPARATOR`
`static String`	`HEALTH_CHECK_REGISTRY`
`static String`	`METRICS_REGISTRY`
`static Comparator<NamedComponent<?>>`	`NAMED_COMPONENT_COMPARATOR`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> String`	`activationKey(Class<T> aClass, String name)`
`Factory`	`and()` Returns current factory, used only for fluent API to have more readable code like factory.start().and().prepare();
`static Factory.Builder`	`builder()`
`void`	`close()`
`Factory`	`concat(FactoryMachine machine)`
`String`	`dump()`
`Object`	`dumper()` Returns an object which toString method dumps the factory.
`<T> T`	`getComponent(Class<T> componentClass)` Builds a component by class.
`<T> T`	`getComponent(Name<T> componentName)` Builds a component by name.
`<T> Set<T>`	`getComponents(Class<T> componentClass)` Builds and return all the component of given class.
`static com.google.common.base.Optional<Factory>`	`getFactory(String key)`
`String`	`getId()`
`static Factory`	`getInstance()` Returns a default Factory instance, getting componenents from ServiceLoader only.
`int`	`getNbMachines()`
`Warehouse`	`getWarehouse()`
`static Factory`	`newInstance()`
`Factory`	`prepare()` Prepares all the AutoPreparable components of this factory.
`<T> Factory.Query<T>`	`queryByClass(Class<T> componentClass)`
`<T> Factory.Query<T>`	`queryByName(Name<T> name)`
`static Factory`	`register(String key, Factory factory)`
`Factory`	`start()` Starts all the AutoStartable components of this factory.
`String`	`toString()`
`static boolean`	`unregister(String key, Factory factory)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - METRICS_REGISTRY
```
public static final String METRICS_REGISTRY
```
    See Also:
    
    Constant Field Values
  - HEALTH_CHECK_REGISTRY
```
public static final String HEALTH_CHECK_REGISTRY
```
    See Also:
    
    Constant Field Values
  - ENGINE_COMPARATOR
```
public static final Comparator<MachineEngine<?>> ENGINE_COMPARATOR
```
  - NAMED_COMPONENT_COMPARATOR
```
public static final Comparator<NamedComponent<?>> NAMED_COMPONENT_COMPARATOR
```
- Method Detail
  - getFactory
```
public static com.google.common.base.Optional<Factory> getFactory(String key)
```
  - register
```
public static Factory register(String key,
                               Factory factory)
```
  - unregister
```
public static boolean unregister(String key,
                                 Factory factory)
```
  - newInstance
```
public static Factory newInstance()
```
  - getInstance
```
public static Factory getInstance()
```
    Returns a default Factory instance, getting componenents from ServiceLoader only. Make sure you never close that instance except on JVM shutdown, it's probably shared among several usages. Prefer using your own Factory with newInstance for instance if you want to have control over its lifecycle.
    
    Returns:
    
    the default factory instance.
  - builder
```
public static Factory.Builder builder()
```
  - activationKey
```
public static <T> String activationKey(Class<T> aClass,
                                       String name)
```
  - concat
```
public Factory concat(FactoryMachine machine)
```
  - getId
```
public String getId()
```
  - getWarehouse
```
public Warehouse getWarehouse()
```
  - getNbMachines
```
public int getNbMachines()
```
  - queryByName
```
public <T> Factory.Query<T> queryByName(Name<T> name)
```
  - queryByClass
```
public <T> Factory.Query<T> queryByClass(Class<T> componentClass)
```
  - getComponent
```
public <T> T getComponent(Class<T> componentClass)
```
    Builds a component by class. This is a shortcut for queryByClass(cls).mandatory().findOneAsComponent().get() Therefore it raises an exception if no component of this class is found or if several one match.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    componentClass -
    
    Returns:
  - getComponent
```
public <T> T getComponent(Name<T> componentName)
```
    Builds a component by name. This is a shortcut for queryByName(name).mandatory().findOneAsComponent().get() Therefore it raises an exception if no component of this name is found.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    componentName -
    
    Returns:
  - getComponents
```
public <T> Set<T> getComponents(Class<T> componentClass)
```
    Builds and return all the component of given class. This is a shortcut for queryByClass(componentClass).findAsComponents()
    
    Type Parameters:
    
    T - the type of components
    
    Parameters:
    
    componentClass - the class of the components to build and return
    
    Returns:
    
    the set of components of given class
  - and
```
public Factory and()
```
    Returns current factory, used only for fluent API to have more readable code like factory.start().and().prepare();
    
    Returns:
    
    current factory
  - start
```
public Factory start()
```
    Starts all the AutoStartable components of this factory.
  - prepare
```
public Factory prepare()
```
    Prepares all the AutoPreparable components of this factory.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - dumper
```
public Object dumper()
```
    Returns an object which toString method dumps the factory. This is useful in logger or check messages, to prevent actually calling dump() if log is disabled or check does not raise exception.
    
    Returns:
    
    a dumper for the factory.
  - dump
```
public String dump()
```

Class Factory

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

METRICS_REGISTRY

HEALTH_CHECK_REGISTRY

ENGINE_COMPARATOR

NAMED_COMPONENT_COMPARATOR

Method Detail

getFactory

register

unregister

newInstance

getInstance

builder

activationKey

concat

getId

getWarehouse

getNbMachines

queryByName

queryByClass

getComponent

getComponent

getComponents

and

start

prepare

close

toString

dumper

dump