Xj3D VRML/X3D Code API

org.web3d.vrml.lang
Class InvalidFieldValueException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.lang.RuntimeException
              extended byorg.web3d.vrml.lang.VRMLException
                  extended byorg.web3d.vrml.lang.FieldException
                      extended byorg.web3d.vrml.lang.InvalidFieldValueException
All Implemented Interfaces:
java.io.Serializable

public class InvalidFieldValueException
extends FieldException

Exception indicating that a field value is out of range.

This is generated when a node verifies the correctness of a setValue May be generated during the parsing process or by the field during runtime as the user is trying to modify it.

Version:
$Revision: 1.3 $
Author:
Alan Hudson
See Also:
Serialized Form

Constructor Summary
InvalidFieldValueException()
          Create a new exception with no message.
InvalidFieldValueException(java.lang.String msg)
          Create a new exception with a message.
InvalidFieldValueException(java.lang.String msg, java.lang.String field)
          Create a new exception with a message and the name of the field that had the error.
 
Method Summary
 java.lang.String getFieldName()
          Get the name of the field that generated this exception.
 void setFieldName(java.lang.String field)
          Set the name of the field that caused this error.
 
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

InvalidFieldValueException

public InvalidFieldValueException()
Create a new exception with no message.


InvalidFieldValueException

public InvalidFieldValueException(java.lang.String msg)
Create a new exception with a message.

Parameters:
msg - The message associated with this exception

InvalidFieldValueException

public InvalidFieldValueException(java.lang.String msg,
                                  java.lang.String field)
Create a new exception with a message and the name of the field that had the error.

Parameters:
msg - The message associated with this exception
field - The name of the field with the error
Method Detail

setFieldName

public void setFieldName(java.lang.String field)
Set the name of the field that caused this error. Used only by the code that generated the exception if the format error and field names are kept in two separate places.

Parameters:
field - The name of the field with the error

getFieldName

public java.lang.String getFieldName()
Get the name of the field that generated this exception. It may or may not be set, depending on the underlying implementation. If not set, this will return null;

Returns:
The name of the field with the invalid error

Xj3D VRML/X3D Code API

Copyright © 2001 - 2005 Web3D Consortium