org.eclipse.soda.dk.parameter
Class TagParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.Parameter
          org.eclipse.soda.dk.parameter.TagParameter

All Implemented Interfaces:

DataParameterService, ParameterService

public class TagParameter
extends Parameter

The TagParameter class implements the ParameterService interface.

Version:

1.0.0

See Also:

Parameter, ParameterService, String

Field Summary

Fields inherited from class org.eclipse.soda.dk.parameter.Parameter

MASKS, SET_MASKS, SET_TOP_MASKS

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE

Fields inherited from interface org.eclipse.soda.dk.parameter.service.ParameterService

ARRAY, ASCII, ASCIIZ, BOOLEAN, BYTE, BYTES, DOUBLE, FLOAT, HEXASCII, HEXSTRING, INSERT, INTEGER, LITTLEENDIAN, LONG, NASCII, NSTRING, NULL, SHORT, STRING, UNSIGNED

Constructor Summary

TagParameter(java.lang.String key, java.lang.String tag)
Constructs an instance of this class from the specified key and tag parameters.

TagParameter(java.lang.String key, java.lang.String tag, short style)
Constructs an instance of this class from the specified key, tag and style parameters.

TagParameter(java.lang.String key, TransformService transform, java.lang.String tag)
Constructs an TagParameter object using the input parameter(s).

TagParameter(java.lang.String key, TransformService transform, java.lang.String tag, short style)
Constructs an TagParameter object using the input parameter(s).

Method Summary

java.lang.Object	decodeValue(MessageService message) Perform the decodeValue method and return the Object result.
MessageService	encodeValue(MessageService message, java.lang.Object value) Perform the encodeValue method and return the MessageService result.
java.lang.String	getEndTag() Gets the String endTag property value.
java.lang.String	getStartTag() Gets the String startTag property value.

Methods inherited from class org.eclipse.soda.dk.parameter.Parameter

decode, decodeBytes, decodeEnd, decodeMessage, decodeString, encode, encodeBegin, encodeBytes, encodeMessage, encodeString, equals, getDefaultStyle, getKey, getLong, getStyle, getTransform, getTypeStyle, isArray, isInsert, isLittleEndian, isUnsigned, setBits, setKey, setStyle, setTransform

Methods inherited from class org.eclipse.soda.dk.core.EscObject

attemptRecoveryFromError, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getErrorSeverity, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getResource, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

TagParameter

public TagParameter(java.lang.String key,
                    java.lang.String tag)

Constructs an instance of this class from the specified key and tag parameters.

Parameters:

key - The key (String) parameter.

tag - The tag (String) parameter.

See Also:

TagParameter(String,String,short), TagParameter(String,TransformService,String,short), TagParameter(String,TransformService,String)

TagParameter

public TagParameter(java.lang.String key,
                    java.lang.String tag,
                    short style)

Constructs an instance of this class from the specified key, tag and style parameters.

Parameters:

key - The key (String) parameter.

tag - The tag (String) parameter.

style - The style (short) parameter.

See Also:

TagParameter(String,String), TagParameter(String,TransformService,String,short), TagParameter(String,TransformService,String)

TagParameter

public TagParameter(java.lang.String key,
                    TransformService transform,
                    java.lang.String tag,
                    short style)

Constructs an TagParameter object using the input parameter(s).

Parameters:

key - The parameter key.

transform - org.eclipse.soda.dk.transform.service.TransformService

tag - The parameter tag.

style - short

See Also:

TagParameter(String,String), TagParameter(String,String,short), TagParameter(String,TransformService,String)

TagParameter

public TagParameter(java.lang.String key,
                    TransformService transform,
                    java.lang.String tag)

Constructs an TagParameter object using the input parameter(s).

Parameters:

key - The parameter key.

transform - org.eclipse.soda.dk.transform.service.TransformService

tag - The parameter tag.

See Also:

TagParameter(String,String), TagParameter(String,String,short), TagParameter(String,TransformService,String,short)

Method Detail

decodeValue

public java.lang.Object decodeValue(MessageService message)

Perform the decodeValue method and return the Object result.

Specified by:

decodeValue in interface ParameterService

Overrides:

decodeValue in class Parameter

Parameters:

message - org.eclipse.soda.dk.message.service.MessageService

Returns:

Results of the decode value (Object) value.

See Also:

ParameterService.decodeValue(org.eclipse.soda.dk.message.service.MessageService), encodeValue(MessageService,Object)

encodeValue

public MessageService encodeValue(MessageService message,
                                  java.lang.Object value)

Perform the encodeValue method and return the MessageService result.

Specified by:

encodeValue in interface ParameterService

Overrides:

encodeValue in class Parameter

Parameters:

message - org.eclipse.soda.dk.message.service.MessageService

value - java.lang.Object

Returns:

Results of the encode value (MessageService) value.

See Also:

ParameterService.encodeValue(org.eclipse.soda.dk.message.service.MessageService, java.lang.Object), decodeValue(MessageService)

getEndTag

public java.lang.String getEndTag()

Gets the String endTag property value.

Returns:

Results of the get end tag (String) value.

getStartTag

public java.lang.String getStartTag()

Gets the String startTag property value.

Returns:

Results of the get start tag (String) value.