ControlledString (everge 0.2.0 API)

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)
`static class`	`ControlledString.ParseStrings` Parameter class for defining how to parse a ControlledString.

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.

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`count()` Get the count of controls.
`boolean`	`hasControls()` Check if the string has controls.
`static ControlledString`	`parse(String lne, ControlledString.ParseStrings strangs)` Parse a controlled string from a regular string.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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.
  - count
```
public int count()
```
    Get the count of controls.
    
    Returns:
    
    The number of controls for this string.
  - parse
```
public static ControlledString parse(String lne,
                                     ControlledString.ParseStrings strangs)
```
    Parse a controlled string from a regular string. The controls must be parsed from the beginning of the string.
    
    Parameters:
    
    lne - The string to parse from.
    
    strangs - The object to read the strings from
    
    Returns:
    
    A parsed control string.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ControlledString

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

strang

controls

Constructor Detail

ControlledString

ControlledString

ControlledString

Method Detail

hasControls

count

parse

toString