org.jboss.aerogear.android.pipe

Class PipeConfiguration<CONFIGURATION extends PipeConfiguration<CONFIGURATION>>

java.lang.Object

org.jboss.aerogear.android.pipe.PipeConfiguration<CONFIGURATION>

Type Parameters:

CONFIGURATION - The implementation class type.

All Implemented Interfaces:

org.jboss.aerogear.android.core.Config<CONFIGURATION>

Direct Known Subclasses:

RestfulPipeConfiguration

public abstract class PipeConfiguration<CONFIGURATION extends PipeConfiguration<CONFIGURATION>>
extends Object
implements org.jboss.aerogear.android.core.Config<CONFIGURATION>

This is the top level PipeConfiguration class.

Constructor Summary

Constructors

Constructor and Description
PipeConfiguration()

Method Summary

Modifier and Type	Method and Description
CONFIGURATION	addOnPipeCreatedListener(OnPipeCreatedListener listener) OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.
protected abstract <DATA> Pipe<DATA>	buildPipeForClass(Class<DATA> aClass) Validates configuration parameters and returns a Pipe instance.
<DATA> Pipe<DATA>	forClass(Class<DATA> aClass) Creates a pipe based on the current configuration and notifies all listeners
abstract List<PipeModule>	getModules() Modules are bits of functionality which are called during a Pipes lifecycle.
String	getName() The name is the key which is used to reference the created pipe in PipeManager.
Collection<OnPipeCreatedListener>	getOnPipeCreatedListeners() OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.
abstract CONFIGURATION	module(PipeModule module) Modules are bits of functionality which are called during a Pipes lifecycle.
abstract CONFIGURATION	pageConfig(PageConfig pageConfig) Paging is controlled and managed by the pageConfig objects
abstract CONFIGURATION	requestBuilder(RequestBuilder builder) Request builders are responsible for serializing the objects provided to the Pipe into binary streams for consumption by a service.
abstract CONFIGURATION	responseParser(ResponseParser responseParser) Response Parsers turn service responses into Objects for the Pipe.
CONFIGURATION	setName(String name) The name is the key which is used to reference the created pipe in PipeManager.
CONFIGURATION	setOnPipeCreatedListeners(Collection<OnPipeCreatedListener> listeners) OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.
abstract CONFIGURATION	timeout(Integer timeout) Because of their async nature, Pipes need to have a timeout which will error if reached.
abstract CONFIGURATION	withUrl(URL url) The URL is a location of some resource or service the Pipe will interact with.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipeConfiguration

public PipeConfiguration()

Method Detail

getName

public String getName()

The name is the key which is used to reference the created pipe in PipeManager.

Specified by:

getName in interface org.jboss.aerogear.android.core.Config<CONFIGURATION extends PipeConfiguration<CONFIGURATION>>

Returns:

the current name

setName

public CONFIGURATION setName(String name)

The name is the key which is used to reference the created pipe in PipeManager.

Specified by:

setName in interface org.jboss.aerogear.android.core.Config<CONFIGURATION extends PipeConfiguration<CONFIGURATION>>

Parameters:

name - new name

Returns:

this configuration for chaining.

getOnPipeCreatedListeners

public Collection<OnPipeCreatedListener> getOnPipeCreatedListeners()

OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.

Returns:

the current collection.

addOnPipeCreatedListener

public CONFIGURATION addOnPipeCreatedListener(OnPipeCreatedListener listener)

OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.

Parameters:

listener - new listener to add to the collection

Returns:

this configuration

setOnPipeCreatedListeners

public CONFIGURATION setOnPipeCreatedListeners(Collection<OnPipeCreatedListener> listeners)

OnPipeCreatedListseners are a collection of classes to be notified when the configuration of the Pipe is complete.

Parameters:

listeners - new collection to replace the current one

Returns:

this configuration

forClass

public final <DATA> Pipe<DATA> forClass(Class<DATA> aClass)

Creates a pipe based on the current configuration and notifies all listeners

Type Parameters:

DATA - The data type of the Pipe

Parameters:

aClass - The data type class of the Pipe

Returns:

A pipe based on this configuration

Throws:

IllegalStateException - if the Pipe can not be constructed.

buildPipeForClass

protected abstract <DATA> Pipe<DATA> buildPipeForClass(Class<DATA> aClass)

Validates configuration parameters and returns a Pipe instance.

Type Parameters:

DATA - The data type of the Pipe

Parameters:

aClass - The data type class of the Pipe

Returns:

A pipe based on this configuration

Throws:

IllegalStateException - if the Pipe can not be constructed.

withUrl

public abstract CONFIGURATION withUrl(URL url)

The URL is a location of some resource or service the Pipe will interact with.

Parameters:

url - the base URL the pipe will build upon.

Returns:

this configuration

module

public abstract CONFIGURATION module(PipeModule module)

Modules are bits of functionality which are called during a Pipes lifecycle.

Parameters:

module - a module to add to the lifecycle.

Returns:

this configuration

getModules

public abstract List<PipeModule> getModules()

Modules are bits of functionality which are called during a Pipes lifecycle.

Returns:

the current List of Modules

timeout

public abstract CONFIGURATION timeout(Integer timeout)

Because of their async nature, Pipes need to have a timeout which will error if reached.

Parameters:

timeout - an amount of time in milliseconds.

Returns:

this configuration

pageConfig

public abstract CONFIGURATION pageConfig(PageConfig pageConfig)

Paging is controlled and managed by the pageConfig objects

Parameters:

pageConfig - a pageConfiguration

Returns:

this configuration

requestBuilder

public abstract CONFIGURATION requestBuilder(RequestBuilder builder)

Request builders are responsible for serializing the objects provided to the Pipe into binary streams for consumption by a service.

Parameters:

builder - the requestBuilder

Returns:

this configuration

responseParser

public abstract CONFIGURATION responseParser(ResponseParser responseParser)

Response Parsers turn service responses into Objects for the Pipe.

Parameters:

responseParser - a resonse Parser instance

Returns:

this configuration