Package vrml.eai.field

Class EventInMFString

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventIn

vrml.eai.field.EventInMFString

Direct Known Subclasses:

EventInMFStringWrapper

public abstract class EventInMFString
extends EventIn

VRML eventIn class for MFColor.

Strings are represented using standard java.lang.String representations. The implementation of this class will provide any necessary conversions to the UTF8 format required for VRML support.

Version:

1.0 30 April 1998

Field Summary

Fields inherited from class vrml.eai.field.BaseField

fieldType, MFColor, MFFloat, MFInt32, MFNode, MFRotation, MFString, MFTime, MFVec2f, MFVec3f, SFBool, SFColor, SFFloat, SFImage, SFInt32, SFNode, SFRotation, SFString, SFTime, SFVec2f, SFVec3f, UNSET_FIELD

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventInMFString()	Construct an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract void	set1Value(int index, String value)	Set a particular string value in the given eventIn array.
abstract void	setValue(String[] value)	Set the value of the array of strings.

Methods inherited from class vrml.eai.field.EventIn

getUserData, setUserData

Methods inherited from class vrml.eai.field.BaseField

getType

Methods inherited from class java.lang.Object

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

Constructor Details

EventInMFString

protected EventInMFString()

Construct an instance of this class. The superclass constructor is called with the type MFString

Method Details

setValue

public abstract void setValue(String[] value)

Set the value of the array of strings. If value[i] contains a null reference this will not cause an exception to be generated. However, the resulting event that the eventIn receives will be implementation specific as this is not dealt with in the VRML specification.

Parameters:

value - The array of strings.

set1Value

public abstract void set1Value(int index,
 String value)

Set a particular string value in the given eventIn array. To the VRML world this will generate a full MFString event with the nominated index value changed.

If the index is out of the bounds of the current array of data values an ArrayIndexOutOfBoundsException will be generated. If the value reference is null then the result is implementation specific in terms of the array reference that reaches the eventIn. In any case, an event will reach the destination eventIn, but the values in that array are implementation specific. No exception will be generated in this case.

Parameters:

index - The position to set the string value

value - The string value

Throws:

ArrayIndexOutOfBoundsException - The index value was out of bounds of the current array.