be.SIRAPRISE.util

Class BracketParser

java.lang.Object

be.SIRAPRISE.util.BracketParser

public class BracketParser
extends java.lang.Object

Provides methods for working with bracketed expressions.

Author:

Erwin

Constructor Summary

Constructors

Constructor and Description
BracketParser()

Method Summary

Modifier and Type	Method and Description
static java.util.HashMap<java.lang.String,java.lang.String>	createHashMapFromEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.HashMap<java.lang.String,java.lang.String>	createHashMapFromNonEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.HashMap<java.lang.String,java.lang.String>	createHashMapWithMandatoryValuesFromEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.HashMap<java.lang.String,java.lang.String>	createHashMapWithMandatoryValuesFromNonEscaped(java.lang.String s) Creates a HashMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.LinkedList<java.lang.String>	createListFromEscaped(java.lang.String s) Creates a List of values contained in a String in the general format Name1(value1)Name2(value2)...
static java.util.LinkedList<java.lang.String>	createListFromNonEscaped(java.lang.String s) Creates a List of values contained in a String in the general format Name1(value1)Name2(value2)...
static java.util.Map<java.lang.String,java.lang.String>	createMapFromEscapedString(java.lang.String s, boolean emptyMapAllowed) Parses a bracketed String and builds a hashmap with the information contained within the (map) value is the (attribute) value, also in string format.
static java.util.TreeMap<java.lang.String,java.lang.String>	createTreeMapFromEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.TreeMap<java.lang.String,java.lang.String>	createTreeMapFromNonEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.TreeMap<java.lang.String,java.lang.String>	createTreeMapWithMandatoryValuesFromEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static java.util.TreeMap<java.lang.String,java.lang.String>	createTreeMapWithMandatoryValuesFromNonEscaped(java.lang.String s) Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)...
static void	fillMapFromEscaped(java.lang.String s, java.util.Map<java.lang.String,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillMapFromNonEscaped(java.lang.String s, java.util.Map<java.lang.String,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillMapWithMandatoryValuesFromEscaped(java.lang.String s, java.util.Map<java.lang.String,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillMapWithMandatoryValuesFromNonEscaped(java.lang.String s, java.util.Map<java.lang.String,java.lang.String> attributeValueMap) Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)...
static void	fillNonEmptyMapWithMandatoryValuesFromEscaped(java.lang.String s, java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
static void	fillNonEmptyMapWithMandatoryValuesFromNonEscaped(java.lang.String s, java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
static int	findCorrespondingClosingBracket(java.lang.String s) Find the position of the closing bracket that matches the opening bracket in position 0.
static NameValueResult	getNameAndMandatoryValueFromEscaped(java.lang.String s, int startPos) Returns the 'name' part of an expression of the form "name(content)"
static NameValueResult	getNameAndMandatoryValueFromNonEscaped(java.lang.String s, int startPos) Returns the 'name' part of an expression of the form "name(content)"
static NameValueResult	getNameAndMandatoryValueUntrimmedFromEscaped(java.lang.String s, int startPos) Returns the 'name' part of an expression of the form "name(content)"
static NameValueResult	getNameValueFromEscaped(java.lang.String s, int startPos) Returns the 'name' part of an expression of the form "name(content)"
static NameValueResult	getNameValueFromNonEscaped(java.lang.String s, int startPos) Returns the 'name' part of an expression of the form "name(content)"
static NameValueResult	getNameValueUntrimmedFromEscaped(java.lang.String s, int startPos) Returns the 'name' part of an expression of the form "name(content)"
static java.lang.String	meta(java.lang.String s) Adapts a given string for representation of the siraprise metalanguage characters ()\
static java.lang.String	removeSuperfluousOuterBrackets(java.lang.String arg) Removes superfluous outer brackets from arg.
static java.util.LinkedList<java.lang.String>	splitIntoExpressions(java.lang.String arg2, int remainingFreeArguments) Gets the multiple expressions that are in the comma-separated list arg2
static java.lang.String	unMeta(java.lang.String s) Translates strings in SIRA_PRISE meta language to their actual value.
static java.lang.String	unMetaWithoutException(java.lang.String s) Translates strings in SIRA_PRISE meta language to their actual value.

Methods inherited from class java.lang.Object

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

Constructor Detail

BracketParser

public BracketParser()

Method Detail

createHashMapFromEscaped

public static java.util.HashMap<java.lang.String,java.lang.String> createHashMapFromEscaped(java.lang.String s)
                                                                                     throws NoClosingBracketException,
                                                                                            InvalidEscapedCharacterException,
                                                                                            MissingEscapedCharacterException,
                                                                                            DuplicateNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createHashMapFromNonEscaped

public static java.util.HashMap<java.lang.String,java.lang.String> createHashMapFromNonEscaped(java.lang.String s)
                                                                                        throws NoClosingBracketException,
                                                                                               DuplicateNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A HashMap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createHashMapWithMandatoryValuesFromEscaped

public static java.util.HashMap<java.lang.String,java.lang.String> createHashMapWithMandatoryValuesFromEscaped(java.lang.String s)
                                                                                                        throws DuplicateNameException,
                                                                                                               NoClosingBracketException,
                                                                                                               InvalidEscapedCharacterException,
                                                                                                               MissingEscapedCharacterException,
                                                                                                               NoValueCorrespondingToNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

createHashMapWithMandatoryValuesFromNonEscaped

public static java.util.HashMap<java.lang.String,java.lang.String> createHashMapWithMandatoryValuesFromNonEscaped(java.lang.String s)
                                                                                                           throws DuplicateNameException,
                                                                                                                  NoClosingBracketException,
                                                                                                                  NoValueCorrespondingToNameException

Creates a HashMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

createListFromEscaped

public static java.util.LinkedList<java.lang.String> createListFromEscaped(java.lang.String s)
                                                                    throws NoClosingBracketException,
                                                                           InvalidEscapedCharacterException,
                                                                           MissingEscapedCharacterException,
                                                                           NoValueCorrespondingToNameException

Creates a List of values contained in a String in the general format Name1(value1)Name2(value2)... An entry is added for each name in the String, holding the value that appears within parentheses.

Parameters:

s - A string in the general format name1(value1)name2(value2)...

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If a name with no corresponding value is contained.

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\ If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

createListFromNonEscaped

public static java.util.LinkedList<java.lang.String> createListFromNonEscaped(java.lang.String s)
                                                                       throws NoClosingBracketException,
                                                                              NoValueCorrespondingToNameException

Creates a List of values contained in a String in the general format Name1(value1)Name2(value2)... An entry is added for each name in the String, holding the value that appears within parentheses.

Parameters:

s - A string in the general format name1(value1)name2(value2)...

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

NoValueCorrespondingToNameException - If a name with no corresponding value is contained.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

createMapFromEscapedString

public static java.util.Map<java.lang.String,java.lang.String> createMapFromEscapedString(java.lang.String s,
                                                                                          boolean emptyMapAllowed)
                                                                                   throws NoClosingBracketException,
                                                                                          InvalidEscapedCharacterException,
                                                                                          MissingEscapedCharacterException,
                                                                                          NoValueCorrespondingToNameException,
                                                                                          DuplicateNameException

Parses a bracketed String and builds a hashmap with the information contained within the (map) value is the (attribute) value, also in string format.

Parameters:

s - The textual representation of a bracketed expression

emptyMapAllowed - true if the result is not expected to contain at least one entry

Returns:

An attributevaluemap containing attribute name/value pairs. The key is the name in string format,

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

createTreeMapFromEscaped

public static java.util.TreeMap<java.lang.String,java.lang.String> createTreeMapFromEscaped(java.lang.String s)
                                                                                     throws NoClosingBracketException,
                                                                                            InvalidEscapedCharacterException,
                                                                                            MissingEscapedCharacterException,
                                                                                            DuplicateNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A hashmap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createTreeMapFromNonEscaped

public static java.util.TreeMap<java.lang.String,java.lang.String> createTreeMapFromNonEscaped(java.lang.String s)
                                                                                        throws NoClosingBracketException,
                                                                                               DuplicateNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A TreeMap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name.

createTreeMapWithMandatoryValuesFromEscaped

public static java.util.TreeMap<java.lang.String,java.lang.String> createTreeMapWithMandatoryValuesFromEscaped(java.lang.String s)
                                                                                                        throws DuplicateNameException,
                                                                                                               NoClosingBracketException,
                                                                                                               InvalidEscapedCharacterException,
                                                                                                               MissingEscapedCharacterException,
                                                                                                               NoValueCorrespondingToNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

Returns:

A Treemap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

createTreeMapWithMandatoryValuesFromNonEscaped

public static java.util.TreeMap<java.lang.String,java.lang.String> createTreeMapWithMandatoryValuesFromNonEscaped(java.lang.String s)
                                                                                                           throws DuplicateNameException,
                                                                                                                  NoClosingBracketException,
                                                                                                                  NoValueCorrespondingToNameException

Creates a TreeMap for a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses with that name

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

Returns:

A Treemap holding an entry for each name(value) pair in the input text, where key=name and value=value

Throws:

DuplicateNameException - If the String argument contains a duplicate name.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

fillMapFromEscaped

public static void fillMapFromEscaped(java.lang.String s,
                                      java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
                               throws NoClosingBracketException,
                                      InvalidEscapedCharacterException,
                                      MissingEscapedCharacterException,
                                      DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... The 'value' parts are in escaped format, i.e. ()\ tokens that are part of the value, should be contained as \(, \), \\.

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

fillMapFromNonEscaped

public static void fillMapFromNonEscaped(java.lang.String s,
                                         java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
                                  throws NoClosingBracketException,
                                         DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

fillMapWithMandatoryValuesFromEscaped

public static void fillMapWithMandatoryValuesFromEscaped(java.lang.String s,
                                                         java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
                                                  throws NoClosingBracketException,
                                                         InvalidEscapedCharacterException,
                                                         MissingEscapedCharacterException,
                                                         NoValueCorrespondingToNameException,
                                                         DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

fillMapWithMandatoryValuesFromNonEscaped

public static void fillMapWithMandatoryValuesFromNonEscaped(java.lang.String s,
                                                            java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
                                                     throws NoClosingBracketException,
                                                            NoValueCorrespondingToNameException,
                                                            DuplicateNameException

Filles the given Map with the entries held in a String in the general format Name1(value1)Name2(value2)... An entry is added to the map for each name in the String, and the corresponding value is the value that appears within parentheses for that name.

Parameters:

s - A string in the general format name1(value1)name2(value2)... Values cannot hold any tokens of the meta language, i.e. one of ()\ .

attributeValueMap - The map to be filled. May or may not be empty. If non-empty at the moment of invocation, entries from the String argument will be added to the Map, in addition to those that were already present.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

fillNonEmptyMapWithMandatoryValuesFromEscaped

public static void fillNonEmptyMapWithMandatoryValuesFromEscaped(java.lang.String s,
                                                                 java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
                                                          throws NoClosingBracketException,
                                                                 InvalidEscapedCharacterException,
                                                                 MissingEscapedCharacterException,
                                                                 NoValueCorrespondingToNameException,
                                                                 DuplicateNameException

Parameters:

s - The string to parse

attributeValueMap - The map to fill

Throws:

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

fillNonEmptyMapWithMandatoryValuesFromNonEscaped

public static void fillNonEmptyMapWithMandatoryValuesFromNonEscaped(java.lang.String s,
                                                                    java.util.Map<java.lang.String,java.lang.String> attributeValueMap)
                                                             throws NoClosingBracketException,
                                                                    NoValueCorrespondingToNameException,
                                                                    DuplicateNameException

Parameters:

s - The string to parse

attributeValueMap - The map to fill

Throws:

DuplicateNameException - If the String argument contains a duplicate name, or contains a name for which the given map already holds an entry.

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

findCorrespondingClosingBracket

public static int findCorrespondingClosingBracket(java.lang.String s)
                                           throws NoClosingBracketException

Find the position of the closing bracket that matches the opening bracket in position 0. It is assumed that the input indeed starts with an opening bracket, otherwise there obviously is no need for calling this method in the first place.

Parameters:

s - A String holding a bracketed expression that begins with an opening bracket

Returns:

the position in the String that holds the closing bracket that corresponds to the opening bracket in position 0.

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

getNameAndMandatoryValueFromEscaped

public static NameValueResult getNameAndMandatoryValueFromEscaped(java.lang.String s,
                                                                  int startPos)
                                                           throws NoClosingBracketException,
                                                                  InvalidEscapedCharacterException,
                                                                  MissingEscapedCharacterException,
                                                                  NoValueCorrespondingToNameException

Returns the 'name' part of an expression of the form "name(content)"

Parameters:

s - a string of the general form name(content)

startPos - The first position in s to inspect for the name, in the range [0...length-1]

Returns:

the name of the object that the command refers to

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\ If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

getNameAndMandatoryValueFromNonEscaped

public static NameValueResult getNameAndMandatoryValueFromNonEscaped(java.lang.String s,
                                                                     int startPos)
                                                              throws NoClosingBracketException,
                                                                     NoValueCorrespondingToNameException

Returns the 'name' part of an expression of the form "name(content)"

Parameters:

s - a string of the general form name(content)

startPos - The first position in s to inspect for the name, in the range [0...length-1]

Returns:

the name of the object that the command refers to

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

getNameAndMandatoryValueUntrimmedFromEscaped

public static NameValueResult getNameAndMandatoryValueUntrimmedFromEscaped(java.lang.String s,
                                                                           int startPos)
                                                                    throws NoClosingBracketException,
                                                                           InvalidEscapedCharacterException,
                                                                           MissingEscapedCharacterException,
                                                                           NoValueCorrespondingToNameException

Returns the 'name' part of an expression of the form "name(content)"

Parameters:

s - a string of the general form name(content)

startPos - The first position in s to inspect for the name, in the range [0...length-1]

Returns:

the name of the object that the command refers to

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\ If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

getNameValueFromEscaped

public static NameValueResult getNameValueFromEscaped(java.lang.String s,
                                                      int startPos)
                                               throws NoClosingBracketException,
                                                      InvalidEscapedCharacterException,
                                                      MissingEscapedCharacterException

Returns the 'name' part of an expression of the form "name(content)"

Parameters:

s - a string of the general form name(content)

startPos - The first position in s to inspect for the name, in the range [0...length-1]

Returns:

the name of the object that the command refers to

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\ If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

getNameValueFromNonEscaped

public static NameValueResult getNameValueFromNonEscaped(java.lang.String s,
                                                         int startPos)
                                                  throws NoClosingBracketException

Returns the 'name' part of an expression of the form "name(content)"

Parameters:

s - a string of the general form name(content)

startPos - The first position in s to inspect for the name, in the range [0...length-1]

Returns:

the name of the object that the command refers to

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

getNameValueUntrimmedFromEscaped

public static NameValueResult getNameValueUntrimmedFromEscaped(java.lang.String s,
                                                               int startPos)
                                                        throws NoClosingBracketException,
                                                               InvalidEscapedCharacterException,
                                                               MissingEscapedCharacterException

Returns the 'name' part of an expression of the form "name(content)"

Parameters:

s - a string of the general form name(content)

startPos - The first position in s to inspect for the name, in the range [0...length-1]

Returns:

the name of the object that the command refers to

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\ If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

meta

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

Adapts a given string for representation of the siraprise metalanguage characters ()\

Parameters:

s - The string to be adapted for representation of the siraprise metalanguage characters ()\

Returns:

The string s, adapted for representation of the siraprise metalanguage characters ()\

removeSuperfluousOuterBrackets

public static java.lang.String removeSuperfluousOuterBrackets(java.lang.String arg)

Removes superfluous outer brackets from arg. e.g. (A) will return A, whereas (A)(B) will return its input.

Parameters:

arg - The argument from which superfluous outer brackets are to be removed

Returns:

The argument, with all its superfluous outer brackets removed.

unMeta

public static java.lang.String unMeta(java.lang.String s)
                               throws InvalidEscapedCharacterException,
                                      MissingEscapedCharacterException

Translates strings in SIRA_PRISE meta language to their actual value. This means any occurence of '\\' is replaced by '\', '\(' by '(' and '\)' by ')'

Parameters:

s - The string to be un-meta-ified

Returns:

The un-meta-ified string

Throws:

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\ If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

unMetaWithoutException

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

Translates strings in SIRA_PRISE meta language to their actual value. This means any occurence of '\\' is replaced by '\', '\(' by '(' and '\)' by ')'. Invalid escape sequences in the string argument result in an IllegalArgumentException.

Parameters:

s - The string to be un-meta-ified

Returns:

The un-meta-ified string

splitIntoExpressions

public static java.util.LinkedList<java.lang.String> splitIntoExpressions(java.lang.String arg2,
                                                                          int remainingFreeArguments)
                                                                   throws NoClosingBracketException,
                                                                          InvalidEscapedCharacterException,
                                                                          MissingEscapedCharacterException,
                                                                          NoValueCorrespondingToNameException,
                                                                          SeparatorCommaMissingException

Gets the multiple expressions that are in the comma-separated list arg2

Parameters:

arg2 - The argument to be further split into several expressions

remainingFreeArguments - The maximum number of arguments to be returned

Returns:

An array of string expressions

Throws:

NoClosingBracketException - If an opening bracket was found with an unmatched closing bracket

InvalidEscapedCharacterException - If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\ If the string argument contains an invalid escape sequence, i.e. a backslash followed by a character other than ()\

MissingEscapedCharacterException - If the string argument ends with the escape token (backslash), with the subsequent escaped character missing

NoValueCorrespondingToNameException - If the string does not hold any opening bracket, meaning a name with no corresponding value is contained.

SeparatorCommaMissingException - If a separator comma was expected but missing