java.lang.Object
org.apache.wicket.util.convert.MaskConverter<C>
- Type Parameters:
C
-
- All Implemented Interfaces:
Serializable
,IConverter<C>
,IClusterable
A converter that takes a mask into account. It is specifically meant for overrides on individual
components, that provide their own converter by returning it from
Component#getConverter(Class)
. It uses an instance of MaskFormatter
to delegate
the masking and unmasking to.
The following characters can be specified (adopted from the MaskFormatter documentation):
Character |
Description |
---|---|
# | Any valid number, uses Character.isDigit . |
' | Escape character, used to escape any of the special formatting characters. |
U | Any character (Character.isLetter ). All lowercase letters are mapped to upper
case. |
L | Any character (Character.isLetter ). All upper case letters are mapped to lower
case. |
A | Any character or number (Character.isLetter or Character.isDigit ) |
? | Any character (Character.isLetter ). |
Anything. | |
H | Any hex character (0-9, a-f or A-F). |
Typically characters correspond to one char, but in certain languages this is not the case. The mask is on a per character basis, and will thus adjust to fit as many chars as are needed.
- Author:
- Eelco Hillenius
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionMaskConverter
(String mask) Construct; converts to Strings.MaskConverter
(String mask, Class<?> type) Construct.MaskConverter
(MaskFormatter maskFormatter) Construct. -
Method Summary
Modifier and TypeMethodDescriptionconvertToObject
(String value, Locale locale) Converts a string to an object usingMaskFormatter.stringToValue(String)
.convertToString
(C value, Locale locale) Converts the value to a string usingMaskFormatter.valueToString(Object)
.
-
Constructor Details
-
MaskConverter
Construct.- Parameters:
maskFormatter
- The mask formatter to use for masking and unmasking values
-
MaskConverter
Construct; converts to Strings.- Parameters:
mask
- The mask to use for this converter instance- See Also:
-
MaskConverter
Construct.- Parameters:
mask
- The mask to use for this converter instancetype
- The type to convert string values to.- See Also:
-
-
Method Details
-
convertToObject
Converts a string to an object usingMaskFormatter.stringToValue(String)
.- Specified by:
convertToObject
in interfaceIConverter<C>
- Parameters:
value
- The string value to convertlocale
- The locale used to convert the value- Returns:
- The converted value
-
convertToString
Converts the value to a string usingMaskFormatter.valueToString(Object)
.- Specified by:
convertToString
in interfaceIConverter<C>
- Parameters:
value
- The value to convertlocale
- The locale used to convert the value- Returns:
- The converted string value
-