Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.biojavax.bio.phylo.io.nexus
Class CharactersBlockParser

    java.lang.Object
      org.biojavax.bio.phylo.io.nexus.NexusBlockParser.Abstract
          org.biojavax.bio.phylo.io.nexus.CharactersBlockParser

All Implemented Interfaces:
  NexusBlockParser

Direct Known Subclasses:
  DataBlockParser

    public class CharactersBlockParser

extends NexusBlockParser.Abstract

Parses Nexus characters blocks.

Since:
  1.6
Author:
  Richard Holland, Tobias Thierer, Jim Balhoff

Nested Class Summary

Nested classes/interfaces inherited from interface org.biojavax.bio.phylo.io.nexus.NexusBlockParser
`NexusBlockParser.Abstract`

Field Summary

Fields inherited from interface org.biojavax.bio.phylo.io.nexus.NexusBlockParser
`UNKNOWN_BLOCK`

Constructor Summary
`CharactersBlockParser(CharactersBlockListener blockListener)` Delegates to NexusBlockParser.Abstract.

Method Summary
`void` | `parseToken(String token)` Notifies the parser of the next token.
`void` | `resetStatus()` This function is called when the parser is reset before starting a new block.
`boolean` | `wantsBracketsAndBraces()` Does the listener want to know about brackets and braces as separate tokens?

Methods inherited from class org.biojavax.bio.phylo.io.nexus.NexusBlockParser.Abstract
`beginComment, commentText, endBlock, endComment, endTokenGroup, getBlockListener, getBlockName, startBlock`

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

Constructor Detail

### CharactersBlockParser

    public CharactersBlockParser(CharactersBlockListener blockListener)

  Delegates to NexusBlockParser.Abstract.

  Parameters:
    `blockListener` - the listener to send parse events to.

Method Detail

### resetStatus

    public void resetStatus()

  Description copied from class: `NexusBlockParser.Abstract`
  This function is called when the parser is reset before starting a new block.

  Specified by:
    `resetStatus` in class `NexusBlockParser.Abstract`

### wantsBracketsAndBraces

    public boolean wantsBracketsAndBraces()

  Description copied from interface: `NexusBlockParser`
  Does the listener want to know about brackets and braces as separate tokens?

  Specified by:
    `wantsBracketsAndBraces` in interface `NexusBlockParser`
  Overrides:
    `wantsBracketsAndBraces` in class `NexusBlockParser.Abstract`
  Returns:
    `true` if it does.

### parseToken

    public void parseToken(String token)
                    throws ParseException

  Description copied from interface: `NexusBlockParser`
  Notifies the parser of the next token. Comment tokens will already have been parsed out and sent separately to the text() method of the listener. Quoted strings will have been parsed and underscores converted. What this token contains is the full string, after removal of quotes if necessary. The token will never be only whitespace.

  Specified by:
    `parseToken` in interface `NexusBlockParser`
  Specified by:
    `parseToken` in class `NexusBlockParser.Abstract`
  Parameters:
    `token` - the token to parse.
  Throws:
    `ParseException` - if the token is unparseable.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD