org.wikimodel.wem.impl
Class WikiScannerUtil

java.lang.Object
  org.wikimodel.wem.impl.WikiScannerUtil

public class WikiScannerUtil
extends Object

This class contains some utility methods used by scanners.

Author:

MikhailKotelnikov

Constructor Summary

WikiScannerUtil()

Method Summary

static String	extractSubstring(String str, String open, String close, char escape) Extracts and returns a substring of the given string starting from the given open sequence and finishing by the specified close sequence.
static int	getNextSequence(char[] array, int pos, char[] delimiter, StringBuffer buf) This method copies to the given buffer all characters from the specified position of the character array to the next delimiter position.
static int	getNextToken(char[] array, int pos, StringBuffer buf)
static int	removeSpaces(char[] array, int pos, StringBuffer buf) Moves forward the current position in the array until the first not empty character is found.
static int	skipSequence(char[] array, int arrayPos, char[] sequence) Skips the specified sequence if it starts from the given position in the character array.
static void	splitToPairs(String str, List<WikiParameter> list) Splits the given string into a set of key-value pairs; all extracted values will be added to the given list
static void	splitToPairs(String str, List<WikiParameter> list, String delimiter) Splits the given string into a set of key-value pairs; all extracted values will be added to the given list
static String	unescape(String str, char escape) Unescapes the given string and returns the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiScannerUtil

public WikiScannerUtil()

Method Detail

extractSubstring

public static String extractSubstring(String str,
                                      String open,
                                      String close,
                                      char escape)

Extracts and returns a substring of the given string starting from the given open sequence and finishing by the specified close sequence. This method unescapes all symbols prefixed by the given escape symbol.

Parameters:

str - from this string the substring framed by the specified open and close sequence will be returned

open - the start substring sequence

close - the closing substring sequence

escape - the escape symbol

Returns:

a substring of the given string starting from the given open sequence and finishing by the specified close sequence

getNextSequence

public static int getNextSequence(char[] array,
                                  int pos,
                                  char[] delimiter,
                                  StringBuffer buf)

This method copies to the given buffer all characters from the specified position of the character array to the next delimiter position. This method returns the next position just after the delimiter (or the length of the array if no delimiters was found).

Parameters:

array - the array of character used as a source of chars

pos - the start position in the array

delimiter - the delimiter; this method copies all character from the current position to the first delimiter sequence

buf - the buffer where the content should be appended

Returns:

the next position just after the delimiter of the end of the sequence

getNextToken

public static int getNextToken(char[] array,
                               int pos,
                               StringBuffer buf)

Parameters:

array - from this array of bytes the next token will be returned

pos - the current position in the array of bytes

buf - to this buffer the extracted token value will be appended

Returns:

the new position in the array after extracting of a new token

removeSpaces

public static int removeSpaces(char[] array,
                               int pos,
                               StringBuffer buf)

Moves forward the current position in the array until the first not empty character is found.

Parameters:

array - the array of characters where the spaces are searched

pos - the current position in the array; starting from this position the spaces will be searched

buf - to this buffer all not empty characters will be added

Returns:

the new position int the array of characters

skipSequence

public static int skipSequence(char[] array,
                               int arrayPos,
                               char[] sequence)

Skips the specified sequence if it starts from the given position in the character array.

Parameters:

array - the array of characters

arrayPos - the position of the first character in the array; starting from this position the sequence should be skipped

sequence - the sequence of characters to skip

Returns:

a new value of the character counter

splitToPairs

public static void splitToPairs(String str,
                                List<WikiParameter> list)

Splits the given string into a set of key-value pairs; all extracted values will be added to the given list

Parameters:

str - the string to split

list - to this list all extracted values will be added

splitToPairs

public static void splitToPairs(String str,
                                List<WikiParameter> list,
                                String delimiter)

Splits the given string into a set of key-value pairs; all extracted values will be added to the given list

Parameters:

str - the string to split

list - to this list all extracted values will be added

delimiter - a delimiter for individual key/value pairs

unescape

public static String unescape(String str,
                              char escape)

Unescapes the given string and returns the result.

Parameters:

str - the string to unescape

escape - the symbol used to escape characters

Returns:

an unescaped string