Class TypedXMLStreamException

All Implemented Interfaces:
Serializable

public class TypedXMLStreamException extends XMLStreamException
This class represents an exception throw by an TypedXMLStreamReader or an TypedXMLStreamWriter. It is used to indicate a problems occuring when trying convert data for access using typed read or write methods.

Note that the lexical value is a mandatory thing to pass -- since this exception subtype need not be used solely for wrapping purposes (XMLStreamExceptions are to be passed as is, other underlying root cause types should be unchecked), we can mandate a lexical value (which may be null, however) to be passed. Similarly, aside from generic stream exception, it is mandated that root causes to wrap need to be of type IllegalArgumentException, since that is the supertype of regular parsing/conversion types for primitive types.

Since:
3.0
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • mLexical

      protected String mLexical
      Lexical representation of the content that could not be converted to the requested type. May be null if a processor is unable to provide it. Lexical representation should preferably be as close to the original input String as possible (as opposed to being normalized which often is done before actual parsing).
  • Constructor Details

    • TypedXMLStreamException

      public TypedXMLStreamException(String lexical, String msg)
      Construct an exception with the associated message.
      Parameters:
      msg - The message to report.
    • TypedXMLStreamException

      public TypedXMLStreamException(String lexical, IllegalArgumentException rootCause)
      Constructor used to wrap an underlying data conversion error message.
      Parameters:
      rootCause - Underlying conversion problem
    • TypedXMLStreamException

      public TypedXMLStreamException(String lexical, String msg, IllegalArgumentException rootCause)
      Construct an exception with the associated message and exception
      Parameters:
      msg - The message to report.
      rootCause - Underlying conversion problem
    • TypedXMLStreamException

      public TypedXMLStreamException(String lexical, String msg, Location location, IllegalArgumentException rootCause)
      Construct an exception with the associated message, exception and location.
      Parameters:
      msg - The message to report.
      location - The location of the error.
      rootCause - Underlying conversion problem
    • TypedXMLStreamException

      public TypedXMLStreamException(String lexical, String msg, Location location)
      Construct an exception with the associated message, exception and location.
      Parameters:
      msg - The message to report.
      location - The location of the error.
  • Method Details

    • getLexical

      public String getLexical()
      Return the lexical representation of the attribute or element content that could not be converted as requested.
      Returns:
      Lexical representation of unconverted content or null if unavailable.