YamlTokeniser (OpenHFT/Chronicle-Wire 2.26ea3 API)

java.lang.Object
- net.openhft.chronicle.wire.YamlTokeniser

```
public class YamlTokeniser
extends Object
```
A tokenizer for YAML documents. The YamlTokeniser class is responsible for converting a raw YAML input into individual tokens, each representing a distinct construct or symbol in YAML. This class is integral to processes such as parsing or tokenization of YAML documents.

Field Summary

Fields
Modifier and Type Field and Description

protected List<net.openhft.chronicle.wire.YamlTokeniser.YTContext> contexts
Stack to manage contextual information during tokenization.

Fields
Modifier and Type	Field and Description
`protected List<net.openhft.chronicle.wire.YamlTokeniser.YTContext>`	`contexts` Stack to manage contextual information during tokenization.

Constructor Summary

Constructors
Constructor and Description

YamlTokeniser(net.openhft.chronicle.bytes.BytesIn<?> in)
Constructs a new YAML tokenizer with the specified input.

Constructors
Constructor and Description
`YamlTokeniser(net.openhft.chronicle.bytes.BytesIn<?> in)` Constructs a new YAML tokenizer with the specified input.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`blockEnd()` Gets the end position of the current block in the stream.
`char`	`blockQuote()` Gets the current block's quotation character.
`long`	`blockStart()` Gets the start position of the current block in the stream.
`YamlToken`	`context()` Returns the context of the YAML tokenization process.
`int`	`contextSize()` Retrieves the number of context objects currently being managed.
`YamlToken`	`current()` Gets the current token in the tokenization process.
`boolean`	`isText(String s)` Checks if the text of the current block is equal to the provided string.
`YamlKeys`	`keys()` Retrieves the YamlKeys associated with the top context.
`long`	`lineStart()` Gets the start position of the current line in the stream.
`void`	`lineStart(long lineStart)` Sets the start position of the current line in the stream.
`YamlToken`	`next()` Fetches the next token based on the current context's indentation.
`@NotNull YamlToken`	`next(int minIndent)` Retrieves the next YAML token considering the minimum indentation provided.
`double`	`parseDouble()` Parses the current block's content as a double.
`long`	`parseLong()` Parses the current block's content as a long.
`void`	`push(YamlToken token)` Adds a YamlToken to the list of pushed tokens.
`void`	`rereadFrom(long offset)` Resets the reading to start from the specified offset.
`net.openhft.chronicle.wire.YamlTokeniser.YTContext`	`secondTopContext()` Retrieves the second to top context from the context stack.
`String`	`text()` Used primarily for testing purposes to extract the current block's text.
`void`	`text(StringBuilder sb)` Extracts the text of the current block into the provided StringBuilder.
`net.openhft.chronicle.wire.YamlTokeniser.YTContext`	`topContext()` Retrieves the top context from the context stack.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - contexts
```
protected final List<net.openhft.chronicle.wire.YamlTokeniser.YTContext> contexts
```
    Stack to manage contextual information during tokenization.
- Constructor Detail
  - YamlTokeniser
```
public YamlTokeniser(net.openhft.chronicle.bytes.BytesIn<?> in)
```
    Constructs a new YAML tokenizer with the specified input.
    
    Parameters:
    
    in - The input source containing raw YAML content.
- Method Detail
  - contextSize
```
public int contextSize()
```
    Retrieves the number of context objects currently being managed.
    
    Returns:
    
    The size of the context list.
  - context
```
public YamlToken context()
```
    Returns the context of the YAML tokenization process. This method provides the top-level token context based on the tokenization history.
    
    Returns:
    
    The top context token if contexts are present, otherwise returns STREAM_START.
  - topContext
```
public net.openhft.chronicle.wire.YamlTokeniser.YTContext topContext()
```
    Retrieves the top context from the context stack. This method provides the most recent tokenization context.
    
    Returns:
    
    The top YTContext object from the context stack.
  - secondTopContext
```
public net.openhft.chronicle.wire.YamlTokeniser.YTContext secondTopContext()
```
    Retrieves the second to top context from the context stack. This method provides the tokenization context that's just below the topmost one.
    
    Returns:
    
    The second top YTContext object from the context stack.
  - current
```
public YamlToken current()
```
    Gets the current token in the tokenization process. If the last token was the start of the stream, this method fetches the next token.
    
    Returns:
    
    The current YamlToken object representing the tokenization status.
  - next
```
public YamlToken next()
```
    Fetches the next token based on the current context's indentation.
    
    Returns:
    
    The next YamlToken object in line based on the current indentation context.
  - next
```
@NotNull
public @NotNull YamlToken next(int minIndent)
```
    Retrieves the next YAML token considering the minimum indentation provided. This method drives the core tokenization process, fetching tokens based on the minimum indentation and updating the last token processed.
    
    Parameters:
    
    minIndent - The minimum indentation to consider while tokenizing.
    
    Returns:
    
    The next YamlToken object based on the specified indentation.
  - lineStart
```
public long lineStart()
```
    Gets the start position of the current line in the stream.
    
    Returns:
    
    the position of the start of the current line.
  - lineStart
```
public void lineStart(long lineStart)
```
    Sets the start position of the current line in the stream.
    
    Parameters:
    
    lineStart - the new starting position for the current line.
  - blockStart
```
public long blockStart()
```
    Gets the start position of the current block in the stream.
    
    Returns:
    
    the position of the start of the current block.
  - blockEnd
```
public long blockEnd()
```
    Gets the end position of the current block in the stream.
    
    Returns:
    
    the position of the end of the current block.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - blockQuote
```
public char blockQuote()
```
    Gets the current block's quotation character.
    
    Returns:
    
    the quotation character used in the current block, or 0 if none.
  - text
```
public String text()
```
    Used primarily for testing purposes to extract the current block's text.
    
    Returns:
    
    the text of the current block or an empty string if no text.
  - text
```
public void text(StringBuilder sb)
```
    Extracts the text of the current block into the provided StringBuilder.
    
    Parameters:
    
    sb - StringBuilder to which the block's text will be appended.
  - parseDouble
```
public double parseDouble()
```
    Parses the current block's content as a double.
    
    Returns:
    
    the parsed double value.
  - parseLong
```
public long parseLong()
```
    Parses the current block's content as a long. Handles octal numbers as well.
    
    Returns:
    
    the parsed long value.
  - push
```
public void push(YamlToken token)
```
    Adds a YamlToken to the list of pushed tokens.
    
    Parameters:
    
    token - The YamlToken to be pushed.
  - isText
```
public boolean isText(String s)
```
    Checks if the text of the current block is equal to the provided string.
    
    Parameters:
    
    s - The string to be checked.
    
    Returns:
    
    true if the text of the current block is equal to 's', false otherwise.
  - keys
```
public YamlKeys keys()
```
    Retrieves the YamlKeys associated with the top context. If none exist, a new YamlKeys object is created.
    
    Returns:
    
    The YamlKeys associated with the top context.
  - rereadFrom
```
public void rereadFrom(long offset)
```
    Resets the reading to start from the specified offset.
    
    Parameters:
    
    offset - The position from which the reading should start.

Class YamlTokeniser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

contexts

Constructor Detail

YamlTokeniser

Method Detail

contextSize

context

topContext

secondTopContext

current

next

next

lineStart

lineStart

blockStart

blockEnd

toString

blockQuote

text

text

parseDouble

parseLong

push

isText

keys

rereadFrom