Package com.tibco.ep.tcs.runtime.config
Class ModuleBlockPortConfig
- java.lang.Object
-
- com.tibco.ep.tcs.runtime.config.BaseConfig
-
- com.tibco.ep.tcs.runtime.config.BasePortConfig
-
- com.tibco.ep.tcs.runtime.config.ModuleBlockPortConfig
-
public final class ModuleBlockPortConfig extends BasePortConfig
A class describing a module block input or output port. Enhances the base port configuration with a stream path.
-
-
Constructor Summary
Constructors Constructor Description ModuleBlockPortConfig()
Create a new module block port.ModuleBlockPortConfig(IModuleBlockPort source)
Create a new port from the specified interface source.ModuleBlockPortConfig(com.typesafe.config.Config config)
Create a new port from HOCON configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillMap(Map<String,Object> props)
Add this object's properties to the specified map.String
getStreamName()
Return the EventFlow path, sans container name, of the module stream bound to this port.ModuleBlockPortConfig
setDescription(String description)
Set this port's description, null if none.ModuleBlockPortConfig
setRequired(boolean required)
Set true if the port is required, false otherwise.ModuleBlockPortConfig
setStreamName(String streamName)
Set this port's stream name.-
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
-
-
-
-
Constructor Detail
-
ModuleBlockPortConfig
public ModuleBlockPortConfig()
Create a new module block port.
-
ModuleBlockPortConfig
public ModuleBlockPortConfig(IModuleBlockPort source)
Create a new port from the specified interface source.
- Parameters:
source
- source instance
-
ModuleBlockPortConfig
public ModuleBlockPortConfig(com.typesafe.config.Config config)
Create a new port from HOCON configuration.
- Parameters:
config
- HOCON representation of the port
-
-
Method Detail
-
getStreamName
public String getStreamName()
Return the EventFlow path, sans container name, of the module stream bound to this port.
- Returns:
- path
-
setStreamName
public ModuleBlockPortConfig setStreamName(String streamName)
Set this port's stream name.
- Parameters:
streamName
- stream name- Returns:
- this object
-
setRequired
public ModuleBlockPortConfig setRequired(boolean required)
Set true if the port is required, false otherwise.
- Overrides:
setRequired
in classBasePortConfig
- Parameters:
required
- true if required, false otherwise- Returns:
- this object
-
setDescription
public ModuleBlockPortConfig setDescription(String description)
Set this port's description, null if none.
- Overrides:
setDescription
in classBasePortConfig
- 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 classBasePortConfig
- Parameters:
props
- map to fill
-
-