XTokenQueue (xsoup 0.3.7 API)

java.lang.Object
- us.codecraft.xsoup.XTokenQueue

```
public class XTokenQueue
extends Object
```
A character queue with parsing helpers.
Most code borrowed from TokenQueue

Author:

Jonathan Hedley

See Also:

TokenQueue

Constructor Summary

Constructors
Constructor and Description

XTokenQueue(String data)
Create a new TokenQueue.

Constructors
Constructor and Description
`XTokenQueue(String data)` Create a new TokenQueue.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFirst(Character c)` Add a character to the start of the queue (will be the next character retrieved).
`void`	`addFirst(String seq)` Add a string to the start of the queue.
`void`	`advance()` Drops the next character off the queue.
`String`	`chompBalanced(char open, char close)` Pulls a balanced string off the queue.
`String`	`chompBalancedNotInQuotes(char open, char close)`
`String`	`chompBalancedQuotes()`
`String`	`chompTo(String seq)` Pulls a string off the queue (like consumeTo), and then pulls off the matched string (but does not return it).
`String`	`chompToIgnoreCase(String seq)`
`char`	`consume()` Consume one character off queue.
`void`	`consume(String seq)` Consumes the supplied sequence of the queue.
`String`	`consumeAny(String... seq)`
`String`	`consumeAttributeKey()` Consume an attribute key off the queue (letter, digit, -, _, :")
`String`	`consumeCssIdentifier()` Consume a CSS identifier (ID or class) off the queue (letter, digit, -, _) http://www.w3.org/TR/CSS2/syndata.html#value-def-identifier
`String`	`consumeElementSelector()` Consume a CSS element selector (tag name, but \| instead of : for namespaces, to not conflict with :pseudo selects).
`String`	`consumeTagName()` Consume an tag name off the queue (word or :, _, -)
`String`	`consumeTo(String seq)` Pulls a string off the queue, up to but exclusive of the match sequence, or to the queue running out.
`String`	`consumeToAny(String... seq)` Consumes to the first sequence provided, or to the end of the queue.
`String`	`consumeToIgnoreCase(String seq)`
`String`	`consumeToUnescaped(String str)`
`boolean`	`consumeWhitespace()` Pulls the next run of whitespace characters of the queue.
`String`	`consumeWord()` Retrieves the next run of word type (letter or digit) off the queue.
`boolean`	`containsAny(String... seq)`
`boolean`	`isEmpty()` Is the queue empty?
`boolean`	`matchChomp(String seq)` Tests if the queue matches the sequence (as with match), and if they do, removes the matched string from the queue.
`boolean`	`matches(String seq)` Tests if the next characters on the queue match the sequence.
`boolean`	`matchesAny(char... seq)`
`boolean`	`matchesAny(String... seq)` Tests if the next characters match any of the sequences.
`boolean`	`matchesCS(String seq)` Case sensitive match test.
`boolean`	`matchesRegex(String seq)`
`boolean`	`matchesStartTag()`
`boolean`	`matchesWhitespace()` Tests if queue starts with a whitespace character.
`boolean`	`matchesWord()` Test if the queue matches a word character (letter or digit).
`List<String>`	`parseFuncionParams()`
`static List<String>`	`parseFuncionParams(String paramStr)`
`char`	`peek()` Retrieves but does not remove the first character from the queue.
`String`	`remainder()` Consume and return whatever is left on the queue.
`String`	`toString()`
`static List<String>`	`trimQuotes(List<String> strs)`
`static String`	`trimQuotes(String str)`
`void`	`unConsume(int length)`
`void`	`unConsume(String word)`
`static String`	`unescape(String in)` Unescaped a \ escaped string.

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

- Constructor Detail
  - XTokenQueue
```
public XTokenQueue(String data)
```
    Create a new TokenQueue.
    
    Parameters:
    
    data - string of data to back queue.
- Method Detail
  - unescape
```
public static String unescape(String in)
```
    Unescaped a \ escaped string.
    
    Parameters:
    
    in - backslash escaped string
    
    Returns:
    
    unescaped string
  - trimQuotes
```
public static String trimQuotes(String str)
```
  - trimQuotes
```
public static List<String> trimQuotes(List<String> strs)
```
  - parseFuncionParams
```
public static List<String> parseFuncionParams(String paramStr)
```
  - isEmpty
```
public boolean isEmpty()
```
    Is the queue empty?
    
    Returns:
    
    true if no data left in queue.
  - peek
```
public char peek()
```
    Retrieves but does not remove the first character from the queue.
    
    Returns:
    
    First character, or 0 if empty.
  - addFirst
```
public void addFirst(Character c)
```
    Add a character to the start of the queue (will be the next character retrieved).
    
    Parameters:
    
    c - character to add
  - addFirst
```
public void addFirst(String seq)
```
    Add a string to the start of the queue.
    
    Parameters:
    
    seq - string to add.
  - matches
```
public boolean matches(String seq)
```
    Tests if the next characters on the queue match the sequence. Case insensitive.
    
    Parameters:
    
    seq - String to check queue for.
    
    Returns:
    
    true if the next characters match.
  - matchesRegex
```
public boolean matchesRegex(String seq)
```
  - matchesCS
```
public boolean matchesCS(String seq)
```
    Case sensitive match test.
    
    Parameters:
    
    seq - string to case sensitively check for
    
    Returns:
    
    true if matched, false if not
  - matchesAny
```
public boolean matchesAny(String... seq)
```
    Tests if the next characters match any of the sequences. Case insensitive.
    
    Parameters:
    
    seq - list of strings to case insensitively check for
    
    Returns:
    
    true of any matched, false if none did
  - matchesAny
```
public boolean matchesAny(char... seq)
```
  - matchesStartTag
```
public boolean matchesStartTag()
```
  - matchChomp
```
public boolean matchChomp(String seq)
```
    Tests if the queue matches the sequence (as with match), and if they do, removes the matched string from the queue.
    
    Parameters:
    
    seq - String to search for, and if found, remove from queue.
    
    Returns:
    
    true if found and removed, false if not found.
  - matchesWhitespace
```
public boolean matchesWhitespace()
```
    Tests if queue starts with a whitespace character.
    
    Returns:
    
    if starts with whitespace
  - matchesWord
```
public boolean matchesWord()
```
    Test if the queue matches a word character (letter or digit).
    
    Returns:
    
    if matches a word character
  - advance
```
public void advance()
```
    Drops the next character off the queue.
  - consume
```
public char consume()
```
    Consume one character off queue.
    
    Returns:
    
    first character on queue.
  - consume
```
public void consume(String seq)
```
    Consumes the supplied sequence of the queue. If the queue does not start with the supplied sequence, will throw an illegal state exception -- but you should be running match() against that condition.
    Case insensitive.
    
    Parameters:
    
    seq - sequence to remove from head of queue.
  - consumeTo
```
public String consumeTo(String seq)
```
    Pulls a string off the queue, up to but exclusive of the match sequence, or to the queue running out.
    
    Parameters:
    
    seq - String to end on (and not include in return, but leave on queue). Case sensitive.
    
    Returns:
    
    The matched data consumed from queue.
  - consumeToIgnoreCase
```
public String consumeToIgnoreCase(String seq)
```
  - consumeToAny
```
public String consumeToAny(String... seq)
```
    Consumes to the first sequence provided, or to the end of the queue. Leaves the terminator on the queue.
    
    Parameters:
    
    seq - any number of terminators to consume to. Case insensitive.
    
    Returns:
    
    consumed string
  - consumeAny
```
public String consumeAny(String... seq)
```
  - chompTo
```
public String chompTo(String seq)
```
    Pulls a string off the queue (like consumeTo), and then pulls off the matched string (but does not return it).
    If the queue runs out of characters before finding the seq, will return as much as it can (and queue will go isEmpty() == true).
    
    Parameters:
    
    seq - String to match up to, and not include in return, and to pull off queue. Case sensitive.
    
    Returns:
    
    Data matched from queue.
  - chompToIgnoreCase
```
public String chompToIgnoreCase(String seq)
```
  - chompBalancedQuotes
```
public String chompBalancedQuotes()
```
  - chompBalancedNotInQuotes
```
public String chompBalancedNotInQuotes(char open,
                                       char close)
```
  - chompBalanced
```
public String chompBalanced(char open,
                            char close)
```
    Pulls a balanced string off the queue. E.g. if queue is "(one (two) three) four", (,) will return "one (two) three", and leave " four" on the queue. Unbalanced openers and closers can be escaped (with \). Those escapes will be left in the returned string, which is suitable for regexes (where we need to preserve the escape), but unsuitable for contains text strings; use unescape for that.
    
    Parameters:
    
    open - opener
    
    close - closer
    
    Returns:
    
    data matched from the queue
  - consumeWhitespace
```
public boolean consumeWhitespace()
```
    Pulls the next run of whitespace characters of the queue.
    
    Returns:
    
    seen
  - consumeWord
```
public String consumeWord()
```
    Retrieves the next run of word type (letter or digit) off the queue.
    
    Returns:
    
    String of word characters from queue, or empty string if none.
  - consumeTagName
```
public String consumeTagName()
```
    Consume an tag name off the queue (word or :, _, -)
    
    Returns:
    
    tag name
  - consumeElementSelector
```
public String consumeElementSelector()
```
    Consume a CSS element selector (tag name, but | instead of : for namespaces, to not conflict with :pseudo selects).
    
    Returns:
    
    tag name
  - unConsume
```
public void unConsume(int length)
```
  - unConsume
```
public void unConsume(String word)
```
  - consumeCssIdentifier
```
public String consumeCssIdentifier()
```
    Consume a CSS identifier (ID or class) off the queue (letter, digit, -, _) http://www.w3.org/TR/CSS2/syndata.html#value-def-identifier
    
    Returns:
    
    identifier
  - consumeAttributeKey
```
public String consumeAttributeKey()
```
    Consume an attribute key off the queue (letter, digit, -, _, :")
    
    Returns:
    
    attribute key
  - remainder
```
public String remainder()
```
    Consume and return whatever is left on the queue.
    
    Returns:
    
    remained of queue.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - containsAny
```
public boolean containsAny(String... seq)
```
  - consumeToUnescaped
```
public String consumeToUnescaped(String str)
```
  - parseFuncionParams
```
public List<String> parseFuncionParams()
```

Class XTokenQueue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XTokenQueue

Method Detail

unescape

trimQuotes

trimQuotes

parseFuncionParams

isEmpty

peek

addFirst

addFirst

matches

matchesRegex

matchesCS

matchesAny

matchesAny

matchesStartTag

matchChomp

matchesWhitespace

matchesWord

advance

consume

consume

consumeTo

consumeToIgnoreCase

consumeToAny

consumeAny

chompTo

chompToIgnoreCase

chompBalancedQuotes

chompBalancedNotInQuotes

chompBalanced

consumeWhitespace

consumeWord

consumeTagName

consumeElementSelector

unConsume

unConsume

consumeCssIdentifier

consumeAttributeKey

remainder

toString

containsAny

consumeToUnescaped

parseFuncionParams