Package com.aquima.interactions.framework.mask.impl

Class NumberPattern

java.lang.Object

com.aquima.interactions.framework.mask.impl.AbstractMask

com.aquima.interactions.framework.mask.impl.NumberPattern

All Implemented Interfaces:

IMask

public class NumberPattern
extends AbstractMask

This mask applies a number format with a specific pattern to an numerical value. See com.aquima.interactions.foundation.text.NumberFormat for more pattern information.

Required parameter:

• pattern: the pattern to use.

Optional parameters:

• prefix: string used as prefix.
• postfix: string used as postfix.
• zero-fraction: string that replaces the fraction part if the formatted value ends with 0 fraction (i.e. 10.00 -> 10.-)

Supported datatypes: integer, number, currency, percentage.

Since:

6.0

Author:

Jon van Leuven

See Also:

• NumberFormat

Constructor Summary

Constructors

Constructor	Description
NumberPattern()

Method Summary

Modifier and Type	Method	Description
protected String	applySingleValue(ISingleValue singleValue, IMaskContext context, ILanguage language)	This method is called when this mask is applied.
protected DataType[]	getValidDataTypes()	Should return the datatypes for which this mask can be applied.

Methods inherited from class com.aquima.interactions.framework.mask.impl.AbstractMask

apply

Methods inherited from class java.lang.Object

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

Constructor Details

NumberPattern

public NumberPattern()

Method Details

applySingleValue

protected String applySingleValue(ISingleValue singleValue,
 IMaskContext context,
 ILanguage language)
                           throws Exception

Description copied from class: AbstractMask

This method is called when this mask is applied.

Specified by:

applySingleValue in class AbstractMask

Parameters:

singleValue - The value, never null and never unknown.

context - Mask context

language - the language

Returns:

The applied mask result.

Throws:

Exception - When something went wrong.

getValidDataTypes

protected DataType[] getValidDataTypes()

Description copied from class: AbstractMask

Should return the datatypes for which this mask can be applied.

Specified by:

getValidDataTypes in class AbstractMask

Returns:

Array of datatypes.