bjc.everge

Class ControlledString

java.lang.Object

bjc.everge.ControlledString

public class ControlledString
extends Object

Represents a string with a set of control flags attached to it.

Author:

Ben Culkin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlledString.Control Represents a single control (a key-values pair)

Field Summary

Fields

Modifier and Type	Field and Description
ControlledString.Control[]	controls The controls that apply to the string.
String	strang The string the controls apply to.

Constructor Summary

Constructors

Constructor and Description
ControlledString() Create a new blank controlled string.
ControlledString(String strung) Create a new controlled string without any controls.
ControlledString(String strung, ControlledString.Control... controls) Create a new controlled string.

Method Summary

Modifier and Type	Method and Description
boolean	hasControls() Check if the string has controls.
static ControlledString	parse(String lne, String contInd, String contSep, String contArg, String contEsc) Parse a controlled string from a regular string.

Methods inherited from class java.lang.Object

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

Field Detail

strang

public String strang

The string the controls apply to.

controls

public ControlledString.Control[] controls

The controls that apply to the string.

Constructor Detail

ControlledString

public ControlledString()

Create a new blank controlled string.

ControlledString

public ControlledString(String strung)

Create a new controlled string without any controls.

Parameters:

strung - The string to use.

ControlledString

public ControlledString(String strung,
                        ControlledString.Control... controls)

Create a new controlled string.

Parameters:

strung - The string to use.

controls - The controls that apply to the string.

Method Detail

hasControls

public boolean hasControls()

Check if the string has controls.

Returns:

Whether or not the string has controls.

parse

public static ControlledString parse(String lne,
                                     String contInd,
                                     String contSep,
                                     String contArg,
                                     String contEsc)

Parse a controlled string from a regular string. The controls must be parsed from the beginning of the string, and are indicated by occurances of contInd that bracket them from the string. The individual controls are delimited by instances of contSep, with arguments to them being separated by occurances of contArg. Each of those separators (which must be regular strings, not regexes or anything) may be escaped by preceeding them with a copy of contEsc.

Parameters:

lne - The string to parse frmo.

contInd - The indicator for whether or not there are controls.

contSep - The separator of individual controls.

contArg - The separator of control arguments.

contEsc - The escape string for each of the separators/indicators.

Returns:

A parsed control string.