org.thales.punch.libraries.punchlang.impl

Class Utils

java.lang.Object

org.thales.punch.libraries.punchlang.impl.Utils

public final class Utils
extends Object

The unavoidable utility class.

It provides static functions to escape unescape, trim or removing leading?trailing quotes out of String.

It also provide additional utility functions, handy to make them unit tested.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
static String	escape(String aText) Escapes characters for text appearing as data in the Javascript Object Notation (JSON) data interchange format.
static String	escapeAndReplace(boolean debug, String input, char[] quoteDelims, char escapeChar, List<String> opaque) Given an input String like this : hello,"world,you",moon it may be necessary before splitting it into "hello" and "world,you" and "moon", to make everything between (sqy) quotes be opacified.
static String	removeTrailingDoubleOrSingleQuote(String value) remove from the string the leading and trailing quote and double quote.
static String	restore(String value, List<String> opaque)
static String	unescape(String aText)

Methods inherited from class java.lang.Object

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

Method Detail

escape

public static String escape(String aText)

Escapes characters for text appearing as data in the Javascript Object Notation (JSON) data interchange format.

>The following commonly used control characters are escaped :

Character	Escaped As
"	\"
\	\\
/	\/
back space	\b
form feed	\f
line feed	\n
carriage return	\r
tab	\t

See RFC 4627 for more information.

Parameters:

aText - your input text

Returns:

the escaped text

unescape

public static String unescape(String aText)

escapeAndReplace

public static String escapeAndReplace(boolean debug,
                                      String input,
                                      char[] quoteDelims,
                                      char escapeChar,
                                      List<String> opaque)

Given an input String like this : hello,"world,you",moon it may be necessary before splitting it into "hello" and "world,you" and "moon", to make everything between (sqy) quotes be opacified. Because otherwise the inner ',' would mess the split operated by a Csv or Kv operation. That is what this method does. It returns hello,@PUNCH@,moon and an array of opaque string with the original content : ["world,you"].

With that string you can safely split it, then at the end replace back in turn each \@PUNCH\@ by its original content.

Parameters:

debug - true to stdout important steps. Do not use in production

input - the input String

quoteDelims - the quoteDelims to use for opacifying inner content

escapeChar - the escapeChar to use for escaping quote delimiters

opaque - a list of String that will be filled with the substring replaced by \@PUNCH\@

Returns:

the opacified string

restore

public static String restore(String value,
                             List<String> opaque)

removeTrailingDoubleOrSingleQuote

public static String removeTrailingDoubleOrSingleQuote(String value)

remove from the string the leading and trailing quote and double quote.

Parameters:

value - string to clean, i.e "my/text"

Returns:

the unquoted string: my/text