Class CompletionXMLParser

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.fife.ui.autocomplete.CompletionXMLParser

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class CompletionXMLParser
extends DefaultHandler

Parser for an XML file describing a procedural language such as C. XML files will be validated against the CompletionXml.dtd DTD found in this package.

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private ClassLoader	completionCL	The completion provider to use when loading classes, such as custom FunctionCompletions.
private List<Completion>	completions	The completions found after parsing the XML.
private static ClassLoader	defaultCompletionClassLoader	The class loader to use to load custom completion classes, such as the one defined by funcCompletionType.
private String	definedIn
private StringBuilder	desc
private boolean	doingKeywords
private boolean	endParam
private String	funcCompletionType	If specified in the XML, this class will be used instead of FunctionCompletion when appropriate.
private boolean	gettingDesc
private boolean	gettingParamDesc
private boolean	gettingParams
private boolean	gettingReturnValDesc
private boolean	inCompletionTypes
private boolean	inKeyword
private boolean	inParam
private String	name
private StringBuilder	paramDesc
private char	paramEndChar
private String	paramName
private List<ParameterizedCompletion.Parameter>	params
private String	paramSeparator
private char	paramStartChar
private String	paramType
private CompletionProvider	provider	The provider we're getting completions for.
private String	returnType
private StringBuilder	returnValDesc
private String	type

Constructor Summary

Constructors

Constructor	Description
CompletionXMLParser(CompletionProvider provider)	Constructor.
CompletionXMLParser(CompletionProvider provider, ClassLoader cl)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Called when character data inside an element is found.
private FunctionCompletion	createFunctionCompletion()
private MarkupTagCompletion	createMarkupTagCompletion()
private BasicCompletion	createOtherCompletion()
private VariableCompletion	createVariableCompletion()
void	endElement(String uri, String localName, String qName)	Called when an element is closed.
void	error(SAXParseException e)
List<Completion>	getCompletions()	Returns the completions found after parsing the XML.
char	getParamEndChar()	Returns the parameter end character specified.
String	getParamSeparator()	Returns the parameter end string specified.
char	getParamStartChar()	Returns the parameter start character specified.
private static char	getSingleChar(String str)
void	reset(CompletionProvider provider)	Resets this parser to grab more completions.
InputSource	resolveEntity(String publicID, String systemID)
static void	setDefaultCompletionClassLoader(ClassLoader cl)	Sets the class loader to use when loading custom classes to use for various Completion types, such as FunctionCompletions, from XML.
void	startElement(String uri, String localName, String qName, Attributes attrs)	Called when an element starts.
void	warning(SAXParseException e)

Methods inherited from class DefaultHandler

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

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

completions

private List<Completion> completions

The completions found after parsing the XML.

provider

private CompletionProvider provider

The provider we're getting completions for.

completionCL

private ClassLoader completionCL

The completion provider to use when loading classes, such as custom FunctionCompletions.

name

private String name

type

private String type

returnType

private String returnType

returnValDesc

private StringBuilder returnValDesc

desc

private StringBuilder desc

paramName

private String paramName

paramType

private String paramType

endParam

private boolean endParam

paramDesc

private StringBuilder paramDesc

params

private List<ParameterizedCompletion.Parameter> params

definedIn

private String definedIn

doingKeywords

private boolean doingKeywords

inKeyword

private boolean inKeyword

gettingReturnValDesc

private boolean gettingReturnValDesc

gettingDesc

private boolean gettingDesc

gettingParams

private boolean gettingParams

inParam

private boolean inParam

gettingParamDesc

private boolean gettingParamDesc

inCompletionTypes

private boolean inCompletionTypes

paramStartChar

private char paramStartChar

paramEndChar

private char paramEndChar

paramSeparator

private String paramSeparator

funcCompletionType

private String funcCompletionType

If specified in the XML, this class will be used instead of FunctionCompletion when appropriate. This class should extend FunctionCompletion, or stuff will break.

defaultCompletionClassLoader

private static ClassLoader defaultCompletionClassLoader

The class loader to use to load custom completion classes, such as the one defined by funcCompletionType. If this is null, then a default class loader is used. This field will usually be null.

Constructor Details

CompletionXMLParser

public CompletionXMLParser(CompletionProvider provider)

Constructor.

Parameters:

provider - The provider to get completions for.

See Also:

• reset(CompletionProvider)

CompletionXMLParser

public CompletionXMLParser(CompletionProvider provider,
 ClassLoader cl)

Constructor.

Parameters:

provider - The provider to get completions for.

cl - The class loader to use, if necessary, when loading classes from the XML (custom FunctionCompletions, for example). This may be null if the default is to be used, or if the XML does not define specific classes for completion types.

See Also:

• reset(CompletionProvider)

Method Details

characters

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

Called when character data inside an element is found.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

createFunctionCompletion

private FunctionCompletion createFunctionCompletion()

createOtherCompletion

private BasicCompletion createOtherCompletion()

createMarkupTagCompletion

private MarkupTagCompletion createMarkupTagCompletion()

createVariableCompletion

private VariableCompletion createVariableCompletion()

endElement

public void endElement(String uri,
 String localName,
 String qName)

Called when an element is closed.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

error

public void error(SAXParseException e)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

getCompletions

public List<Completion> 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 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.

getSingleChar

private static char getSingleChar(String str)

reset

public void reset(CompletionProvider provider)

Resets this parser to grab more completions.

Parameters:

provider - The new provider to get completions for.

resolveEntity

public InputSource resolveEntity(String publicID,
 String systemID)

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

setDefaultCompletionClassLoader

public static void setDefaultCompletionClassLoader(ClassLoader cl)

Sets the class loader to use when loading custom classes to use for various Completion types, such as FunctionCompletions, from XML.

Users should very rarely have a need to use this method.

Parameters:

cl - The class loader to use. If this is null, then a default is used.

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attrs)

Called when an element starts.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

warning

public void warning(SAXParseException e)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException