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

Class AbstractSubstringMask

java.lang.Object

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

com.aquima.interactions.framework.mask.impl.AbstractSubstringMask

All Implemented Interfaces:

IMask

Direct Known Subclasses:

FirstToUpperCase, SetCase

public abstract class AbstractSubstringMask
extends AbstractMask

Abstract mask class to parse the following optional parameters.

• start-index: start string mask at index.
• end-index: stop string mask at index.

Since:

6.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
AbstractSubstringMask()

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 abstract String	applyStringValue(StringValue stringValue, IMaskContext context)
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

AbstractSubstringMask

public AbstractSubstringMask()

Method Details

applyStringValue

protected abstract String applyStringValue(StringValue stringValue,
 IMaskContext context)
                                    throws Exception

Throws:

Exception

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.