com.dpslink.base.util

Class StringEncoder

java.lang.Object

com.dpslink.base.util.StringEncoder

All Implemented Interfaces:

java.io.Serializable

public class StringEncoder
extends java.lang.Object
implements java.io.Serializable

A utility class that provides string formatting helper methods.

The methods in this class are accessible from within a template via the $str variable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Hashtable<java.lang.String,java.util.regex.Pattern>	cvRegExPatterns A cache of compiled regular expression patterns.
static java.lang.String	DEFAULT_ENCODING The default character encoding.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
StringEncoder()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	enc(java.lang.String s) Returns a string that has been URL encoded.
static java.lang.String	enc(java.lang.StringBuilder sb) Returns a string that has been URL encoded.
static java.lang.String	encspc(java.lang.String s) Returns a string that has all of its embedded spaces URL encoded.
static java.lang.String	encspc(java.lang.StringBuilder sb) Returns a string that has all of its embedded spaces URL encoded.
static java.lang.String	esc(java.lang.String s) Returns a string that has any "script unsafe" characters (such as double quotes, single quotes and backslashes) preceded with the escape character (a backslash).
static java.lang.String	esc(java.lang.StringBuilder sb) Returns a string that has any "script unsafe" characters (such as double quotes, single quotes and backslashes) preceded with the escape character (a backslash).
private static java.lang.String	escCRLF(java.lang.String s) Returns the given string with LF and CRLF converted to double tildes.
static java.lang.String	fhs(java.lang.String s) Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes.
static java.lang.String	fhs(java.lang.StringBuilder sb) Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes.
private static java.lang.String	fhsAmpersand(java.lang.String s) Returns a string that has any standalone ampersands (&) converted to the "html safe" decimal entity code.
static java.lang.String	fhsLine(java.lang.String s) Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes.
static java.lang.String	fhsLine(java.lang.StringBuilder sb) Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes.
static java.lang.String	fts(java.lang.String s) Returns a string that has any "text unsafe" characters (such as html entity codes) replaced with corresponding "text safe" characters.
static java.lang.String	fts(java.lang.StringBuilder sb) Returns a string that has any "text unsafe" characters (such as html entity codes) replaced with corresponding "text safe" characters.
static java.lang.String	fwl(java.lang.StringBuilder sb, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fwl(java.lang.String s, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fwld(java.lang.StringBuilder sb, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fwld(java.lang.String s, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fwr(java.lang.StringBuilder sb, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fwr(java.lang.String s, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fwrd(java.lang.StringBuilder sb, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fwrd(java.lang.String s, int length) Pads or truncates a string to a fixed-width length.
static java.lang.String	fxs(java.lang.String s) Returns a string that has any "xml unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "xml safe" decimal entity codes.
static java.lang.String	fxs(java.lang.StringBuilder sb) Returns a string that has any "xml unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "xml safe" decimal entity codes.
private static java.util.regex.Pattern	getRegExPattern(java.lang.String s) Returns a compiled regular expression Pattern object for the given string.
private static boolean	isEntity(java.lang.StringBuilder sb, int index) Determines if an html entity is about to be processed.
static java.lang.String	pre(java.lang.String s) Returns a string that has been pre-encoded or pre-formatted.
static java.lang.String	quote(java.lang.String s) Returns the given string enclosed within double quotes.
static java.lang.String	quote(java.lang.String s, boolean escape) Returns the given string enclosed within double quotes and optionally escapes the string prior to quoting.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

The default character encoding.

cvRegExPatterns

private static java.util.Hashtable<java.lang.String,java.util.regex.Pattern> cvRegExPatterns

A cache of compiled regular expression patterns.

Constructor Detail

StringEncoder

public StringEncoder()

Method Detail

enc

public static java.lang.String enc(java.lang.String s)

Returns a string that has been URL encoded.

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

enc

public static java.lang.String enc(java.lang.StringBuilder sb)

Returns a string that has been URL encoded.

Parameters:

sb - (StringBuilder) The string to process.

Returns:

String - The processed results.

encspc

public static java.lang.String encspc(java.lang.String s)

Returns a string that has all of its embedded spaces URL encoded.

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

encspc

public static java.lang.String encspc(java.lang.StringBuilder sb)

Returns a string that has all of its embedded spaces URL encoded.

Parameters:

sb - (StringBuilder) The string to process.

Returns:

String - The processed results.

esc

public static java.lang.String esc(java.lang.String s)

Returns a string that has any "script unsafe" characters (such as double quotes, single quotes and backslashes) preceded with the escape character (a backslash).

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

esc

public static java.lang.String esc(java.lang.StringBuilder sb)

Returns a string that has any "script unsafe" characters (such as double quotes, single quotes and backslashes) preceded with the escape character (a backslash).

Parameters:

sb - (StringBuilder) The string to process.

Returns:

String - The processed results.

escCRLF

private static java.lang.String escCRLF(java.lang.String s)

Returns the given string with LF and CRLF converted to double tildes.

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

fhs

public static java.lang.String fhs(java.lang.String s)

Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes. Converts "crlf" and "lf" to html "br". If the result is an empty string, returns the html non- breaking space entity ( ).

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

fhs

public static java.lang.String fhs(java.lang.StringBuilder sb)

Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes. Converts "crlf" and "lf" to html "br". If the result is an empty string, returns the html non- breaking space entity ( ).

Parameters:

sb - (StringBuilder) The string to process.

Returns:

String - The processed results.

fhsAmpersand

private static java.lang.String fhsAmpersand(java.lang.String s)

Returns a string that has any standalone ampersands (&) converted to the "html safe" decimal entity code.

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

fhsLine

public static java.lang.String fhsLine(java.lang.String s)

Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes. Similar to fhs except does not convert "crlf" and "lf" to html "br". If the result is an empty string, returns the html non-breaking space entity ( ). This method is typically invoked when html safe encoding is desired for a single line of html and the line should remain intact vs. being split into multiple lines.

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

fhsLine

public static java.lang.String fhsLine(java.lang.StringBuilder sb)

Returns a string that has any "html unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "html safe" decimal entity codes. Similar to fhs except does not convert "crlf" and "lf" to html "br". If the result is an empty string, returns the html non-breaking space entity ( ). This method is typically invoked when html safe encoding is desired for a single line of html and the line should remain intact vs. being split into multiple lines.

Parameters:

sb - (StringBuilder) The string to process.

Returns:

String - The processed results.

fts

public static java.lang.String fts(java.lang.String s)

Returns a string that has any "text unsafe" characters (such as html entity codes) replaced with corresponding "text safe" characters. Also converts html "br" to "crlf".

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

fts

public static java.lang.String fts(java.lang.StringBuilder sb)

Returns a string that has any "text unsafe" characters (such as html entity codes) replaced with corresponding "text safe" characters. Also converts html "br" to "crlf".

Parameters:

sb - (StringBuilder) The string to process.

Returns:

String - The processed results.

fwl

public static java.lang.String fwl(java.lang.String s,
                                   int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the left of the string's value, which results in a right-justified value. If truncation occurs, characters are removed from the beginning of the string.

Parameters:

s - (String) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fwl

public static java.lang.String fwl(java.lang.StringBuilder sb,
                                   int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the left of the string's value, which results in a right-justified value. If truncation occurs, characters are removed from the beginning of the string.

Parameters:

sb - (StringBuilder) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fwld

public static java.lang.String fwld(java.lang.String s,
                                    int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the left of the string's value, which results in a right-justified value. If truncation occurs, characters are removed from the beginning of the string.

Same as fwl except uses a dot (.) for the pad character vs. using a space.

Parameters:

s - (String) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fwld

public static java.lang.String fwld(java.lang.StringBuilder sb,
                                    int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the left of the string's value, which results in a right-justified value. If truncation occurs, characters are removed from the beginning of the string.

Same as fwl except uses a dot (.) for the pad character vs. using a space.

Parameters:

sb - (StringBuilder) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fwr

public static java.lang.String fwr(java.lang.String s,
                                   int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the right of the string's value, which results in a left-justified value. If truncation occurs, characters are removed from the end of the string.

Parameters:

s - (String) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fwr

public static java.lang.String fwr(java.lang.StringBuilder sb,
                                   int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the right of the string's value, which results in a left-justified value. If truncation occurs, characters are removed from the end of the string.

Parameters:

sb - (StringBuilder) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fwrd

public static java.lang.String fwrd(java.lang.String s,
                                    int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the right of the string's value, which results in a left-justified value. If truncation occurs, characters are removed from the end of the string.

Same as fwr except uses a dot (.) for the pad character vs. using a space.

Parameters:

s - (String) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fwrd

public static java.lang.String fwrd(java.lang.StringBuilder sb,
                                    int length)

Pads or truncates a string to a fixed-width length. Any padding added to the string is added to the right of the string's value, which results in a left-justified value. If truncation occurs, characters are removed from the end of the string.

Same as fwr except uses a dot (.) for the pad character vs. using a space.

Parameters:

sb - (StringBuilder) The string to process.

length - (int) The desired length of the result.

Returns:

String - The processed results.

fxs

public static java.lang.String fxs(java.lang.String s)

Returns a string that has any "xml unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "xml safe" decimal entity codes. Also converts html "br" to "crlf". If the result is an empty string, returns the xml non-breaking space entity ( ).

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

fxs

public static java.lang.String fxs(java.lang.StringBuilder sb)

Returns a string that has any "xml unsafe" characters (such as double quotes, single quotes, greater than signs, less than signs) replaced with corresponding "xml safe" decimal entity codes. Also converts html "br" to "crlf". If the result is an empty string, returns the xml non-breaking space entity ( ).

Parameters:

sb - (StringBuilder) The string to process.

Returns:

String - The processed results.

pre

public static java.lang.String pre(java.lang.String s)

Returns a string that has been pre-encoded or pre-formatted. In other words, returns the same string as the given string. Use this method to indicate that a string value has already been encoded or formatted for output and no other encoding or formatting should be done.

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

quote

public static java.lang.String quote(java.lang.String s)

Returns the given string enclosed within double quotes.

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

quote

public static java.lang.String quote(java.lang.String s,
                                     boolean escape)

Returns the given string enclosed within double quotes and optionally escapes the string prior to quoting. If escaping the string, any LF and CRLF are converted to double tildes.

Parameters:

s - (String) The string to process.

escape - (boolean) true to escape the given string before quoting, otherwise false.

Returns:

String - The processed results.

getRegExPattern

private static java.util.regex.Pattern getRegExPattern(java.lang.String s)

Returns a compiled regular expression Pattern object for the given string. The given string should simply contain the character(s) that are to be matched vs. a formatted regex pattern string. This method assumes that any regex metacharacters contained in the given string are characters to be matched, meaning that any metacharacters in the string are escaped prior to creating the compiled regex pattern.

Parameters:

s - (String) The string to process.

Returns:

Pattern - The string's compiled regular express pattern.

isEntity

private static boolean isEntity(java.lang.StringBuilder sb,
                                int index)

Determines if an html entity is about to be processed. This is a helper method used by fhs when creating html safe strings.

Returns:

boolean - true if an html entity is about to be processed, otherwise false.