org.cyclos.utils

Class MaskHelper

java.lang.Object

org.cyclos.utils.MaskHelper

public class MaskHelper
extends java.lang.Object

Helper class for masks

Author:

jcomas

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MASK_VARIABLES

Constructor Summary

Constructors

Constructor and Description
MaskHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	applyMask(java.lang.String mask, java.lang.String value) Removes the given mask from the given value
static int	countPlaceholders(java.lang.String mask) Returns the number of placeholders in the given mask
static java.lang.String	generateMaskedValue(java.lang.String mask) Generates a random masked value according to the mask
static java.lang.String	generateValue(java.lang.String mask) Generates a random (unmasked) value according to the mask
static java.util.List<java.lang.Character>	getAlphabeticVariables()
static java.util.List<java.lang.Character>	getAlphanumericVariables()
static java.lang.String	getExample(java.lang.String mask) Returns an example value which can be used with the given mask
static int	getMaskedValueLength(java.lang.String mask) Returns the length of a value for the given mask
static java.util.List<java.lang.Character>	getNumericVariables()
static int	getUnmaskedValueLength(java.lang.String mask) Returns the length of a value without mask
static boolean	hasValidBeginning(java.lang.String mask, java.lang.String maskedValue) Returns true if the value has a correct beginning for the given mask For example: mask: ##-# value: 1 result: true mask: ##-# value: 11- result: true mask: ##-# value: 11-a result: false
static boolean	isValidMask(java.lang.String mask) Returns true if the mask has a valid syntax
static boolean	isValidMaskedValue(java.lang.String mask, java.lang.String value) Returns true if the value matches the mask.
static java.lang.String	removeMask(java.lang.String mask, java.lang.String value) Removes the given mask from the given value, trimming to mask length. If mask is blank, value is null or not a valid masked then value is returned as is.
static java.lang.String	removeMask(java.lang.String mask, java.lang.String value, boolean trimToMask, boolean skipValidation) Removes the given mask from the given value, optionally trimming at mask max length (ex: mask is ###, 12345 would result 123 if true, and 12345 if false)

Methods inherited from class java.lang.Object

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

Field Detail

MASK_VARIABLES

public static final java.lang.String MASK_VARIABLES

See Also:

Constant Field Values

Constructor Detail

MaskHelper

public MaskHelper()

Method Detail

applyMask

public static java.lang.String applyMask(java.lang.String mask,
                                         java.lang.String value)

Removes the given mask from the given value

countPlaceholders

public static int countPlaceholders(java.lang.String mask)

Returns the number of placeholders in the given mask

generateMaskedValue

public static java.lang.String generateMaskedValue(java.lang.String mask)

Generates a random masked value according to the mask

generateValue

public static java.lang.String generateValue(java.lang.String mask)

Generates a random (unmasked) value according to the mask

getAlphabeticVariables

public static java.util.List<java.lang.Character> getAlphabeticVariables()

getAlphanumericVariables

public static java.util.List<java.lang.Character> getAlphanumericVariables()

getExample

public static java.lang.String getExample(java.lang.String mask)

Returns an example value which can be used with the given mask

getMaskedValueLength

public static int getMaskedValueLength(java.lang.String mask)

Returns the length of a value for the given mask

getNumericVariables

public static java.util.List<java.lang.Character> getNumericVariables()

getUnmaskedValueLength

public static int getUnmaskedValueLength(java.lang.String mask)

Returns the length of a value without mask

hasValidBeginning

public static boolean hasValidBeginning(java.lang.String mask,
                                        java.lang.String maskedValue)

Returns true if the value has a correct beginning for the given mask For example: mask: ##-# value: 1 result: true mask: ##-# value: 11- result: true mask: ##-# value: 11-a result: false

isValidMask

public static boolean isValidMask(java.lang.String mask)

Returns true if the mask has a valid syntax

isValidMaskedValue

public static boolean isValidMaskedValue(java.lang.String mask,
                                         java.lang.String value)

Returns true if the value matches the mask.

removeMask

public static java.lang.String removeMask(java.lang.String mask,
                                          java.lang.String value)

Removes the given mask from the given value, trimming to mask length.
If mask is blank, value is null or not a valid masked then value is returned as is.

See Also:

#removeMask(String, String, boolean)

removeMask

public static java.lang.String removeMask(java.lang.String mask,
                                          java.lang.String value,
                                          boolean trimToMask,
                                          boolean skipValidation)

Removes the given mask from the given value, optionally trimming at mask max length (ex: mask is ###, 12345 would result 123 if true, and 12345 if false)