net.sf.mmm.content.parser.base

Class ContentParserOptionsBean

java.lang.Object

net.sf.mmm.content.parser.base.ContentParserOptionsBean

All Implemented Interfaces:

ContentParserOptions

public class ContentParserOptionsBean
extends Object
implements ContentParserOptions

This is the implementation of ContentParserOptions as simple java bean.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	disableUtfDetection
private String	encoding
private int	maximumBufferSize

Fields inherited from interface net.sf.mmm.content.parser.api.ContentParserOptions

MAXIMUM_BUFFER_SIZE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
ContentParserOptionsBean() The constructor.

Method Summary

Modifier and Type	Method and Description
String	getEncoding() This method gets the encoding used as fallback, if it can NOT be derived or detected automatically.
int	getMaximumBufferSize() This method gets the maximum size used for buffers when parsing content.
boolean	isDisableUtfDetection() This method determines if the automatic detection of UTF-encodings (unicode) shall be disabled.
void	setDisableUtfDetection(boolean disableUnicodeDetection)
void	setEncoding(String encoding)
void	setMaximumBufferSize(int maximumBufferSize)

Methods inherited from class java.lang.Object

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

Field Detail

maximumBufferSize

private int maximumBufferSize

See Also:

getMaximumBufferSize()

encoding

private String encoding

See Also:

getEncoding()

disableUtfDetection

private boolean disableUtfDetection

See Also:

isDisableUtfDetection()

Constructor Detail

ContentParserOptionsBean

public ContentParserOptionsBean()

The constructor.

Method Detail

getMaximumBufferSize

public int getMaximumBufferSize()

This method gets the maximum size used for buffers when parsing content. Please note that chars will use at least two bytes so e.g. StringBuffer s shall be allocated with a capacity at most maxBytes/2. Anyways the amount of memory allocated will typically be at least twice a much as maxBytes. E.g. a StringBuilder is created with a capacity of maxBytes/2 then StringBuilder.toString() may allocate another array of about that size. This is a legal behavior of the ContentParser. So if you want to limit your heap-size use a reasonable lower value for maxBytes. Please do NOT use values lower than 1024 (You do NOT want to parse Word-Documents with J2ME on your toaster, do you?).

Specified by:

getMaximumBufferSize in interface ContentParserOptions

Returns:

the maximum buffer size in bytes.

See Also:

ContentParserOptions.MAXIMUM_BUFFER_SIZE_DEFAULT

setMaximumBufferSize

public void setMaximumBufferSize(int maximumBufferSize)

Parameters:

maximumBufferSize - is the maximumBufferSize to set

getEncoding

public String getEncoding()

This method gets the encoding used as fallback, if it can NOT be derived or detected automatically. Parsers for formats that make encoding explicit (e.g. XML) will completely ignore this parameter. For textual formats heuristics will be used to detect unicode (UTF*) if not disabled. By default UTF detection is enabled and the encoding is The default is EncodingUtil.SYSTEM_DEFAULT_ENCODING but replaced by EncodingUtil.ENCODING_ISO_8859_15 if UTF-based.

Specified by:

getEncoding in interface ContentParserOptions

Returns:

the fallback encoding.

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - is the encoding to set

isDisableUtfDetection

public boolean isDisableUtfDetection()

This method determines if the automatic detection of UTF-encodings (unicode) shall be disabled. If this is disabled, textual files are read using the configured encoding. Otherwise it will be treaded as fallback if textual files do not seem to be unicode (UTF).

Specified by:

isDisableUtfDetection in interface ContentParserOptions

Returns:

true if unicode detection shall be disabled, false if enabled (default).

setDisableUtfDetection

public void setDisableUtfDetection(boolean disableUnicodeDetection)

Parameters:

disableUnicodeDetection - is the disableUnicodeDetection to set