de.aristaflow.adept2.model.common.systemdata

Class AbstractSystemDataFormatter

java.lang.Object

de.aristaflow.adept2.model.common.systemdata.AbstractSystemDataFormatter

All Implemented Interfaces:

SystemDataFormatter

Direct Known Subclasses:

BasicSystemDataFormatter

public abstract class AbstractSystemDataFormatter
extends java.lang.Object
implements SystemDataFormatter

An abstract implementation of SystemDataFormatter providing to helper methods to ensure the presence of a value and the correctness of its type in the provided map.

Author:

Patrick Schmidt

Constructor Summary

Constructors

Constructor and Description
AbstractSystemDataFormatter()

Method Summary

Modifier and Type	Method and Description
protected void	ensureCorrectType(ProcessConstants.AdeptDataType expectedType, java.lang.String udtName, java.io.Serializable value) Throws an IllegalArgumentException if the given object doesn't the specified data type and simply returns if it does.
protected void	ensureValuePresent(java.lang.String parameterName, java.util.Map<java.lang.String,? extends java.io.Serializable> parameterValues) Simply returns if the specified parameter value is present and throws an IllegalArgumentException if it isn't.
java.lang.String	format(java.lang.String parameterisedString, java.util.Map<java.lang.String,java.io.Serializable> parameterValues) Formats the given parameterised string according to the needs of the SystemDataConsumer it is used by.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.aristaflow.adept2.model.common.systemdata.SystemDataFormatter

format

Constructor Detail

AbstractSystemDataFormatter

public AbstractSystemDataFormatter()

Method Detail

ensureValuePresent

protected void ensureValuePresent(java.lang.String parameterName,
                                  java.util.Map<java.lang.String,? extends java.io.Serializable> parameterValues)

Simply returns if the specified parameter value is present and throws an IllegalArgumentException if it isn't.

Parameters:

parameterName - name of the parameter

parameterValues - map containing the parameter values

Throws:

java.lang.IllegalArgumentException - if the value is not present (i.e. the key is missing in the map; the value may be null though)

ensureCorrectType

protected void ensureCorrectType(ProcessConstants.AdeptDataType expectedType,
                                 java.lang.String udtName,
                                 java.io.Serializable value)

Throws an IllegalArgumentException if the given object doesn't the specified data type and simply returns if it does.

Parameters:

expectedType - the expected data type

udtName - The name of the user-defined type if specified and known, null otherwise.

value - the value object

Throws:

java.lang.IllegalArgumentException - if the object's type doesn't match the expected data type

format

public java.lang.String format(java.lang.String parameterisedString,
                               java.util.Map<java.lang.String,java.io.Serializable> parameterValues)

Description copied from interface: SystemDataFormatter

Formats the given parameterised string according to the needs of the SystemDataConsumer it is used by.

Specified by:

format in interface SystemDataFormatter

Parameters:

parameterisedString - the parameterised string to be formatted

parameterValues - map containing values for all parameters referenced in the parameterised string

Returns:

the formatted string