com.opmath.util.dmldoc
Class DMLDocBuildException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.opmath.util.dmldoc.DMLDocBuildException

All Implemented Interfaces:

Serializable

public class DMLDocBuildException

extends Exception

Thrown when DMLDoc is unable to build a Document Object Model for a given SGML template.

DMLDocBuildException is used to to identify exceptions raised during the process of constructing a DMLDoc instance - for the most part, this means during the parsing of the SGML sources.

Exceptions of this type are always unrecoverable - the owner of the DMLDoc instance should not try to use the instance in any way following the exception.

Copyright: (c) 2002 The Open Math Company Limited

The Terms of Distribution of this software are stipulated in the javadoc Overview for this project.

Since:

J2SE 1.3

Version:

DMLDoc v2.0

Author:

Bruno Beloff bruno.beloff@opmath.com

See Also:

DMLDoc, Serialized Form

Constructor Summary

DMLDocBuildException()
Constructs a new DMLDocBuildException with no descriptive message, no source line number and no source code text.

DMLDocBuildException(String s)
Constructs a new DMLDocBuildException with no source line number and no source code text.

DMLDocBuildException(String s, int n, String t)
Constructs a new DMLDocBuildException.

Method Summary

String

getMessage() Returns a new formatted String containing all the information provided when this DMLDocBuildException instance was created.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DMLDocBuildException

public DMLDocBuildException()

Constructs a new DMLDocBuildException with no descriptive message, no source line number and no source code text.

NOTE: This constructor is provided for completeness, but is never used by any com.opmath.util.dmldoc method.

Since:

J2SE 1.3

DMLDocBuildException

public DMLDocBuildException(String s)

Constructs a new DMLDocBuildException with no source line number and no source code text. A descriptive message is provided.

This constructor is used by the com.opmath.util.dmldoc methods where an exceptional circumstance has arisen, but this cannot be associated with a specific SGML source code line.

Parameters:

s - the String carrying the descriptive message.

Since:

J2SE 1.3

DMLDocBuildException

public DMLDocBuildException(String s,
                            int n,
                            String t)

Constructs a new DMLDocBuildException. A descriptive message, together with source code line and line number is provided.

This constructor is used by the com.opmath.util.dmldoc methods where an exceptional circumstance has arisen during the parsing of an SGML source code line.

Parameters:

s - the String carrying the descriptive message.

n - the int carrying the line number.

t - the String carrying the line text.

Since:

J2SE 1.3

Method Detail

getMessage

public String getMessage()

Returns a new formatted String containing all the information provided when this DMLDocBuildException instance was created.

Overrides:

getMessage in class Throwable

Returns:

a String.

Since:

J2SE 1.3