Module com.pi4j

Package com.pi4j.config

Interface ConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>

All Superinterfaces:

Builder<CONFIG_TYPE>

All Known Subinterfaces:

AddressConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, AnalogConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, AnalogInputConfigBuilder, AnalogOutputConfigBuilder, DeviceConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, DigitalConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, DigitalInputConfigBuilder, DigitalOutputConfigBuilder, com.pi4j.io.gpio.GpioConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, I2CConfigBuilder, IOAddressConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, IOConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, IODeviceConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>, PwmConfigBuilder, SerialConfigBuilder, SpiConfigBuilder

public interface ConfigBuilder<BUILDER_TYPE,CONFIG_TYPE>
extends Builder<CONFIG_TYPE>

ConfigBuilder interface.

Version:

$Id: $Id

Author:

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

Method Summary

Modifier and Type	Method	Description
default BUILDER_TYPE	allowInheritProperties()	allowInheritProperties.
BUILDER_TYPE	description(String description)	description.
default BUILDER_TYPE	disallowInheritProperties()	disallowInheritProperties.
String	id()
BUILDER_TYPE	id(String id)	id.
BUILDER_TYPE	inheritProperties(Boolean allow)	inheritProperties.
BUILDER_TYPE	load(File file)	load.
BUILDER_TYPE	load(File file, String prefixFilter)	load.
BUILDER_TYPE	load(InputStream stream)	load.
BUILDER_TYPE	load(InputStream stream, String prefixFilter)	load.
BUILDER_TYPE	load(Reader reader)	load.
BUILDER_TYPE	load(Reader reader, String prefixFilter)	load.
BUILDER_TYPE	load(Map<String,String> properties)	load.
BUILDER_TYPE	load(Map<String,String> properties, String prefixFilter)	load.
BUILDER_TYPE	load(Properties properties)	load.
BUILDER_TYPE	load(Properties properties, String prefixFilter)	load.
BUILDER_TYPE	name(String name)	name.

Methods inherited from interface com.pi4j.config.Builder

build

Method Details

id

BUILDER_TYPE id(String id)

id.

Parameters:

id - a String object.

Returns:

a BUILDER_TYPE object.

id

String id()

name

BUILDER_TYPE name(String name)

name.

Parameters:

name - a String object.

Returns:

a BUILDER_TYPE object.

description

BUILDER_TYPE description(String description)

description.

Parameters:

description - a String object.

Returns:

a BUILDER_TYPE object.

inheritProperties

BUILDER_TYPE inheritProperties(Boolean allow)

inheritProperties.

Parameters:

allow - a Boolean object.

Returns:

a BUILDER_TYPE object.

allowInheritProperties

default BUILDER_TYPE allowInheritProperties()

allowInheritProperties.

Returns:

a BUILDER_TYPE object.

disallowInheritProperties

default BUILDER_TYPE disallowInheritProperties()

disallowInheritProperties.

Returns:

a BUILDER_TYPE object.

load

BUILDER_TYPE load(Map<String,String> properties)

load.

Parameters:

properties - a Map object.

Returns:

a BUILDER_TYPE object.

load

BUILDER_TYPE load(Properties properties)

load.

Parameters:

properties - a Properties object.

Returns:

a BUILDER_TYPE object.

load

BUILDER_TYPE load(Map<String,String> properties,
 String prefixFilter)

load.

Parameters:

properties - a Map object.

prefixFilter - a String object.

Returns:

a BUILDER_TYPE object.

load

BUILDER_TYPE load(Properties properties,
 String prefixFilter)

load.

Parameters:

properties - a Properties object.

prefixFilter - a String object.

Returns:

a BUILDER_TYPE object.

load

BUILDER_TYPE load(InputStream stream)
           throws IOException

load.

Parameters:

stream - a InputStream object.

Returns:

a BUILDER_TYPE object.

Throws:

IOException - if an error occurs accessing stream.

load

BUILDER_TYPE load(InputStream stream,
 String prefixFilter)
           throws IOException

load.

Parameters:

stream - a InputStream object.

prefixFilter - a String object.

Returns:

a BUILDER_TYPE object.

Throws:

IOException - if an error occurs accessing stream.

load

BUILDER_TYPE load(Reader reader)
           throws IOException

load.

Parameters:

reader - a Reader object.

Returns:

a BUILDER_TYPE object.

Throws:

IOException - if an error occurs accessing reader.

load

BUILDER_TYPE load(Reader reader,
 String prefixFilter)
           throws IOException

load.

Parameters:

reader - a Reader object.

prefixFilter - a String object.

Returns:

a BUILDER_TYPE object.

Throws:

IOException - if an error occurs accessing reader.

load

BUILDER_TYPE load(File file)
           throws IOException

load.

Parameters:

file - a File object.

Returns:

a BUILDER_TYPE object.

Throws:

IOException - if an error occurs accessing file.

load

BUILDER_TYPE load(File file,
 String prefixFilter)
           throws IOException

load.

Parameters:

file - a File object.

prefixFilter - a String object.

Returns:

a BUILDER_TYPE object.

Throws:

IOException - if an error occurs accessing file.