Module com.pi4j

Package com.pi4j.context

Interface ContextBuilder

All Superinterfaces:

Builder<Context>

public interface ContextBuilder
extends Builder<Context>

ContextBuilder interface.

Version:

$Id: $Id

Author:

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

Method Summary

Modifier and Type	Method	Description
ContextBuilder	add(Platform... platform)	add.
ContextBuilder	add(Provider... provider)	add.
default ContextBuilder	add(Properties properties)	add.
default ContextBuilder	add(Properties properties, String prefixFilter)	add.
default ContextBuilder	addDefaultPlatform(Platform platform)	addDefaultPlatform.
default ContextBuilder	addPlatform(Platform... platform)	addPlatform.
default ContextBuilder	addPlatform(Provider... provider)	addPlatform.
default ContextBuilder	addProperties(File file)	addProperties.
default ContextBuilder	addProperties(File file, String prefixFilter)	addProperties.
default ContextBuilder	addProperties(InputStream stream)	addProperties.
default ContextBuilder	addProperties(InputStream stream, String prefixFilter)	addProperties.
default ContextBuilder	addProperties(Reader reader)	addProperties.
default ContextBuilder	addProperties(Reader reader, String prefixFilter)	addProperties.
default ContextBuilder	addProperties(Map<String,String> properties)	addProperties.
default ContextBuilder	addProperties(Map<String,String> properties, String prefixFilter)	addProperties.
default ContextBuilder	addProperties(Properties properties)	addProperties.
default ContextBuilder	addProperties(Properties properties, String prefixFilter)	addProperties.
default ContextBuilder	addProperty(String key, String value)	addProperty.
default ContextBuilder	addProperty(Map.Entry<String,String>... value)	addProperty.
default ContextBuilder	autoDetect()	autoDetect.
ContextBuilder	autoDetectPlatforms()	autoDetectPlatforms.
ContextBuilder	autoDetectProviders()	autoDetectProviders.
ContextBuilder	autoInject()	autoInject.
String	defaultPlatform()	defaultPlatform.
default ContextBuilder	defaultPlatform(Platform platform)	defaultPlatform.
ContextBuilder	defaultPlatform(String platformId)	defaultPlatform.
static ContextBuilder	newInstance()	newInstance.
default ContextBuilder	noAutoDetect()	noAutoDetect.
ContextBuilder	noAutoDetectPlatforms()	noAutoDetectPlatforms.
ContextBuilder	noAutoDetectProviders()	noAutoDetectProviders.
ContextBuilder	noAutoInject()	noAutoInject.
default ContextBuilder	properties(File file)	properties.
ContextBuilder	properties(File file, String prefixFilter)	properties.
default ContextBuilder	properties(InputStream stream)	properties.
ContextBuilder	properties(InputStream stream, String prefixFilter)	properties.
default ContextBuilder	properties(Reader reader)	properties.
ContextBuilder	properties(Reader reader, String prefixFilter)	properties.
ContextBuilder	properties(Map<String,String> values)	properties.
ContextBuilder	properties(Map<String,String> properties, String prefixFilter)	properties.
default ContextBuilder	properties(Properties properties)	properties.
ContextBuilder	properties(Properties properties, String prefixFilter)	properties.
ContextBuilder	property(String key, String value)	property.
ContextBuilder	property(Map.Entry<String,String>... value)	property.
default ContextBuilder	setAutoDetect(boolean autoDetect)	setAutoDetect.
default ContextBuilder	setAutoInject(boolean autoInject)	setAutoInject.
default ContextBuilder	setDefaultPlatform(Platform platform)	setDefaultPlatform.
default ContextBuilder	setDefaultPlatform(String platformId)	setDefaultPlatform.
ContextConfig	toConfig()	toConfig.

Methods inherited from interface com.pi4j.config.Builder

build

Method Details

newInstance

static ContextBuilder newInstance()

newInstance.

Returns:

a ContextBuilder object.

add

ContextBuilder add(Platform... platform)

add.

Parameters:

platform - a Platform object.

Returns:

a ContextBuilder object.

add

ContextBuilder add(Provider... provider)

add.

Parameters:

provider - a Provider object.

Returns:

a ContextBuilder object.

defaultPlatform

String defaultPlatform()

defaultPlatform.

Returns:

a String object.

defaultPlatform

ContextBuilder defaultPlatform(String platformId)

defaultPlatform.

Parameters:

platformId - a String object.

Returns:

a ContextBuilder object.

autoDetectPlatforms

ContextBuilder autoDetectPlatforms()

autoDetectPlatforms.

Returns:

a ContextBuilder object.

noAutoDetectPlatforms

ContextBuilder noAutoDetectPlatforms()

noAutoDetectPlatforms.

Returns:

a ContextBuilder object.

autoDetectProviders

ContextBuilder autoDetectProviders()

autoDetectProviders.

Returns:

a ContextBuilder object.

noAutoDetectProviders

ContextBuilder noAutoDetectProviders()

noAutoDetectProviders.

Returns:

a ContextBuilder object.

autoInject

ContextBuilder autoInject()

autoInject.

Returns:

a ContextBuilder object.

noAutoInject

ContextBuilder noAutoInject()

noAutoInject.

Returns:

a ContextBuilder object.

setAutoInject

default ContextBuilder setAutoInject(boolean autoInject)

setAutoInject.

Parameters:

autoInject - a boolean.

Returns:

a ContextBuilder object.

toConfig

ContextConfig toConfig()

toConfig.

Returns:

a ContextConfig object.

setAutoDetect

default ContextBuilder setAutoDetect(boolean autoDetect)

setAutoDetect.

Parameters:

autoDetect - a boolean.

Returns:

a ContextBuilder object.

autoDetect

default ContextBuilder autoDetect()

autoDetect.

Returns:

a ContextBuilder object.

noAutoDetect

default ContextBuilder noAutoDetect()

noAutoDetect.

Returns:

a ContextBuilder object.

addPlatform

default ContextBuilder addPlatform(Platform... platform)

addPlatform.

Parameters:

platform - a Platform object.

Returns:

a ContextBuilder object.

addPlatform

default ContextBuilder addPlatform(Provider... provider)

addPlatform.

Parameters:

provider - a Provider object.

Returns:

a ContextBuilder object.

addDefaultPlatform

default ContextBuilder addDefaultPlatform(Platform platform)

addDefaultPlatform.

Parameters:

platform - a Platform object.

Returns:

a ContextBuilder object.

defaultPlatform

default ContextBuilder defaultPlatform(Platform platform)

defaultPlatform.

Parameters:

platform - a Platform object.

Returns:

a ContextBuilder object.

setDefaultPlatform

default ContextBuilder setDefaultPlatform(String platformId)

setDefaultPlatform.

Parameters:

platformId - a String object.

Returns:

a ContextBuilder object.

setDefaultPlatform

default ContextBuilder setDefaultPlatform(Platform platform)

setDefaultPlatform.

Parameters:

platform - a Platform object.

Returns:

a ContextBuilder object.

property

ContextBuilder property(String key,
 String value)

property.

Parameters:

key - a String object.

value - a String object.

Returns:

a ContextBuilder object.

property

ContextBuilder property(Map.Entry<String,String>... value)

property.

Parameters:

value - a Map.Entry object.

Returns:

a ContextBuilder object.

properties

ContextBuilder properties(Map<String,String> values)

properties.

Parameters:

values - a Map object.

Returns:

a ContextBuilder object.

properties

ContextBuilder properties(Map<String,String> properties,
 String prefixFilter)

properties.

Parameters:

properties - a Map object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

properties

ContextBuilder properties(Properties properties,
 String prefixFilter)

properties.

Parameters:

properties - a Properties object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

properties

ContextBuilder properties(InputStream stream,
 String prefixFilter)
                   throws IOException

properties.

Parameters:

stream - a InputStream object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing stream.

properties

ContextBuilder properties(Reader reader,
 String prefixFilter)
                   throws IOException

properties.

Parameters:

reader - a Reader object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing reader.

properties

ContextBuilder properties(File file,
 String prefixFilter)
                   throws IOException

properties.

Parameters:

file - a File object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing file.

properties

default ContextBuilder properties(Properties properties)

properties.

Parameters:

properties - a Properties object.

Returns:

a ContextBuilder object.

properties

default ContextBuilder properties(InputStream stream)
                           throws IOException

properties.

Parameters:

stream - a InputStream object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing stream.

properties

default ContextBuilder properties(Reader reader)
                           throws IOException

properties.

Parameters:

reader - a Reader object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing reader.

properties

default ContextBuilder properties(File file)
                           throws IOException

properties.

Parameters:

file - a File object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing file.

addProperty

default ContextBuilder addProperty(String key,
 String value)

addProperty.

Parameters:

key - a String object.

value - a String object.

Returns:

a ContextBuilder object.

addProperty

default ContextBuilder addProperty(Map.Entry<String,String>... value)

addProperty.

Parameters:

value - a Map.Entry object.

Returns:

a ContextBuilder object.

addProperties

default ContextBuilder addProperties(Properties properties,
 String prefixFilter)

addProperties.

Parameters:

properties - a Properties object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

addProperties

default ContextBuilder addProperties(Properties properties)

addProperties.

Parameters:

properties - a Properties object.

Returns:

a ContextBuilder object.

addProperties

default ContextBuilder addProperties(Map<String,String> properties)

addProperties.

Parameters:

properties - a Map object.

Returns:

a ContextBuilder object.

addProperties

default ContextBuilder addProperties(Map<String,String> properties,
 String prefixFilter)

addProperties.

Parameters:

properties - a Map object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

addProperties

default ContextBuilder addProperties(InputStream stream)
                              throws IOException

addProperties.

Parameters:

stream - a InputStream object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing stream.

addProperties

default ContextBuilder addProperties(InputStream stream,
 String prefixFilter)
                              throws IOException

addProperties.

Parameters:

stream - a InputStream object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing stream.

addProperties

default ContextBuilder addProperties(Reader reader)
                              throws IOException

addProperties.

Parameters:

reader - a Reader object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing reader.

addProperties

default ContextBuilder addProperties(Reader reader,
 String prefixFilter)
                              throws IOException

addProperties.

Parameters:

reader - a Reader object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing reader.

addProperties

default ContextBuilder addProperties(File file)
                              throws IOException

addProperties.

Parameters:

file - a File object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing file.

addProperties

default ContextBuilder addProperties(File file,
 String prefixFilter)
                              throws IOException

addProperties.

Parameters:

file - a File object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

Throws:

IOException - if an error occurs accessing file.

add

default ContextBuilder add(Properties properties,
 String prefixFilter)

add.

Parameters:

properties - a Properties object.

prefixFilter - a String object.

Returns:

a ContextBuilder object.

add

default ContextBuilder add(Properties properties)

add.

Parameters:

properties - a Properties object.

Returns:

a ContextBuilder object.