net.sf.mmm.content.parser.api

Interface ContentParserOptions

All Known Implementing Classes:

ContentParserOptionsBean

public interface ContentParserOptions

This is the interface with additional options for the ContentParser.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

ContentParser.parse(java.io.InputStream, long, ContentParserOptions), ContentParserOptionsBean

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXIMUM_BUFFER_SIZE_DEFAULT The default maximum is 1 MB.

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.

Field Detail

MAXIMUM_BUFFER_SIZE_DEFAULT

static final int MAXIMUM_BUFFER_SIZE_DEFAULT

The default maximum is 1 MB.

See Also:

Constant Field Values

Method Detail

getMaximumBufferSize

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?).

Returns:

the maximum buffer size in bytes.

See Also:

MAXIMUM_BUFFER_SIZE_DEFAULT

getEncoding

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.

Returns:

the fallback encoding.

isDisableUtfDetection

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).

Returns:

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