SGMLParser (TestHelpers 1.0-SNAPSHOT API)

java.lang.Object
- eu.simuline.util.sgml.SGMLParser

```
public final class SGMLParser
extends Object
```
A rudimentary SGML parser with something like a SAX-api.

Version:

1.0

Author:

Ernst Reissner

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`SGMLParser.AttributesWrapper` An ** partial ** implementation of the SAX-interface `Attributes` which allows to set name-value-pairs by method `SGMLParser.AttributesWrapper.addAttribute(java.lang.String, java.lang.String)`.
`(package private) static class`	`SGMLParser.Buffer` Class which buffers the read stream.
`(package private) static interface`	`SGMLParser.CharTester` Provides a single method which decides whether the given character passes a certain test.
`(package private) static class`	`SGMLParser.SpecCharTester` A `CharTester` which allows to specify the character which passes the test.
`(package private) static class`	`SGMLParser.TrivialContentHandler` A `ContentHandler` which simply ignores all events.
`(package private) static interface`	`SGMLParser.XMLsGMLspecifica` Provides a bunch of methods fpr parsing with implementations specific to xml and sgml.

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`ATTR_NAME` Short string representation of the object currently parsed.
`private static String`	`ATTR_VALUE` Short string representation of the object currently parsed.
`private SGMLParser.Buffer`	`buffer` The buffer of the input stream.
`private static int`	`BUFFER_SIZE` The size of the buffer used internally.
`private ContentHandler`	`contentHandler` The `ContentHandler` registered.
`private int`	`currChar` The current character or `-1` to signfy the end of the stream.
`private static String`	`END_TAG` Short string representation of the object currently parsed.
`private SGMLParser.XMLsGMLspecifica`	`htmlAttributeParser` Contains the `HTML`-specific part of the parser.
`private ParseExceptionHandler`	`parseExceptionHandler` The `ParseExceptionHandler` registered.
`private static String`	`PROC_INSTR` Short string representation of the object currently parsed.
`private static String`	`QUOTE_DOT`
`private static String`	`START_TAG` Short string representation of the object currently parsed.
`private static char`	`SYMB_COMMENT`
`private static char`	`SYMB_EQ`
`private static char`	`SYMB_TAG`
`private static SGMLParser.CharTester`	`TEST_BLANK_EQUALS_GT` Tests for `=` and for `>`.
`private static SGMLParser.CharTester`	`TEST_BLANK_GT` Tests for blank or `>`.
`private static SGMLParser.CharTester`	`TEST_BLANK_GT_SLASH` Tests for blank, `/`, `>`.
`private static SGMLParser.CharTester`	`TEST_END_OF_COMMENT` Tests for quote both for`'` and for `"`.
`private static SGMLParser.CharTester`	`TEST_GT` Tests for `>`.
`private static SGMLParser.CharTester`	`TEST_LT` Tests for `<`.
`private static SGMLParser.CharTester`	`TEST_NO_WHITESPACE` Tests for whitespace.
`private static SGMLParser.SpecCharTester`	`TEST_SPEC` Tests for a specified character.
`private static String`	`WHITESP_IN_ATTR` Short string representation of the object currently parsed.
`private SGMLParser.XMLsGMLspecifica`	`xmlAttributeParser` Contains the `XML`-specific part of the parser.
`private SGMLParser.XMLsGMLspecifica`	`xmlSgmlSpecifica` Contains class with methods specific for xml and sgml, respectively.

Constructor Summary

Constructors
Constructor and Description

SGMLParser()
Creates a new SGMLParser with the default handlers for content and exceptions.

Constructors
Constructor and Description
`SGMLParser()` Creates a new `SGMLParser` with the default handlers for content and exceptions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContentHandler`	`getContentHandler()` Returns `contentHandler`.
`ParseExceptionHandler`	`getExceptionHandler()` Returns `parseExceptionHandler`.
`boolean`	`isXMLParser()`
`(package private) void`	`parse(InputSource src)` Parses the `InputSource` given but delegates everything inside a tag or a processing instruction to `parseTagOrPI()`.
`void`	`parse(Reader reader)` Parses the given `InputStream`.
`(package private) void`	`parseEndTag()` Parses an end-tag notifying the underlying handler.
`(package private) void`	`parseStartOrStartEndTag()` Parses a start-tag or, for xml, an empty tag.
`private int`	`parseTagOrPI()` Parses everything within a tag, a processing instruction, ...
`private int`	`parseText()` Parses everything outside a tag, a processing instruction, ...
`boolean`	`parseXML(boolean xml)` Sets whether this parser is used as an xml-parser.
`void`	`setContentHandler(ContentHandler contentHandler)` Sets `contentHandler`.
`void`	`setExceptionHandler(ParseExceptionHandler peHandler)` Sets `parseExceptionHandler`.

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

- Field Detail
  - QUOTE_DOT
```
private static final String QUOTE_DOT
```
    See Also:
    
    Constant Field Values
  - SYMB_EQ
```
private static final char SYMB_EQ
```
    See Also:
    
    Constant Field Values
  - SYMB_COMMENT
```
private static final char SYMB_COMMENT
```
    See Also:
    
    Constant Field Values
  - SYMB_TAG
```
private static final char SYMB_TAG
```
    See Also:
    
    Constant Field Values
  - TEST_BLANK_GT_SLASH
```
private static final SGMLParser.CharTester TEST_BLANK_GT_SLASH
```
    Tests for blank, /, >.
  - TEST_BLANK_GT
```
private static final SGMLParser.CharTester TEST_BLANK_GT
```
    Tests for blank or >.
  - TEST_LT
```
private static final SGMLParser.CharTester TEST_LT
```
    Tests for <.
  - TEST_GT
```
private static final SGMLParser.CharTester TEST_GT
```
    Tests for >.
  - TEST_BLANK_EQUALS_GT
```
private static final SGMLParser.CharTester TEST_BLANK_EQUALS_GT
```
    Tests for = and for >.
  - TEST_NO_WHITESPACE
```
private static final SGMLParser.CharTester TEST_NO_WHITESPACE
```
    Tests for whitespace.
  - TEST_END_OF_COMMENT
```
private static final SGMLParser.CharTester TEST_END_OF_COMMENT
```
    Tests for quote both for' and for ".
  - TEST_SPEC
```
private static final SGMLParser.SpecCharTester TEST_SPEC
```
    Tests for a specified character. This is used for quotes which allow the cases ' and ".
    
    See Also:
    
    SGMLParser.XMLsGMLspecifica.parseAttribute(eu.simuline.util.sgml.SGMLParser.AttributesWrapper)
  - htmlAttributeParser
```
private final SGMLParser.XMLsGMLspecifica htmlAttributeParser
```
    Contains the HTML-specific part of the parser.
  - xmlAttributeParser
```
private final SGMLParser.XMLsGMLspecifica xmlAttributeParser
```
    Contains the XML-specific part of the parser.
  - BUFFER_SIZE
```
private static final int BUFFER_SIZE
```
    The size of the buffer used internally. This must be at least 1. I found no significant difference in speed when increasing this number. The buffer coming from a stream from a URL seems to hav maximal size of 1448 whereas for file streams there seems no bound. In the cases considered, the file is read in as a whole.
    
    See Also:
    
    Constant Field Values
  - START_TAG
```
private static final String START_TAG
```
    Short string representation of the object currently parsed. Contains the specific part of the message of the exception that may be thrown by SGMLParser.Buffer.readStringBuffer(eu.simuline.util.sgml.SGMLParser.CharTester, java.lang.String).
    
    See Also:
    
    Constant Field Values
  - END_TAG
```
private static final String END_TAG
```
    Short string representation of the object currently parsed. Contains the specific part of the message of the exception that may be thrown by SGMLParser.Buffer.readStringBuffer(eu.simuline.util.sgml.SGMLParser.CharTester, java.lang.String).
    
    See Also:
    
    Constant Field Values
  - PROC_INSTR
```
private static final String PROC_INSTR
```
    Short string representation of the object currently parsed. Contains the specific part of the message of the exception that may be thrown by SGMLParser.Buffer.readStringBuffer(eu.simuline.util.sgml.SGMLParser.CharTester, java.lang.String).
    
    See Also:
    
    Constant Field Values
  - ATTR_NAME
```
private static final String ATTR_NAME
```
    Short string representation of the object currently parsed. Contains the specific part of the message of the exception that may be thrown by SGMLParser.Buffer.readStringBuffer(eu.simuline.util.sgml.SGMLParser.CharTester, java.lang.String).
    
    See Also:
    
    Constant Field Values
  - WHITESP_IN_ATTR
```
private static final String WHITESP_IN_ATTR
```
    Short string representation of the object currently parsed. Contains the specific part of the message of the exception that may be thrown by SGMLParser.Buffer.readStringBuffer(eu.simuline.util.sgml.SGMLParser.CharTester, java.lang.String).
    
    See Also:
    
    Constant Field Values
  - ATTR_VALUE
```
private static final String ATTR_VALUE
```
    Short string representation of the object currently parsed. Contains the specific part of the message of the exception that may be thrown by SGMLParser.Buffer.readStringBuffer(eu.simuline.util.sgml.SGMLParser.CharTester, java.lang.String).
    
    See Also:
    
    Constant Field Values
  - xmlSgmlSpecifica
```
private SGMLParser.XMLsGMLspecifica xmlSgmlSpecifica
```
    Contains class with methods specific for xml and sgml, respectively.
  - currChar
```
private int currChar
```
    The current character or -1 to signfy the end of the stream.
  - contentHandler
```
private ContentHandler contentHandler
```
    The ContentHandler registered.
  - parseExceptionHandler
```
private ParseExceptionHandler parseExceptionHandler
```
    The ParseExceptionHandler registered.
  - buffer
```
private SGMLParser.Buffer buffer
```
    The buffer of the input stream.
- Constructor Detail
  - SGMLParser
```
public SGMLParser()
```
    Creates a new SGMLParser with the default handlers for content and exceptions.
- Method Detail
  - parse
```
void parse(InputSource src)
    throws IOException,
           SAXException
```
    Parses the InputSource given but delegates everything inside a tag or a processing instruction to parseTagOrPI().
    
    Parameters:
    
    src - an InputSource.
    
    Throws:
    
    IOException - if an error occurs
    
    SAXException - if an error occurs
  - parse
```
public void parse(Reader reader)
           throws IOException,
                  SAXException
```
    Parses the given InputStream.
    
    Parameters:
    
    reader - an Reader sequentializing an SGML document.
    
    Throws:
    
    IOException - if an error reading the stream occurs.
    
    SAXException - if an error with the sgml-syntax occurs.
  - parseText
```
private int parseText()
               throws IOException,
                      SAXException
```
    Parses everything outside a tag, a processing instruction, ... everything within brackets < and >. ***** Missing: distinction between notification of characters and whitespace. ****
    
    Throws:
    
    IOException - if an error reading the stream occurs.
    
    SAXException - if an error with the sgml-syntax occurs.
    
    See Also:
    
    parseTagOrPI()
  - parseEndTag
```
void parseEndTag()
          throws IOException,
                 SAXException
```
    Parses an end-tag notifying the underlying handler.
    
    Throws:
    
    IOException - if an error reading the stream occurs.
    
    SAXException - if an error with the sgml-syntax occurs.
  - parseStartOrStartEndTag
```
void parseStartOrStartEndTag()
                      throws IOException,
                             SAXException
```
    Parses a start-tag or, for xml, an empty tag.
    
    Throws:
    
    IOException - if an error reading the stream occurs.
    
    SAXException - if an error with the sgml-syntax occurs.
  - parseTagOrPI
```
private int parseTagOrPI()
                  throws IOException,
                         SAXException
```
    Parses everything within a tag, a processing instruction, ... everything within brackets < and >.
    
    Throws:
    
    IOException
    
    SAXException
    
    See Also:
    
    parseText()
  - setContentHandler
```
public void setContentHandler(ContentHandler contentHandler)
```
    Sets contentHandler.
    
    Parameters:
    
    contentHandler - a ContentHandler.
  - getContentHandler
```
public ContentHandler getContentHandler()
```
    Returns contentHandler.
    
    Returns:
    
    the ContentHandler contentHandler.
  - setExceptionHandler
```
public void setExceptionHandler(ParseExceptionHandler peHandler)
```
    Sets parseExceptionHandler.
    
    Parameters:
    
    peHandler - a ParseExceptionHandler.
  - getExceptionHandler
```
public ParseExceptionHandler getExceptionHandler()
```
    Returns parseExceptionHandler.
    
    Returns:
    
    the ContentHandler parseExceptionHandler.
  - parseXML
```
public boolean parseXML(boolean xml)
```
    Sets whether this parser is used as an xml-parser. If this is false, which is the default, it s an html-parser.
    
    Parameters:
    
    xml - a boolean value signifying whether this parser will be used as an xml-parser in the sequel.
    
    Returns:
    
    a boolean value signifying whether before invoking this method this parser was used as an xml-parser
  - isXMLParser
```
public boolean isXMLParser()
```

Class SGMLParser

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUOTE_DOT

SYMB_EQ

SYMB_COMMENT

SYMB_TAG

TEST_BLANK_GT_SLASH

TEST_BLANK_GT

TEST_LT

TEST_GT

TEST_BLANK_EQUALS_GT

TEST_NO_WHITESPACE

TEST_END_OF_COMMENT

TEST_SPEC

htmlAttributeParser

xmlAttributeParser

BUFFER_SIZE

START_TAG

END_TAG

PROC_INSTR

ATTR_NAME

WHITESP_IN_ATTR

ATTR_VALUE

xmlSgmlSpecifica

currChar

contentHandler

parseExceptionHandler

buffer

Constructor Detail

SGMLParser

Method Detail

parse

parse

parseText

parseEndTag

parseStartOrStartEndTag

parseTagOrPI

setContentHandler

getContentHandler

setExceptionHandler

getExceptionHandler

parseXML

isXMLParser