Module com.sun.xml.bind.osgi

Package com.sun.xml.xsom.parser

Class AnnotationParser

java.lang.Object

com.sun.xml.xsom.parser.AnnotationParser

public abstract class AnnotationParser
extends Object

Used to parse <xs:annotation>.

Author:

Kohsuke Kawaguchi ([email protected])

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AnnotationParser()	Default constructor.

Method Summary

Modifier and Type	Method	Description
abstract ContentHandler	getContentHandler(AnnotationContext context, String parentElementName, ErrorHandler errorHandler, EntityResolver entityResolver)	Called every time a new <xs:annotation> element is found.
abstract Object	getResult(Object existing)	Once the SAX events are fed to the ContentHandler, this method will be called to retrieve the parsed result.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationParser

protected AnnotationParser()

Default constructor.

Method Detail

getContentHandler

public abstract ContentHandler getContentHandler(AnnotationContext context,
                                                 String parentElementName,
                                                 ErrorHandler errorHandler,
                                                 EntityResolver entityResolver)

Called every time a new <xs:annotation> element is found. The sub-tree rooted at <xs:annotation> will be sent to this ContentHandler as if it is a whole document.

Parameters:

context - indicates the schema component that owns this annotation. Always non-null.

parentElementName - local name of the element that contains <xs:annotation>. (e.g., "element", "attribute", ... )

errorHandler - The error handler that the client application specifies. The returned content handler can send its errors to this object.

entityResolver - The entity resolver that is currently in use. Again, The returned content handler can use this object if it needs to resolve entities.

getResult

public abstract Object getResult(Object existing)

Once the SAX events are fed to the ContentHandler, this method will be called to retrieve the parsed result.

Parameters:

existing - An annotation object which was returned from another AnnotationParser before. Sometimes, one schema component can have multiple <xs:annotation> elements and this parameter is used to merge all those annotations together. If there is no existing object, null will be passed.

Returns:

Any object, including null.