    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class xg.xg_Exception

    java.lang.Object
       |
       +----java.lang.Throwable
               |
               +----java.lang.Exception
                       |
                       +----xg.xg_Exception

public class xg_Exception
extends Exception

The raw data used to generate a text message. It comprises an ID (which is to be used by an external caller to retrieve a basic message text suitable for the appropriate locale) and an array of parameters which are to be merged into the final text.

##

EndPosition
  The location in the source of the end of the area to highlight.
MessageID
  The ID of the error.
ParameterArray
  An array of parameters to be inserted in the message whose ID is given in the MessageID attribute.
StartPosition
  The location in the source of the start of the area to highlight.

##

xg_Exception(String)
  Constructor.
xg_Exception(String, int, int)
  Constructor.
xg_Exception(String, Object[])
  Constructor.
xg_Exception(String, Object[], int, int)
  Constructor.

##

getEndPosition()
  Get the location in the source of the end of the area to highlight.
getMessageID()
  Get the ID to be used to retrieve message text.
getParameterArray()
  Get the array of parameter values.
getStartPosition()
  Get the location in the source of the start of the area to highlight.

##

MessageID

     protected String MessageID

  The ID of the error. This is intended to be used as the key to retrieve an error message text (to provide multi-lingual support) - although at present the whole message text is placed in here.

ParameterArray

     protected Object ParameterArray[]

  An array of parameters to be inserted in the message whose ID is given in the MessageID attribute.

StartPosition

     protected int StartPosition

  The location in the source of the start of the area to highlight.

EndPosition

     protected int EndPosition

  The location in the source of the end of the area to highlight.

##

xg_Exception

     public xg_Exception(String InputMessageID,
                         Object InputParameterArray[],
                         int InputStartPosition,
                         int InputEndPosition)

  Constructor.

  Parameters:
    InputMessageID - ID to be used to retrieve message text
    InputParameterArray - Array of parameter values
    InputStartPosition - Start of area in source to highlight
    InputEndPosition - End of area in source to highlight

xg_Exception

     public xg_Exception(String InputMessageID,
                         Object InputParameterArray[])

  Constructor.

  Parameters:
    InputMessageID - ID to be used to retrieve message text
    InputParameterArray - Array of parameter values

xg_Exception

     public xg_Exception(String InputMessageID,
                         int InputStartPosition,
                         int InputEndPosition)

  Constructor.

  Parameters:
    InputMessageID - ID to be used to retrieve message text
    InputStartPosition - Start of area in source to highlight
    InputEndPosition - End of area in source to highlight

xg_Exception

     public xg_Exception(String InputMessageID)

  Constructor.

  Parameters:
    InputMessageID - ID to be used to retrieve message text

##

getMessageID

     public String getMessageID()

  Get the ID to be used to retrieve message text.

  Returns:
    ID to be used to retrieve message text

getParameterArray

     public Object[] getParameterArray()

  Get the array of parameter values.

  Returns:
    Array of parameter values

getStartPosition

     public int getStartPosition()

  Get the location in the source of the start of the area to highlight.

  Returns:
    Start of area in source to highlight

getEndPosition

     public int getEndPosition()

  Get the location in the source of the end of the area to highlight.

  Returns:
    End of area in source to highlight

    All Packages  Class Hierarchy  This Package  Previous  Next  Index