Package com.tibco.ep.tcs.runtime.config

Class DataInputOutputPortConfig

java.lang.Object

com.tibco.ep.tcs.runtime.config.BaseConfig

com.tibco.ep.tcs.runtime.config.BasePortConfig

com.tibco.ep.tcs.runtime.config.DataInputOutputPortConfig

Direct Known Subclasses:

DataInputPortConfig, DataOutputPortConfig

public abstract class DataInputOutputPortConfig
extends BasePortConfig

A class describing a data input or output block port. Enhances the base port configuration with a name and a port number. Constructs only from HOCON, since data input/output block configurations are only produced from HOCON.

Field Summary

Fields

Modifier and Type	Field	Description
static int	UNSET_PORT_NUMBER	Value for an unset port number.

Constructor Summary

Constructors

Constructor	Description
DataInputOutputPortConfig()	Create a new empty port configuration.
DataInputOutputPortConfig(com.typesafe.config.Config config)	Create a new port from the specified HOCON configuration.

Method Summary

Modifier and Type	Method	Description
protected void	fillMap(Map<String,Object> props)	Add this object's properties to the specified map.
String	getName()	Return this port's name.
int	getPortNumber()	Return this port's number, UNSET_PORT_NUMBER if unset.
DataInputOutputPortConfig	setDescription(String description)	Set this port's description, null if none.
DataInputOutputPortConfig	setName(String name)	Set this port's name.
DataInputOutputPortConfig	setPortNumber(int portNumber)	Set this port's number, UNSET_PORT_NUMBER if none
DataInputOutputPortConfig	setRequired(boolean required)	Set true if the port is required, false otherwise.

Methods inherited from class com.tibco.ep.tcs.runtime.config.BasePortConfig

getDescription, isRequired

Methods inherited from class com.tibco.ep.tcs.runtime.config.BaseConfig

toHOCON

Methods inherited from class java.lang.Object

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

Field Detail

UNSET_PORT_NUMBER

public static final int UNSET_PORT_NUMBER

Value for an unset port number.

See Also:

Constant Field Values

Constructor Detail

DataInputOutputPortConfig

public DataInputOutputPortConfig()

Create a new empty port configuration.

DataInputOutputPortConfig

public DataInputOutputPortConfig(com.typesafe.config.Config config)

Create a new port from the specified HOCON configuration.

Parameters:

config - source HOCON configuration

Method Detail

getName

public String getName()

Return this port's name.

Returns:

port name

setName

public DataInputOutputPortConfig setName(String name)

Set this port's name.

Parameters:

name - port name

Returns:

this object

getPortNumber

public int getPortNumber()

Return this port's number, UNSET_PORT_NUMBER if unset.

Returns:

port number

setPortNumber

public DataInputOutputPortConfig setPortNumber(int portNumber)

Set this port's number, UNSET_PORT_NUMBER if none

Parameters:

portNumber - port number

Returns:

this object

setRequired

public DataInputOutputPortConfig setRequired(boolean required)

Set true if the port is required, false otherwise.

Overrides:

setRequired in class BasePortConfig

Parameters:

required - true if required, false otherwise

Returns:

this object

setDescription

public DataInputOutputPortConfig setDescription(String description)

Set this port's description, null if none.

Overrides:

setDescription in class BasePortConfig

Parameters:

description - description, null if none

Returns:

this object

fillMap

protected void fillMap(Map<String,Object> props)

Add this object's properties to the specified map.

Overrides:

fillMap in class BasePortConfig

Parameters:

props - map to fill