jcfunc

Class escMatcher

java.lang.Object

jcfunc.escMatcher

public class escMatcher
extends java.lang.Object

Central class. Its functions are:

• matching control function in a text
• removing control function from the text
• parsing control functions

Typical invocation sequence is thus:

1. create: new escMatcher
2. set up working set of control functions (what functions are parsing?): setPatterns()
3. matches() and parse()

Constructor Summary

Constructors

Constructor and Description
escMatcher(int mode, int compileFlag) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(java.lang.String inputString) This method matches input string with patterns from Working set
java.util.ArrayList<Description>	parse(java.lang.String inputString) Main method.
java.util.ArrayList<Description>	parse(java.lang.String inputString, boolean ignorSequences) Main method.
java.lang.String	remove(java.lang.String inputString, CF func) Remove from input string control function's sequence only.
java.lang.String	removeAll(java.lang.String inputString) Remove from input string any control function's sequence only.
void	setPatterns(CF... cmds) Creates working set of patterns

Methods inherited from class java.lang.Object

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

Constructor Detail

escMatcher

public escMatcher(int mode,
          int compileFlag)

Constructor.

Parameters:

mode - - parsing mode, 7-bit or 8-bit

compileFlag - - control flags for 'Pattern.compile()' method

Method Detail

setPatterns

public void setPatterns(CF... cmds)

Creates working set of patterns

Parameters:

cmds - - array of control functions for parsing; if it is absent then all functions are set up

matches

public boolean matches(java.lang.String inputString)

This method matches input string with patterns from Working set

Parameters:

inputString - string for matching

Returns:

true if input string matches this matcher's pattern

remove

public java.lang.String remove(java.lang.String inputString,
                      CF func)

Remove from input string control function's sequence only. Substring which followed control function immediately is kept.

Parameters:

inputString - input string

func - removed control function

Returns:

string without stated control function

removeAll

public java.lang.String removeAll(java.lang.String inputString)

Remove from input string any control function's sequence only. Substring which followed control function immediately is kept.

Parameters:

inputString - input string

Returns:

string without any stated control functions

parse

public java.util.ArrayList<Description> parse(java.lang.String inputString)

Main method. It returns:

• found control function (CF)
• index of CF's first symbol (usually it's CF.CSI)
• offset after the last character matched (after end of substring)
• int-array of CF's parameters, if any

Parameters:

inputString - parsed string

Returns:

array list of Description's objects

parse

public java.util.ArrayList<Description> parse(java.lang.String inputString,
                                     boolean ignorSequences)

Main method. If ignorSequences is set FALSE then final indecies describe substrings WITH control functions and their parameters. Otherwise (TRUE) substrings include substrings (data) only.

Parameters:

inputString - parsed string

ignorSequences - affects to returned indecies

Returns:

array list of Description's objects