org.fife.ui.autocomplete
Class CompletionXMLParser

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.fife.ui.autocomplete.CompletionXMLParser

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class CompletionXMLParser

extends org.xml.sax.helpers.DefaultHandler

Parser for an XML file describing a procedural language such as C.

Version:

1.0

Author:

Robert Futrell

Constructor Summary

CompletionXMLParser(CompletionProvider provider)
Constructor.

Method Summary

void	characters(char[] ch, int start, int length) Called when character data inside an element is found.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Called when an element is closed.
java.util.List	getCompletions() Returns the completions found after parsing the XML.
char	getParamEndChar() Returns the parameter end character specified.
java.lang.String	getParamSeparator() Returns the parameter end string specified.
char	getParamStartChar() Returns the parameter start character specified.
void	reset(CompletionProvider provider) Resets this parser to grab more completions.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attrs) Called when an element starts.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompletionXMLParser

public CompletionXMLParser(CompletionProvider provider)

Constructor.

Parameters:

provider - The provider to get completions for.

See Also:

reset(CompletionProvider)

Method Detail

characters

public void characters(char[] ch,
                       int start,
                       int length)

Called when character data inside an element is found.

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)

Called when an element is closed.

getCompletions

public java.util.List getCompletions()

Returns the completions found after parsing the XML.

Returns:

The completions.

getParamEndChar

public char getParamEndChar()

Returns the parameter end character specified.

Returns:

The character, or 0 if none was specified.

getParamSeparator

public java.lang.String getParamSeparator()

Returns the parameter end string specified.

Returns:

The string, or null if none was specified.

getParamStartChar

public char getParamStartChar()

Returns the parameter start character specified.

Returns:

The character, or 0 if none was specified.

reset

public void reset(CompletionProvider provider)

Resets this parser to grab more completions.

Parameters:

provider - The new provider to get completions for.

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attrs)

Called when an element starts.