JAXB OSGI 4.0.9 · com.sun.xml.xsom.parser.XSOMParser

Modifier and Type	Field and Description
private AnnotationParserFactory	apFactory
private final ParserContext	context
private EntityResolver	entityResolver
private ErrorHandler	userErrorHandler

Access	Constructor and Description
public	XSOMParser(SAXParserFactory factory) Creates a new XSOMParser that uses the given SAXParserFactory for creating new SAX parsers.
public	XSOMParser(XMLParser This parser will be called to parse XML Schema documents. parser) Creates a new XSOMParser that reads XML Schema from non-standard inputs.

Method Summary

Modifier and Type	Method and Description
public AnnotationParserFactory	getAnnotationParserFactory()
public Set<SchemaDocument>	Returns: can be empty but never null. getDocuments() Gets the set of `SchemaDocument` that represents parsed documents so far.
public EntityResolver	getEntityResolver()
public ErrorHandler	getErrorHandler()
public ContentHandler	getParserHandler() Gets the parser implemented as a ContentHandler.
public XSSchemaSet	Returns: If there was any parse error, this method returns null. To receive error information, specify your error handler through the setErrorHandler method. getResult() Gets the parsed result.
public void	parse(InputStream is) Parses a new XML Schema document.
public void	parse(Reader reader) Parses a new XML Schema document.
public void	parse(File schema) Parses a new XML Schema document.
public void	parse(URL url) Parses a new XML Schema document.
public void	parse(String systemId) Parses a new XML Schema document.
public void	parse(InputSource source) Parses a new XML Schema document.
public void	setAnnotationParser(final Class<? extends AnnotationParser> annParser) Sets the annotation parser.
public void	setAnnotationParser(AnnotationParserFactory factory) Sets the annotation parser factory.
public void	setEntityResolver(EntityResolver resolver) Set an entity resolver that is used to resolve things like `<xsd:import>` and `<xsd:include>`.
public void	setErrorHandler(ErrorHandler errorHandler) Set an error handler that receives all the errors encountered during the parsing.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

apFactory	back to summary
private AnnotationParserFactory apFactory

context	back to summary
private final ParserContext context

entityResolver	back to summary
private EntityResolver entityResolver

userErrorHandler	back to summary
private ErrorHandler userErrorHandler

Constructor Detail

XSOMParser back to summary

XSOMParser	back to summary
public XSOMParser(SAXParserFactory factory) Creates a new XSOMParser that uses the given SAXParserFactory for creating new SAX parsers. The caller needs to configure it properly with security features initialized by setting XMLConstants.FEATURE_SECURE_PROCESSING feature. Also don't forget to call `setNamespaceAware(true)` or you'll see some strange errors.

public XSOMParser(SAXParserFactory factory)

Creates a new XSOMParser that uses the given SAXParserFactory for creating new SAX parsers.

The caller needs to configure it properly with security features initialized by setting XMLConstants.FEATURE_SECURE_PROCESSING feature. Also don't forget to call setNamespaceAware(true) or you'll see some strange errors.

XSOMParser back to summary

XSOMParser	back to summary
public XSOMParser(XMLParser parser) Creates a new XSOMParser that reads XML Schema from non-standard inputs. By implementing the `XMLParser` interface, XML Schema can be read from something other than XML. Parameters parser:XMLParser This parser will be called to parse XML Schema documents.

public XSOMParser(XMLParser parser)

Creates a new XSOMParser that reads XML Schema from non-standard inputs.

By implementing the XMLParser interface, XML Schema can be read from something other than XML.

Parameters

parser:XMLParser: This parser will be called to parse XML Schema documents.

Method Detail

getAnnotationParserFactory	back to summary
public AnnotationParserFactory getAnnotationParserFactory()

getDocuments back to summary

getDocuments	back to summary
public Set<SchemaDocument> getDocuments() Gets the set of `SchemaDocument` that represents parsed documents so far. Returns:Set<SchemaDocument> can be empty but never null.

public Set<SchemaDocument> getDocuments()

Gets the set of SchemaDocument that represents parsed documents so far.

Returns:Set<SchemaDocument>: can be empty but never null.

getEntityResolver	back to summary
public EntityResolver getEntityResolver()

getErrorHandler	back to summary
public ErrorHandler getErrorHandler()

getParserHandler	back to summary
public ContentHandler getParserHandler() Gets the parser implemented as a ContentHandler. One can feed XML Schema as SAX events to this interface to parse a schema. To parse multiple schema files, feed multiple sets of events. If you don't send a complete event sequence from a startDocument event to an endDocument event, the state of XSOMParser can become unstable. This sometimes happen when you encounter an error while generating SAX events. Don't call the getResult method in that case. This way of reading XML Schema can be useful when XML Schema is not available as a stand-alone XML document. For example, one can feed XML Schema inside a WSDL document.

getParserHandler

back to summary

public ContentHandler getParserHandler()

Gets the parser implemented as a ContentHandler.

One can feed XML Schema as SAX events to this interface to parse a schema. To parse multiple schema files, feed multiple sets of events.

If you don't send a complete event sequence from a startDocument event to an endDocument event, the state of XSOMParser can become unstable. This sometimes happen when you encounter an error while generating SAX events. Don't call the getResult method in that case.

This way of reading XML Schema can be useful when XML Schema is not available as a stand-alone XML document. For example, one can feed XML Schema inside a WSDL document.

getResult	back to summary
public XSSchemaSet getResult() throws SAXException Gets the parsed result. Don't call this method until you parse all the schemas. Returns:XSSchemaSet If there was any parse error, this method returns null. To receive error information, specify your error handler through the setErrorHandler method. Exceptions SAXException: This exception will never be thrown unless it is thrown by an error handler.

getResult

back to summary

public XSSchemaSet getResult() throws SAXException

Gets the parsed result. Don't call this method until you parse all the schemas.

Returns:XSSchemaSet

If there was any parse error, this method returns null. To receive error information, specify your error handler through the setErrorHandler method.

Exceptions

SAXException:: This exception will never be thrown unless it is thrown by an error handler.

parse back to summary

parse	back to summary
public void parse(InputStream is) throws SAXException Parses a new XML Schema document. When using this method, XSOM does not know the system ID of this document, therefore, when this stream contains relative references to other schemas, XSOM will fail to resolve them. To specify an system ID with a stream, use `InputSource`

public void parse(InputStream is) throws SAXException

Parses a new XML Schema document.

When using this method, XSOM does not know the system ID of this document, therefore, when this stream contains relative references to other schemas, XSOM will fail to resolve them. To specify an system ID with a stream, use InputSource

parse back to summary

parse	back to summary
public void parse(Reader reader) throws SAXException Parses a new XML Schema document. When using this method, XSOM does not know the system ID of this document, therefore, when this reader contains relative references to other schemas, XSOM will fail to resolve them. To specify an system ID with a reader, use `InputSource`

public void parse(Reader reader) throws SAXException

Parses a new XML Schema document.

When using this method, XSOM does not know the system ID of this document, therefore, when this reader contains relative references to other schemas, XSOM will fail to resolve them. To specify an system ID with a reader, use InputSource

parse	back to summary
public void parse(File schema) throws SAXException, IOException Parses a new XML Schema document.

parse	back to summary
public void parse(URL url) throws SAXException Parses a new XML Schema document.

parse	back to summary
public void parse(String systemId) throws SAXException Parses a new XML Schema document.

parse back to summary

parse	back to summary
public void parse(InputSource source) throws SAXException Parses a new XML Schema document. Note that if the `InputSource` does not have a system ID, XSOM will fail to resolve them.

public void parse(InputSource source) throws SAXException

Parses a new XML Schema document.

Note that if the InputSource does not have a system ID, XSOM will fail to resolve them.

setAnnotationParser back to summary

setAnnotationParser	back to summary
public void setAnnotationParser(final Class<? extends AnnotationParser> annParser) Sets the annotation parser. Annotation parser can be used to parse application-specific annotations inside a schema. For each annotation, new instance of this class will be created and used to parse `<xs:annotation>`.

public void setAnnotationParser(final Class<? extends AnnotationParser> annParser)

Sets the annotation parser.

Annotation parser can be used to parse application-specific annotations inside a schema.

For each annotation, new instance of this class will be created and used to parse <xs:annotation>.

setAnnotationParser	back to summary
public void setAnnotationParser(AnnotationParserFactory factory) Sets the annotation parser factory. The specified factory will be used to create AnnotationParsers.

setAnnotationParser

back to summary

public void setAnnotationParser(AnnotationParserFactory factory)

Sets the annotation parser factory.

The specified factory will be used to create AnnotationParsers.

setEntityResolver	back to summary
public void setEntityResolver(EntityResolver resolver) Set an entity resolver that is used to resolve things like `<xsd:import>` and `<xsd:include>`.

setErrorHandler	back to summary
public void setErrorHandler(ErrorHandler errorHandler) Set an error handler that receives all the errors encountered during the parsing.

public final Class XSOMParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail