com.inductiveautomation.ignition.common.modules

Class ModuleInfoParser

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.inductiveautomation.ignition.common.modules.ModuleInfoParser

All Implemented Interfaces:

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

public class ModuleInfoParser
extends org.xml.sax.helpers.DefaultHandler

This class parses the module descriptor file.

Constructor Summary

Constructors

Constructor and Description
ModuleInfoParser()

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String name)
static ModuleInfo	fromXML(java.io.InputStream is) Parses the given XML file, returning the ModuleInfo object represented within.
ModuleInfo	getModule()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes attributes)

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

ModuleInfoParser

public ModuleInfoParser()

Method Detail

getModule

public ModuleInfo getModule()

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String name)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String name,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

fromXML

public static ModuleInfo fromXML(java.io.InputStream is)
                          throws org.xml.sax.SAXException,
                                 java.io.IOException

Parses the given XML file, returning the ModuleInfo object represented within.

Parameters:

is - InputStream to read from.

Returns:

a ModuleInfo parsed from the XML InputStream.

Throws:

org.xml.sax.SAXException

java.io.IOException