TextSourceEncounter (lect-engine 0.2.0 API)

```
public interface TextSourceEncounter
```
Encounter given to TextSources when they should parse their content. Sources should use location(Location) to update the location of things before calling methods such as startParagraph(), text(CharSequence, Location) and endParagraph().
Sources may set attributes on tokens emitted via setAttribute(TokenProperty, Object) and clearAttribute(TokenProperty).

Author:

Andreas Holstenson

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearAttribute(TokenProperty<?> attribute)` Clear an attribute.
`void`	`done()` Indicate that we are done parsing.
`void`	`endParagraph()` End current paragraph-level content.
`boolean`	`inParagraph()` Check if we are currently in a paragraph.
`Locale`	`locale()` Get the locale we are building the tree for.
`Location`	`location()` Get the currently set location.
`void`	`location(Location location)` Set the location of the next event.
`<T> void`	`setAttribute(TokenProperty<T> attribute, T value)` Set an attribute at the current location.
`void`	`startParagraph()` Start new paragraph-level content.
`void`	`text(CharSequence text, Location end)` Add some text.

- Method Detail
  - locale
```
Locale locale()
```
    Get the locale we are building the tree for.
    
    Returns:
  - location
```
Location location()
```
    Get the currently set location.
    
    Returns:
  - location
```
void location(Location location)
```
    Set the location of the next event.
    
    Parameters:
    
    location -
  - inParagraph
```
boolean inParagraph()
```
    Check if we are currently in a paragraph.
    
    Returns:
  - startParagraph
```
void startParagraph()
```
    Start new paragraph-level content.
  - endParagraph
```
void endParagraph()
```
    End current paragraph-level content.
  - done
```
void done()
```
    Indicate that we are done parsing.
  - text
```
void text(CharSequence text,
          Location end)
```
    Add some text. If the text is outside a paragraph this method will only accept whitespace. If it is within a paragraph the text will automatically be processed by the LanguageParser and split into sentences and tokens such as words, symbols and whitespace.
    All of the text in a paragraph does not need to be added at once, it is possible to add it in chunks. For example a HTML parser will decode entities and will want update the source location as it does this.
    
    Parameters:
    
    text - the text to add
    
    end - the location at which the text ends
  - setAttribute
```
<T> void setAttribute(TokenProperty<T> attribute,
                      T value)
```
    Set an attribute at the current location.
    
    Parameters:
    
    attribute -
    
    value -
  - clearAttribute
```
void clearAttribute(TokenProperty<?> attribute)
```
    Clear an attribute.
    
    Parameters:
    
    attribute -

Interface TextSourceEncounter

Method Summary

Method Detail

locale

location

location

inParagraph

startParagraph

endParagraph

done

text

setAttribute

clearAttribute