Module com.pi4j

Package com.pi4j.registry

Interface Registry

All Superinterfaces:

Describable

public interface Registry
extends Describable

Registry interface.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

Method Summary

Modifier and Type	Method	Description
Map<String,? extends IO>	all()	all.
default <P extends Provider> Map<String,? extends IO>	allByIoType(IOType ioType)	allByIoType.
default <P extends Provider> Map<String,? extends IO>	allByProvider(Class<P> providerClass)	allByProvider.
default <P extends Provider> Map<String,? extends IO>	allByProvider(String providerId)	allByProvider.
default <P extends Provider,T extends IO> Map<String,T>	allByProvider(String providerId, Class<T> ioClass)	allByProvider.
default <T extends IO> Map<String,T>	allByType(Class<T> ioClass)	allByType.
default Descriptor	describe()	describe.
boolean	exists(String id)	exists.
boolean	exists(String id, Class<? extends IO> type)	exists.
<T extends IO> T	get(String id)	get.
<T extends IO> T	get(String id, Class<T> type)	get.

Method Detail

exists

boolean exists(String id,
               Class<? extends IO> type)

exists.

Parameters:

id - a String object.

type - a Class object.

Returns:

a boolean.

exists

boolean exists(String id)

exists.

Parameters:

id - a String object.

Returns:

a boolean.

all

Map<String,? extends IO> all()

all.

Returns:

a Map object.

get

<T extends IO> T get(String id)
              throws IOInvalidIDException,
                     IONotFoundException

get.

Type Parameters:

T - a T object.

Parameters:

id - a String object.

Returns:

a T object.

Throws:

IOInvalidIDException - if any.

IONotFoundException - if any.

get

<T extends IO> T get(String id,
                     Class<T> type)
              throws IOInvalidIDException,
                     IONotFoundException

get.

Type Parameters:

T - a T object.

Parameters:

id - a String object.

type - a Class object.

Returns:

a T object.

Throws:

IOInvalidIDException - if any.

IONotFoundException - if any.

allByType

default <T extends IO> Map<String,T> allByType(Class<T> ioClass)

allByType.

Type Parameters:

T - a T object.

Parameters:

ioClass - a Class object.

Returns:

a Map object.

allByIoType

default <P extends Provider> Map<String,? extends IO> allByIoType(IOType ioType)

allByIoType.

Type Parameters:

P - a P object.

Parameters:

ioType - a IOType object.

Returns:

a Map object.

allByProvider

default <P extends Provider> Map<String,? extends IO> allByProvider(Class<P> providerClass)

allByProvider.

Type Parameters:

P - a P object.

Parameters:

providerClass - a Class object.

Returns:

a Map object.

allByProvider

default <P extends Provider> Map<String,? extends IO> allByProvider(String providerId)

allByProvider.

Type Parameters:

P - a P object.

Parameters:

providerId - a String object.

Returns:

a Map object.

allByProvider

default <P extends Provider,T extends IO> Map<String,T> allByProvider(String providerId,
                                                                                  Class<T> ioClass)

allByProvider.

Type Parameters:

P - a P object.

T - a T object.

Parameters:

providerId - a String object.

ioClass - a Class object.

Returns:

a Map object.

describe

default Descriptor describe()

describe.

Specified by:

describe in interface Describable

Returns:

a Descriptor object.