org.apache.juneau.config.encode

Interface ConfigEncoder

All Known Implementing Classes:

ConfigXorEncoder

public interface ConfigEncoder

API for defining a string encoding/decoding mechanism for entries in Config.

• Overview > juneau-config > Encoded Entries

Method Summary

Modifier and Type	Method and Description
String	decode(String fieldName, String in) Decode a string.
String	encode(String fieldName, String in) Encode a string.
boolean	isEncoded(String in) Returns true if the specified string is encoded.

Method Detail

encode

String encode(String fieldName,
              String in)

Encode a string.

Parameters:

fieldName - The field name being encoded.

in - The unencoded input string.

Returns:

The encoded output string.

decode

String decode(String fieldName,
              String in)

Decode a string.

Parameters:

fieldName - The field name being decoded.

in - The encoded input string.

Returns:

The decoded output string.

isEncoded

boolean isEncoded(String in)

Returns true if the specified string is encoded.

Parameters:

in - The input string.

Returns:

true if the specified string is encoded.
Returns false if the string is null.