com.uwyn.rife.template
Interface TemplateEncoder

All Known Implementing Classes:

EncoderDummy, EncoderHtml, EncoderSql, EncoderXml

public interface TemplateEncoder

Encodes Strings into a corresponding template output format, so they will be displayed correctly in the resulting file. For example, a TemplateEncoder for a template file will encode > as &gt.

Since:

1.0

Version:

$Revision: 3634 $

Author:

Keith Lea <keith[remove] at cs dot oswego dot edu>, Geert Bevin (gbevin[remove] at uwyn dot com)

Method Summary

String	encode(String value) Encodes the given value, returning a string which contains only valid characters and represents the given value correctly in the output format.
String	encodeDefensive(String value) Encodes the given value in a looser fashion than encode(java.lang.String)'s, only converting patterns which are explicitly not allowed by the output format, but not guaranteeing that the output value exactly represents the given value in the output format.

Method Detail

encode

String encode(String value)

Encodes the given value, returning a string which contains only valid characters and represents the given value correctly in the output format.

For example, an HTML template's encoder will encode > as >.

Parameters:

value - a string

Returns:

an encoded version of the given string

Since:

1.0

encodeDefensive

String encodeDefensive(String value)

Encodes the given value in a looser fashion than encode(java.lang.String)'s, only converting patterns which are explicitly not allowed by the output format, but not guaranteeing that the output value exactly represents the given value in the output format.

For example, an HTML template's encoder will encode some Unicode characters to corresponding XML entities (such as é) when this method is called but not encode < or &.

Parameters:

value - a string

Returns:

a loosely encoded version of the given value

Since:

1.0