com.sun.tools.internal.xjc.reader.xmlschema.parser: public class: IncorrectNamespaceURIChecker

com.sun.tools.internal.xjc.reader.xmlschema.parser
public class: IncorrectNamespaceURIChecker [javadoc | source]

java.lang.Object
   org.xml.sax.helpers.XMLFilterImpl
      com.sun.tools.internal.xjc.reader.xmlschema.parser.IncorrectNamespaceURIChecker

All Implemented Interfaces:
ContentHandler, DTDHandler, ErrorHandler, XMLFilter, EntityResolver

This filter detects the use of incorrect JAXB namespace URI. When the binding compiler looks at a schema file, it always look for the namespace URI of the elements (which is correct, BTW.)

However, one unfortunate downside of this philosophically correct behavior is that there is no provision or safety check when an user misspelled JAXB binding customization namespace.

This checker inspects the input document and look for the use of the prefix "jaxb". If the document doesn't associate any prefix to the JAXB customization URI and if it does associate the jaxb prefix, this checker will issue a warning.

This warning can happen to completely correct schema (because nothing prevents you from using the prefix "jaxb" for other purpose while using a JAXB compiler on the same schema) but in practice this would be quite unlikely.

This justifies the use of this filter.

author: Kohsuke - Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor:
public IncorrectNamespaceURIChecker(ErrorHandler handler) { this.errorHandler = handler; }

Method from com.sun.tools.internal.xjc.reader.xmlschema.parser.IncorrectNamespaceURIChecker Summary:
endDocument, setDocumentLocator, startElement, startPrefixMapping

Methods from org.xml.sax.helpers.XMLFilterImpl:
characters, endDocument, endElement, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, notationDecl, parse, parse, processingInstruction, resolveEntity, setContentHandler, setDTDHandler, setDocumentLocator, setEntityResolver, setErrorHandler, setFeature, setParent, setProperty, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods from org.xml.sax.helpers.XMLFilterImpl:

characters, endDocument, endElement, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, notationDecl, parse, parse, processingInstruction, resolveEntity, setContentHandler, setDTDHandler, setDocumentLocator, setEntityResolver, setErrorHandler, setFeature, setParent, setProperty, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.sun.tools.internal.xjc.reader.xmlschema.parser.IncorrectNamespaceURIChecker Detail:
public void endDocument() throws SAXException { if( isJAXBPrefixUsed && !isCustomizationUsed ) { SAXParseException e = new SAXParseException( Messages.format(Messages.WARN_INCORRECT_URI, Const.JAXB_NSURI), locator ); errorHandler.warning(e); } super.endDocument(); }
public void setDocumentLocator(Locator locator) { super.setDocumentLocator( locator ); this.locator = locator; }
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException { super.startElement(namespaceURI, localName, qName, atts); // I'm not sure if this is necessary (SAX might report the change of the default prefix // through the startPrefixMapping method, and I think it does indeed.) // // but better safe than sorry. if( namespaceURI.equals(Const.JAXB_NSURI) ) isCustomizationUsed = true; }
public void startPrefixMapping(String prefix, String uri) throws SAXException { if( prefix.equals("jaxb") ) isJAXBPrefixUsed = true; if( uri.equals(Const.JAXB_NSURI) ) isCustomizationUsed = true; super.startPrefixMapping(prefix, uri); }