Package com.day.text

Class AutoFormatter

java.lang.Object

java.text.Format

com.day.text.AutoFormatter

All Implemented Interfaces:

Serializable, Cloneable

public class AutoFormatter
extends Format

The AutoFormatter class implements the automatic conversion of line endings to <br> HTML lists. This is the formatting subset of the UBM feature of the former Communiqué 2 system.

This implementation only supports automatically converting bulleted and numbered lists as well as line breaking. Therefore these formatting options are not implemented here : FORMAT_NOISODEC, FORMAT_ISOENC, FORMAT_AUTOLINK, and FORMAT_URLENC. For replacements, use the

invalid reference

CodeISO

and/or java.net.URLEncoder classes.

See Also:

• Serialized Form

Nested Class Summary

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

Format.Field

Field Summary

Fields

Modifier and Type	Field	Description
static final AutoFormatter	DEFAULT_FORMATTER	The system default formatter.
static final int	FORMAT_AUTOBR	Combination of line break handling and automatic lists.
static final int	FORMAT_AUTOLINK	Deprecated. this is not implemented and has no effects
static final int	FORMAT_AUTOLISTS	Automatically create ordered and unordered lists.
static final int	FORMAT_BR	Automatically convert line breaks to <br> tags
static final int	FORMAT_ISOENC	Deprecated. not implemented here, use invalid reference CodeISO instead.
static final int	FORMAT_NOISODEC	Deprecated. not implemented here, use invalid reference CodeISO instead.
static final int	FORMAT_URLENC	Deprecated. not implemented here, use invalid reference CodeISO or java.net.URLEncoder#encode(String) instead.

Constructor Summary

Constructors

Constructor	Description
AutoFormatter()	Deprecated. as of echidna.
AutoFormatter(Properties config)	Creates a new AutoFormatter object with the given configuration.

Method Summary

Modifier and Type	Method	Description
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos)	Formats the object according to the standard modifiers, which are automatic line breaks and list formatting.
String	format(String str, int mods)	Formats the string according to the modifier set.
StringBuffer	format(String str, StringBuffer toAppendTo, int mods)	Formats the string according to the modifier set.
Object	parseObject(String source, ParsePosition status)	The AutoFormatter class does not support parsing, so an UnsupportedOperationException is thrown when trying to parse.

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

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

Field Details

FORMAT_NOISODEC

public static final int FORMAT_NOISODEC

Deprecated.

not implemented here, use

invalid reference

CodeISO

instead.

ISO encodes the <, " and & characters.

See Also:

• Constant Field Values

FORMAT_ISOENC

public static final int FORMAT_ISOENC

Deprecated.

not implemented here, use

invalid reference

CodeISO

instead.

ISO encode characters according to HTTP standard.

See Also:

• Constant Field Values

FORMAT_AUTOLISTS

public static final int FORMAT_AUTOLISTS

Automatically create ordered and unordered lists.

See Also:

• Constant Field Values

FORMAT_AUTOLINK

public static final int FORMAT_AUTOLINK

Deprecated.

this is not implemented and has no effects

Autmatic link formatting (?).

See Also:

• Constant Field Values

FORMAT_BR

public static final int FORMAT_BR

Automatically convert line breaks to <br> tags

See Also:

• Constant Field Values

FORMAT_URLENC

public static final int FORMAT_URLENC

Deprecated.

not implemented here, use

invalid reference

CodeISO

or java.net.URLEncoder#encode(String) instead.

Encodes characters illegal in URLs.

See Also:

• Constant Field Values

FORMAT_AUTOBR

public static final int FORMAT_AUTOBR

Combination of line break handling and automatic lists.

See Also:

• Constant Field Values

DEFAULT_FORMATTER

public static final AutoFormatter DEFAULT_FORMATTER

The system default formatter. Use this instance when formatting with no special configuration is needed.

Constructor Details

AutoFormatter

public AutoFormatter()

Deprecated.

as of echidna. To get an instance with default settings use the DEFAULT_FORMATTER.

Creates a new AutoFormatter object with the default configuration.

AutoFormatter

public AutoFormatter(Properties config)

Creates a new AutoFormatter object with the given configuration.

The configuration contained in the config parameter is assumed to have the following structure, where config.getName() would return auto or config.getChild("auto") is used as the configuration (this is the same structure as was used in Communiqué 2 to configure automatic formatting.

         
            

            

                
            
            invalid input: '<'ol begin="invalid input: '<'ol start=\"%s\">" end="" >
                
            

All values are replaced as-is except for the ol.start attribute which gets the string %s replaced with the number which is used in the input to defined the ordered list. If the %s string is missing that number is of course not inserted.