org.blojsom.plugin.common
Class StringUtilitiesPlugin.StringUtilities

java.lang.Object
  extended byorg.blojsom.plugin.common.StringUtilitiesPlugin.StringUtilities
Enclosing class:
StringUtilitiesPlugin

public class StringUtilitiesPlugin.StringUtilities
extends java.lang.Object

Utility class for bundling string utility functions to make available to templates


Constructor Summary
StringUtilitiesPlugin.StringUtilities()
          Construct a new instance of StringUtilities
 
Method Summary
 java.lang.String decodeStringUTF8(java.lang.String input)
          Decode a UTF-8 encoded string from the input
 java.lang.String encodeStringUTF8(java.lang.String input)
          Return a UTF-8 encoded string from the input
 java.lang.String escapeBrackets(java.lang.String input)
          Return an escaped string where <, > are converted to their HTML equivalents
 java.lang.String escapeString(java.lang.String input)
          Return an escaped string where &, <, >, ", and ' are converted to their HTML equivalents
 java.lang.String escapeStringSimple(java.lang.String input)
          Return an escaped string where &, <, > are converted to their HTML equivalents
 java.lang.String[] parseCommaList(java.lang.String commaList)
          Parse a comma-separated list of values; also parses over internal spaces
 java.lang.String[] parseDelimitedList(java.lang.String delimitedList, java.lang.String delimiter)
          Parse a delimited list of values
 java.lang.String[] parseDelimitedList(java.lang.String delimitedList, java.lang.String delimiter, boolean trim)
          Parse a delimited list of values
 java.lang.String[] parseLastComma(java.lang.String value)
          Parse a string into two separate strings based on the last comma in the input value
 java.lang.String[] parseOnlyCommaList(java.lang.String commaList)
          Parse a comma-separated list of values
 java.lang.String[] parseOnlyCommaList(java.lang.String commaList, boolean trim)
          Parse a comma-separated list of values
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringUtilitiesPlugin.StringUtilities

public StringUtilitiesPlugin.StringUtilities()
Construct a new instance of StringUtilities

Method Detail

escapeString

public java.lang.String escapeString(java.lang.String input)
Return an escaped string where &, <, >, ", and ' are converted to their HTML equivalents

Parameters:
input - Unescaped string
Returns:
Escaped string containing HTML equivalents for &, <, >, ", and '

escapeStringSimple

public java.lang.String escapeStringSimple(java.lang.String input)
Return an escaped string where &, <, > are converted to their HTML equivalents

Parameters:
input - Unescaped string
Returns:
Escaped string containing HTML equivalents for &, <, >

escapeBrackets

public java.lang.String escapeBrackets(java.lang.String input)
Return an escaped string where <, > are converted to their HTML equivalents

Parameters:
input - Unescaped string
Returns:
Escaped string containing HTML equivalents for <, >

encodeStringUTF8

public java.lang.String encodeStringUTF8(java.lang.String input)
Return a UTF-8 encoded string from the input

Parameters:
input - Input
Returns:
Input that has been encoded using UTF-8

decodeStringUTF8

public java.lang.String decodeStringUTF8(java.lang.String input)
Decode a UTF-8 encoded string from the input

Parameters:
input - Input
Returns:
Input that has been decoded using UTF-8

parseCommaList

public java.lang.String[] parseCommaList(java.lang.String commaList)
Parse a comma-separated list of values; also parses over internal spaces

Parameters:
commaList - Comma-separated list
Returns:
Individual strings from the comma-separated list

parseOnlyCommaList

public java.lang.String[] parseOnlyCommaList(java.lang.String commaList)
Parse a comma-separated list of values

Parameters:
commaList - Comma-separated list
Returns:
Individual strings from the comma-separated list

parseOnlyCommaList

public java.lang.String[] parseOnlyCommaList(java.lang.String commaList,
                                             boolean trim)
Parse a comma-separated list of values

Parameters:
commaList - Comma-separated list
trim - If the contents of the array should be trimmed
Returns:
Individual strings from the comma-separated list

parseLastComma

public java.lang.String[] parseLastComma(java.lang.String value)
Parse a string into two separate strings based on the last comma in the input value

Parameters:
value - Input
Returns:
Parsed string

parseDelimitedList

public java.lang.String[] parseDelimitedList(java.lang.String delimitedList,
                                             java.lang.String delimiter)
Parse a delimited list of values

Parameters:
delimitedList - Delimited list
delimiter - Field Delimiter
Returns:
Individual strings from the comma-separated list

parseDelimitedList

public java.lang.String[] parseDelimitedList(java.lang.String delimitedList,
                                             java.lang.String delimiter,
                                             boolean trim)
Parse a delimited list of values

Parameters:
delimitedList - Delimited list
delimiter - Field Delimiter
trim - If the contents of the array should be trimmed
Returns:
Individual strings from the comma-separated list