org.jboss.aerogear.android.pipe

Class PipeManager

java.lang.Object

org.jboss.aerogear.android.pipe.PipeManager

public class PipeManager
extends Object

A Manager which handles the registration of configurations and references to created pipes.

Method Summary

Modifier and Type	Method and Description
static <CFG extends PipeConfiguration<CFG>> CFG	config(String name, Class<CFG> pipeConfigurationClass) Begins a new fluent configuration stanza.
static Pipe	getPipe(String name) Fetches a named pipe
static LoaderPipe	getPipe(String name, android.app.Activity activity) Look up for a pipe object.
static LoaderPipe	getPipe(String name, android.app.Fragment fragment, android.content.Context applicationContext) Look up for a pipe object.
static <CFG extends PipeConfiguration<CFG>> void	registerConfigurationProvider(Class<CFG> configurationClass, org.jboss.aerogear.android.core.ConfigurationProvider<CFG> provider) This will add a new Configuration that this Manager can build Configurations for.

Methods inherited from class java.lang.Object

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

Method Detail

registerConfigurationProvider

public static <CFG extends PipeConfiguration<CFG>> void registerConfigurationProvider(Class<CFG> configurationClass,
                                                                                      org.jboss.aerogear.android.core.ConfigurationProvider<CFG> provider)

This will add a new Configuration that this Manager can build Configurations for.

Type Parameters:

CFG - the actual Configuration type

Parameters:

configurationClass - the class of configuration to be registered

provider - the instance which will provide the configuration.

config

public static <CFG extends PipeConfiguration<CFG>> CFG config(String name,
                                                              Class<CFG> pipeConfigurationClass)

Begins a new fluent configuration stanza.

Type Parameters:

CFG - the Configuration type.

Parameters:

name - an identifier which will be used to fetch the Pipe after configuration is finished. See : getPipe(java.lang.String)

pipeConfigurationClass - the class of the configuration type.

Returns:

a PipeConfiguration which can be used to build a Pipe object.

getPipe

public static Pipe getPipe(String name)

Fetches a named pipe

Parameters:

name - the name of the Pipe given in config(java.lang.String, java.lang.Class)

Returns:

the named Pipe or null

getPipe

public static LoaderPipe getPipe(String name,
                                 android.app.Activity activity)

Look up for a pipe object. This will wrap the Pipe in a Loader.

Parameters:

name - the name of the actual pipe

activity - the activity whose lifecycle the loader will follow

Returns:

the new created Pipe object

getPipe

public static LoaderPipe getPipe(String name,
                                 android.app.Fragment fragment,
                                 android.content.Context applicationContext)

Look up for a pipe object. This will wrap the Pipe in a Loader.

Parameters:

name - the name of the actual pipe

fragment - the Fragment whose lifecycle the activity will follow

applicationContext - the Context of the application.

Returns:

the new created Pipe object