com.ibm.etools.pd.widget.viewer
Class DataInputProcessingException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.etools.pd.widget.viewer.DataInputProcessingException
All Implemented Interfaces:
java.io.Serializable

public class DataInputProcessingException
extends java.lang.Exception

Signals that the XML data cannot be processed by the consuming widget. This exception will be raised when the widget request to retrieve the required data from the XML Document object fails. An error code is provided for, along with the tag name of the problem XML element and the widget type consuming the data.

See Also:
IDataInputProcessingExceptionCodes, IGraphicDocumentGenerator, Serialized Form

Constructor Summary
DataInputProcessingException()
          Default constructor.
DataInputProcessingException(int error, java.lang.String element)
          Constructs a DataInputProcessingException with the specified error code and the data element tag name.
DataInputProcessingException(java.lang.String msg, int error, java.lang.String element)
          Constructs a DataInputProcessingException with the specified detail message, the error code and the data element tag name.
DataInputProcessingException(java.lang.String msg, int error, java.lang.String element, java.lang.String type)
          Constructs a DataInputProcessingException with the specified detail message, the error code, the data element tag name and the widget type.
DataInputProcessingException(java.lang.String msg, java.lang.String element)
          Constructs a DataInputProcessingException with the specified detail message.
 
Method Summary
 java.lang.String getElement()
          Returns the element which was passed as constructor parameter.
 int getErrorCode()
          Returns the error code which was passed as constructor parameter.
 java.lang.String getWidgetType()
          Returns the graphic type which was passed as constructor parameter.
 void setWidgetType(java.lang.String type)
          Sets the graphic type produced by the object throwing the exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataInputProcessingException

public DataInputProcessingException()
Default constructor.


DataInputProcessingException

public DataInputProcessingException(java.lang.String msg,
                                    java.lang.String element)
Constructs a DataInputProcessingException with the specified detail message.

Parameters:
msg - a message providing information about the exception.
element - the tag name of the data Element

DataInputProcessingException

public DataInputProcessingException(int error,
                                    java.lang.String element)
Constructs a DataInputProcessingException with the specified error code and the data element tag name.

Parameters:
error - one of the documented error codes.
element - the tag name of the data Element

DataInputProcessingException

public DataInputProcessingException(java.lang.String msg,
                                    int error,
                                    java.lang.String element)
Constructs a DataInputProcessingException with the specified detail message, the error code and the data element tag name.

Parameters:
msg - a message providing information about the exception.
error - one of the documented error codes
element - the tag name of the data Element

DataInputProcessingException

public DataInputProcessingException(java.lang.String msg,
                                    int error,
                                    java.lang.String element,
                                    java.lang.String type)
Constructs a DataInputProcessingException with the specified detail message, the error code, the data element tag name and the widget type.

Parameters:
msg - a message providing information about the exception.
error - one of the documented error codes
element - the tag name of the data Element
type - the graphic type produced by the object throwing the exception
Method Detail

getErrorCode

public int getErrorCode()
Returns the error code which was passed as constructor parameter.


getElement

public java.lang.String getElement()
Returns the element which was passed as constructor parameter.


getWidgetType

public java.lang.String getWidgetType()
Returns the graphic type which was passed as constructor parameter.


setWidgetType

public void setWidgetType(java.lang.String type)
Sets the graphic type produced by the object throwing the exception.

Parameters:
type - the type of graphic