org.thales.punch.libraries.punchlang.operator

Class KvPlainEscaper

java.lang.Object

org.thales.punch.libraries.punchlang.operator.KvPlainEscaper

public class KvPlainEscaper
extends Object

This utility class takes strings containing quotes (or single quotes) some possibly escaped detects what is inside pairs or these.

Here is a simple example:

a="yes" b="no"

Simple enough to detect that "yes" and "no" must be treated as opaque strings in there. The tricky part is to deal with these example:

a="yes \"man\"" b="no"

a="yes man\" b="no"

In the first example the most probable escaped strings are "yes \"man\"" and "no". While in the second it is "man\" and "no". The question is how to know that the character '\' in "man\" is part of the string ?

To resolve that this class performs a reverse scan of the string that makes it easier to check for the most consistent chain of '"' and '\"'.

Constructor Summary

Constructors

Constructor and Description
KvPlainEscaper() Test constructor.
KvPlainEscaper(String enclosingDelimiters, char escapeCharacter)

Method Summary

Modifier and Type	Method and Description
String	escape(String input, List<KvPortion> opaque)
List<KvPortion>	reverseScan(String input, KvPlainEscaperListener l) This method is public to facilitate unit tests.

Methods inherited from class java.lang.Object

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

Constructor Detail

KvPlainEscaper

public KvPlainEscaper(String enclosingDelimiters,
                      char escapeCharacter)

Parameters:

enclosingDelimiters - a string to provide one or several character to be used as delimiter.

escapeCharacter - the character used for escaping. Typically, '\'.

KvPlainEscaper

public KvPlainEscaper()

Test constructor. The delimiter is " and the escape character is \.

Method Detail

escape

public String escape(String input,
                     List<KvPortion> opaque)

reverseScan

public List<KvPortion> reverseScan(String input,
                                   KvPlainEscaperListener l)

This method is public to facilitate unit tests.

Parameters:

input - the input String

l - the listener to be told upon '"' and '\"' occurrences.

Returns:

a list of region, each indicating the start and end index of escaped parts.