humanize.text

Class MaskFormat

java.lang.Object

java.text.Format

humanize.text.MaskFormat

All Implemented Interfaces:

FormatProvider, Serializable, Cloneable

public class MaskFormat
extends Format
implements FormatProvider

MaskFormat is used to format and parse strings by the mean of a mask. Underscore '_' is used as default place holder for the next message character. The other characters within the mask are inserted between the message symbols. The backslash '\' is escape symbol. Combination of '\?' will include '?' in the human-readable message, where '?' can be any character including underscore '_' and backslash '\'. Hash '#' can be used to skip (delete) a character from the original message.

Examples:

Input	Mask	Output
313378444416	_ _____ _____ _	3 13378 44441 6
A58818501	_-__-_____/_	A-58-81850/1
A/5881850 1	_# __ _____#-_	A 58 81850-1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Format.Field

Constructor Summary

Constructors

Constructor and Description
MaskFormat()
MaskFormat(String mask)
MaskFormat(String mask, char placeholder)

Method Summary

Methods

Modifier and Type	Method and Description
static FormatFactory	factory()
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
String	format(String str)
static String	format(String mask, String str)
static String	format(String mask, String str, char placeholder)
FormatFactory	getFactory() Gets the format factory.
String	getFormatName() Gets the format name that will be registered.
String	getMask()
char	getPlaceholder()
String	parse(String source)
String	parse(String source, ParsePosition pos)
static String	parse(String mask, String source)
static String	parse(String mask, String source, char placeholder)
Object	parseObject(String source)
Object	parseObject(String source, ParsePosition pos)
void	setMask(String mask)
void	setPlaceholder(char placeholder)

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator

Methods inherited from class java.lang.Object

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

Constructor Detail

MaskFormat

public MaskFormat()

MaskFormat

public MaskFormat(String mask)

MaskFormat

public MaskFormat(String mask,
          char placeholder)

Method Detail

factory

public static FormatFactory factory()

format

public static String format(String mask,
            String str)

format

public static String format(String mask,
            String str,
            char placeholder)

parse

public static String parse(String mask,
           String source)
                    throws ParseException

Throws:

ParseException

parse

public static String parse(String mask,
           String source,
           char placeholder)
                    throws ParseException

Throws:

ParseException

format

public StringBuffer format(Object obj,
                  StringBuffer toAppendTo,
                  FieldPosition pos)

Specified by:

format in class Format

format

public String format(String str)

getFactory

public FormatFactory getFactory()

Description copied from interface: FormatProvider

Gets the format factory.

Specified by:

getFactory in interface FormatProvider

Returns:

a FormatFactory instance

getFormatName

public String getFormatName()

Description copied from interface: FormatProvider

Gets the format name that will be registered. If you want to register multiple names for a format then return a String with the names concatenated by a vertical bar character '|'.

Specified by:

getFormatName in interface FormatProvider

Returns:

the format name

getMask

public String getMask()

getPlaceholder

public char getPlaceholder()

parse

public String parse(String source)
             throws ParseException

Throws:

ParseException

parse

public String parse(String source,
           ParsePosition pos)
             throws ParseException

Throws:

ParseException

parseObject

public Object parseObject(String source)
                   throws ParseException

Overrides:

parseObject in class Format

Throws:

ParseException

parseObject

public Object parseObject(String source,
                 ParsePosition pos)

Specified by:

parseObject in class Format

setMask

public void setMask(String mask)

setPlaceholder

public void setPlaceholder(char placeholder)