ucar.nc2.internal.util

Class EscapeStrings

java.lang.Object

ucar.nc2.internal.util.EscapeStrings

public class EscapeStrings
extends Object

Text Escaping utilities. TODO replace with standard escape libraries where possible

Constructor Summary

Constructors

Constructor and Description
EscapeStrings()

Method Summary

Modifier and Type	Method and Description
static String	backslashEscape(String x, String reservedChars) backslash escape a string
static String	backslashEscapeCDMString(String s, String toescape) Given a CDM string, insert backslashes before characters.
static String	backslashUnescape(String x) backslash unescape a string
static String	escapeOGC(String s) The OGC Web Services escape function.
static String	escapeString(String in, String allowable) Public by accident, do not use directly
static String	escapeURLQuery(String ce) Define the DEFINITIVE URL constraint expression escape function.
static int	indexOf(String escapedName, char c) Find first occurence of char c in escapedName, excluding escaped c.
static List<String>	tokenizeEscapedName(String escapedName) Tokenize an escaped name using "." as delimiter, skipping "\."
static String	unescapeString(String in) Public by accident, do not use directly
static String	unescapeURLQuery(String ce) Define the DEFINITIVE URL constraint expression unescape function.
static String	urlDecode(String s) A cover for URLDecoder.decode(): Decodes a application/x-www-form-urlencoded string.

Methods inherited from class java.lang.Object

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

Constructor Detail

EscapeStrings

public EscapeStrings()

Method Detail

backslashEscape

public static String backslashEscape(String x,
                                     String reservedChars)

backslash escape a string

Parameters:

x - escape this; may be null

reservedChars - these chars get a backslash in front of them

Returns:

escaped string

backslashUnescape

public static String backslashUnescape(String x)

backslash unescape a string

Parameters:

x - unescape this

Returns:

string with \c -> c

tokenizeEscapedName

public static List<String> tokenizeEscapedName(String escapedName)

Tokenize an escaped name using "." as delimiter, skipping "\."

Parameters:

escapedName - an escaped name

Returns:

list of tokens

backslashEscapeCDMString

public static String backslashEscapeCDMString(String s,
                                              String toescape)

Given a CDM string, insert backslashes before characters.

indexOf

public static int indexOf(String escapedName,
                          char c)

Find first occurence of char c in escapedName, excluding escaped c.

Parameters:

escapedName - search in this string

c - for this char but not \\cha

Returns:

pos in string, or -1

escapeOGC

@Nullable
public static String escapeOGC(String s)

The OGC Web Services escape function.

Parameters:

s - The string to encode.

Returns:

The escaped string, or null on error.

escapeURLQuery

@Nullable
public static String escapeURLQuery(String ce)

Define the DEFINITIVE URL constraint expression escape function.

Parameters:

ce - The expression to modify.

Returns:

The escaped string, or null on error.

escapeString

@Nullable
public static String escapeString(String in,
                                             String allowable)

Public by accident, do not use directly

unescapeURLQuery

@Nullable
public static String unescapeURLQuery(String ce)

Define the DEFINITIVE URL constraint expression unescape function.

Parameters:

ce - The expression to unescape.

Returns:

The unescaped expression, or null on error.

unescapeString

@Nullable
public static String unescapeString(String in)

Public by accident, do not use directly

urlDecode

@Nullable
public static String urlDecode(String s)

A cover for URLDecoder.decode(): Decodes a application/x-www-form-urlencoded string. Returns null instead of throwing an Exception.

Parameters:

s - The string to unescape.

Returns:

The unescaped expression, or null on error