to.etc.syntaxer

Class XModeHandler

java.lang.Object

to.etc.syntaxer.HandlerBase

to.etc.syntaxer.XModeHandler

All Implemented Interfaces:

XmlHandler

public abstract class XModeHandler
extends HandlerBase

XML handler for mode definition files.

Constructor Summary

Constructors

Constructor and Description
XModeHandler(String modeName)

Method Summary

Modifier and Type	Method and Description
void	attribute(String aname, String value, boolean isSpecified) Handle an attribute assignment.
void	charData(char[] c, int off, int len) Handle character data.
void	doctypeDecl(String name, String publicId, String systemId) Handle a document type declaration.
void	endDocument() Handle the end of the document.
void	endElement(String name) Handle the end of an element.
protected abstract void	error(String msg, Object subst) Reports an error.
Hashtable	getModeProperties()
TokenMarker	getTokenMarker()
protected abstract TokenMarker	getTokenMarker(String mode) Returns the token marker for the given mode.
Object	resolveEntity(String publicId, String systemId) Resolve an external entity.
void	startDocument() Handle the start of the document.
void	startElement(String tag) Handle the start of an element.

Methods inherited from class to.etc.syntaxer.HandlerBase

endExternalEntity, error, ignorableWhitespace, processingInstruction, startExternalEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

XModeHandler

public XModeHandler(String modeName)

Method Detail

resolveEntity

public Object resolveEntity(String publicId,
                            String systemId)

Description copied from class: HandlerBase

Resolve an external entity.

The default implementation simply returns the supplied system identifier.

Specified by:

resolveEntity in interface XmlHandler

Overrides:

resolveEntity in class HandlerBase

Parameters:

publicId - The public identifier, or null if none was supplied.

systemId - The system identifier.

Returns:

The replacement system identifier, or null to use the default.

See Also:

com.microstar.xml.XmlHandler#resolveEntity

attribute

public void attribute(String aname,
                      String value,
                      boolean isSpecified)

Description copied from class: HandlerBase

Handle an attribute assignment.

The default implementation does nothing.

Specified by:

attribute in interface XmlHandler

Overrides:

attribute in class HandlerBase

value - The value of the attribute, or null if the attribute is #IMPLIED.

isSpecified - True if the value was specified, false if it was defaulted from the DTD.

See Also:

com.microstar.xml.XmlHandler#attribute

doctypeDecl

public void doctypeDecl(String name,
                        String publicId,
                        String systemId)
                 throws Exception

Description copied from class: HandlerBase

Handle a document type declaration.

The default implementation does nothing.

Specified by:

doctypeDecl in interface XmlHandler

Overrides:

doctypeDecl in class HandlerBase

Parameters:

name - The document type name.

publicId - The public identifier, or null if unspecified.

systemId - The system identifier, or null if unspecified.

Throws:

Exception - The handler may throw any exception.

See Also:

com.microstar.xml.XmlHandler#doctypeDecl

charData

public void charData(char[] c,
                     int off,
                     int len)

Description copied from class: HandlerBase

Handle character data.

The default implementation does nothing.

Specified by:

charData in interface XmlHandler

Overrides:

charData in class HandlerBase

Parameters:

c - The character data.

off - The starting position in the array.

len - The number of characters available.

See Also:

com.microstar.xml.XmlHandler#charData

startElement

public void startElement(String tag)

Description copied from class: HandlerBase

Handle the start of an element.

The default implementation does nothing.

Specified by:

startElement in interface XmlHandler

Overrides:

startElement in class HandlerBase

Parameters:

tag - The element type name.

See Also:

com.microstar.xml.XmlHandler#startElement

endElement

public void endElement(String name)

Description copied from class: HandlerBase

Handle the end of an element.

The default implementation does nothing.

Specified by:

endElement in interface XmlHandler

Overrides:

endElement in class HandlerBase

Parameters:

name - The element type name.

See Also:

com.microstar.xml.XmlHandler#endElement

startDocument

public void startDocument()

Description copied from class: HandlerBase

Handle the start of the document.

The default implementation does nothing.

Specified by:

startDocument in interface XmlHandler

Overrides:

startDocument in class HandlerBase

See Also:

com.microstar.xml.XmlHandler#startDocument

endDocument

public void endDocument()

Description copied from class: HandlerBase

Handle the end of the document.

The default implementation does nothing.

Specified by:

endDocument in interface XmlHandler

Overrides:

endDocument in class HandlerBase

See Also:

com.microstar.xml.XmlHandler#endDocument

getTokenMarker

public TokenMarker getTokenMarker()

getModeProperties

public Hashtable getModeProperties()

error

protected abstract void error(String msg,
                              Object subst)

Reports an error. You must override this method so that the mode loader can do error reporting.

Parameters:

msg - The error type

subst - A String or a Throwable containing specific information

Since:

jEdit 4.2pre1

getTokenMarker

protected abstract TokenMarker getTokenMarker(String mode)

Returns the token marker for the given mode. You must override this method so that the mode loader can resolve delegate targets.

Parameters:

mode - The mode name

Since:

jEdit 4.2pre1