Module com.aoapps.encoding

Package com.aoapps.encoding

Interface EncodingContext

@ThreadSafe
public interface EncodingContext

The current encoding context may perform URL rewriting.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final EncodingContext	DEFAULT	Default encoding context.
static final EncodingContext	SGML	Encoding context for SGML always.
static final EncodingContext	XML	Encoding context for XML always.

Method Summary

Modifier and Type	Method	Description
default String	encodeURL(String url)	Encodes a URL for the current encoding context.
default Charset	getCharacterEncoding()	The output character encoding.
default Doctype	getDoctype()	The current doctype.
default Serialization	getSerialization()	The current serialization.

Field Details

DEFAULT

static final EncodingContext DEFAULT

Default encoding context. Also used when there is no context available.

See Also:

• Doctype.DEFAULT
• Serialization.DEFAULT
• StandardCharsets.UTF_8

XML

static final EncodingContext XML

Encoding context for XML always.

See Also:

• Doctype.DEFAULT
• Serialization.XML
• StandardCharsets.UTF_8

SGML

static final EncodingContext SGML

Encoding context for SGML always.

See Also:

• Doctype.DEFAULT
• Serialization.SGML
• StandardCharsets.UTF_8

Method Details

encodeURL

default String encodeURL(String url)

Encodes a URL for the current encoding context. The resulting URL must be valid RFC 3986 URI or RFC 3987 IRI.

Defaults to performing no encoding.

getDoctype

default Doctype getDoctype()

The current doctype.

Defaults to Doctype.DEFAULT.

getSerialization

default Serialization getSerialization()

The current serialization.

Defaults to Serialization.DEFAULT.

getCharacterEncoding

default Charset getCharacterEncoding()

The output character encoding.

Defaults to StandardCharsets.UTF_8.