org.web3d.vrml.lang
Class InvalidFieldException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.web3d.vrml.lang.VRMLException
                  org.web3d.vrml.lang.FieldException
                      org.web3d.vrml.lang.InvalidFieldException

All Implemented Interfaces:

java.io.Serializable

public class InvalidFieldException

extends FieldException

Exception indicating that a field is not known by this node.

This is generated when the node does not have the named or indexed field. May be generated during the parsing process or by the field during runtime as the user is trying to modify it.

Version:

$Revision: 1.5 $

Author:

Justin Couch

See Also:

Serialized Form

Constructor Summary

InvalidFieldException()
Create a new exception with no message.

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

InvalidFieldException(java.lang.String nodeName, int index)
Create a new exception for dealing with an invalid field index value.

InvalidFieldException(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

InvalidFieldException

public InvalidFieldException()

Create a new exception with no message.

InvalidFieldException

public InvalidFieldException(java.lang.String msg)

Create a new exception with a message.

Parameters:

msg - The message associated with this exception

InvalidFieldException

public InvalidFieldException(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

InvalidFieldException

public InvalidFieldException(java.lang.String nodeName,
                             int index)

Create a new exception for dealing with an invalid field index value. Useful for many situations such as routing and set values

Parameters:

index - The index of the field being set

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