com.sun.msv.verifier.ErrorInfo Maven / Gradle / Ivy
/*
* Copyright (c) 2001-2013 Oracle and/or its affiliates. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of Oracle nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.sun.msv.verifier;
import com.sun.msv.util.StartTagInfo;
/**
* Instances of this class is attached to {@link ValidityViolation} to
* provide detailed information about the error.
*
*
* WARNING: error information is highly sensitive to the internal
* change of MSV. A new subclass of ErrorInfo may be added, or
* existing subclasses may be removed.
* So your code that uses this information may be affected by
* future changes of MSV.
*
* @author Kohsuke KAWAGUCHI
*/
public abstract class ErrorInfo {
/** Base class for element related errors. */
public static abstract class ElementErrorInfo extends ErrorInfo {
/** tag name information. */
public final String qName;
public final String namespaceURI;
public final String localName;
public ElementErrorInfo( String qn, String ns, String loc ) {
qName = qn;
namespaceURI = ns;
localName = loc;
}
public ElementErrorInfo( StartTagInfo sti ) {
this( sti.qName, sti.namespaceURI, sti.localName );
}
}
/**
* Bad text.
*
*
* This type of errors indicate that the document contains PCDATA but it
* is not good. Here are typical examples of this error.
*
*
-
* PCDATA appears where no text is allowed at all. For example:
*
*
* <html>
* <head> ... </head>
* ** invalid text **
* <body> ... </body>
* </html>
*
*
* -
* text was not a correct value for the given datatype. For example,
*
*
* <!-- when "integer" is expected -->
* <length> five </length>
*
*
*
*
*
* Usually, the user can fix this error by removing or chaning the text.
*
*
* MSV validates text after it collects the whole string. That means
* MSV does not validate text in the SAX's characters callback.
* As a result, this error is reported after
* the next start tag or end tag is found.
*
*
* For example, in the above example, the error is reported when MSV
* reads <body>(start tag) and
* </length> (end tag) respectively.
*/
public static class BadText extends ErrorInfo {
/** The actual text that caused the error. */
public final String literal;
public BadText( String _literal ) { literal = _literal; }
public BadText( StringBuffer _literal ) { literal = _literal.toString(); }
}
/**
* Bad tag name.
*
*
* This type of error occurs when MSV finds an unexpected tag name.
* For example:
*
*
-
* When a tag name appears where it is not valid to appear.
*
* <html>
* <head> ... </head>
* <head> ... </head> <!-- head cannot appear here -->
* <body> ... </body>
* </html>
* </pre>
*
*
-
* When there is a typo in the tag name.
*
* <html>
* <heed> ... </heed> <!-- typo -->
* <body> ... </body>
* </pre>
*
*
-
* When an element appears where no element is allowed at all.
*
* <html>
* <head>
* <meta ...>
* <junk/> <!-- meta cannot have any children -->
*
*
*
*
*
* This error is reported when the startElement callback is called.
*/
public static class BadTagName extends ElementErrorInfo {
public BadTagName( String qn, String ns, String loc ) { super(qn,ns,loc); }
public BadTagName( StartTagInfo sti ) { super(sti); }
}
/**
* Bad attribute.
*
*
* This is an error when the attribute name is wrong, or the attribute value
* is wrong. For example:
*
*
-
* When MSV sees an unexpected attribute name:
*
* <img hreeef="logo.gif"/>
*
*
*
-
* When an attribute value does not match the specified datatype.
* For example, the following document causes this error if the "width"
* attribute is specified as the int type.
*
*
* <img href="logo.gif" width="twenty four pixels" />
*
*
*
*
*
* This error is reported in the startElement callback.
*
*
* Currently, the application cannot easily distinguish whether
* this error is caused by an invalid attribute value, or invalid
* attribute name. It is also non-trivial for MSV to detect this difference
* correctly. But there maybe applications to which this difference is
* important.
* I welcome any comments on this issue.
*
*/
public static class BadAttribute extends ElementErrorInfo {
/** information about the attribute that caused the error. */
public final String attQName;
public final String attNamespaceURI;
public final String attLocalName;
public final String attValue;
protected BadAttribute( StartTagInfo sti, String qn, String ns, String loc, String v ) {
super(sti);
attQName = qn;
attNamespaceURI = ns;
attLocalName = loc;
attValue = v;
}
}
/**
* Missing attribute.
*
*
* This type of error occurs only when required attributes are missing.
* Note that the fields of this class provide information about the element,
* not the attribute which is missing.
*
*
* <img/> <!-- where is the href attribute? -->
*
*/
public static class MissingAttribute extends ElementErrorInfo {
public MissingAttribute( String qn, String ns, String loc ) { super(qn,ns,loc); }
public MissingAttribute( StartTagInfo sti ) { super(sti); }
}
/**
* This error occurs when MSV sees an end tag unexpectedly. For example:
*
*
* <html>
* <head> ... </head>
* </html> <!-- where is the body element? -->
*
*
*
* Usually, this means that additional elements and/or PCDATA are necessary
* to make the document valid.
*
*
* Fields of the class provide information about enclosing tag. (In case of
* the above example, it is html.)
*/
public static class IncompleteContentModel extends ElementErrorInfo {
public IncompleteContentModel( String qn, String ns, String loc ) { super(qn,ns,loc); }
public IncompleteContentModel( StartTagInfo sti ) { super(sti); }
}
}