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

Class BasePortConfig

java.lang.Object

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

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

Direct Known Subclasses:

DataInputOutputPortConfig, ModuleBlockPortConfig

public abstract class BasePortConfig
extends BaseConfig

A base class describing common port configuration as shared by module, data input, and data output blocks.

Constructor Summary

Constructors

Constructor	Description
BasePortConfig()	Create a new empty port configuration.
BasePortConfig(IBasePort source)	Create a new port from the specified interface source.
BasePortConfig(com.typesafe.config.Config config)	Create a new port from 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	getDescription()	Return the port's description, null if none
boolean	isRequired()	Return true if the port is required, false otherwise.
BasePortConfig	setDescription(String description)	Set this port's description, null if none.
BasePortConfig	setRequired(boolean required)	Set true if the port is required, false otherwise.

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

Constructor Detail

BasePortConfig

public BasePortConfig()

Create a new empty port configuration.

BasePortConfig

public BasePortConfig(IBasePort source)

Create a new port from the specified interface source.

Parameters:

source - source instance

BasePortConfig

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

Create a new port from HOCON configuration.

Parameters:

config - HOCON representation of the port

Method Detail

isRequired

public boolean isRequired()

Return true if the port is required, false otherwise.

Returns:

true or false

setRequired

public BasePortConfig setRequired(boolean required)

Set true if the port is required, false otherwise.

Parameters:

required - true if required, false otherwise

Returns:

this object

getDescription

public String getDescription()

Return the port's description, null if none

Returns:

description, null if none

setDescription

public BasePortConfig setDescription(String description)

Set this port's description, null if none.

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.

Specified by:

fillMap in class BaseConfig

Parameters:

props - map to fill