MFNodeObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.fields.X3DConcreteField
- - org.web3d.x3d.jsail.fields.MFNodeObject

All Implemented Interfaces:

MField, MFNode, X3DField
```
public class MFNodeObject
extends X3DConcreteField
implements MFNode
```
This utility class provides a concrete implementation corresponding to MFNode X3D field type.

Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). The MFNode field specifies zero or more nodes; the default value of an MFNode field is the empty list.

Related field object: SFNodeObject

See Also:

X3D Tooltips: type MFNode, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFNodeAndMFNode, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static X3DNode[]`	`DEFAULT_VALUE` Default value for this field type is an empty array.
`static java.lang.String`	`DEFAULT_VALUE_STRING` Default string value for this field type is "".
`static java.lang.String`	`NAME` String constant NAME provides name of this element: MFNode
`static int`	`TUPLE_SIZE` Default tuple size for this field type is 1 (i.e. number of component values making up a single-field SF object).

Fields inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField
validationResult

Constructor Summary

Constructors
Constructor and Description
`MFNodeObject()` Constructor for MFNodeObject performs value initialization.
`MFNodeObject(MFNodeObject newValue)` Constructor to copy an MFNodeObject value as initial value for this new field object.
`MFNodeObject(SFNodeObject newValue)` Utility constructor for MFNodeObject using a corresponding SFNodeObject as new initial value (which must pass parsing validation checks).
`MFNodeObject(X3DNode newValue)` Utility constructor for MFNodeObject to assign a single X3DNode as new initial array value.
`MFNodeObject(X3DNode[] newValue)` Constructor for MFNodeObject using a corresponding Java primitive X3DNode[] array as new initial value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MFNodeObject`	`append(MFNodeObject newValue)` Appends a new MFNodeObject to the end of the existing value array, increasing the field length accordingly.
`MFNodeObject`	`append(SFNodeObject newValue)` Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
`void`	`append(X3DNode newValue)` Places new value(s) at the end of the existing value array, increasing the field length accordingly.
`void`	`append(X3DNode[] newValue)` Appends another array at the end of the existing value array, increasing the field length accordingly.
`void`	`clear()` Removes all values in the field array, changing the array size to zero.
`MFNodeObject`	`clearChildren()` Utility method to clear all contained children including nodes, statements and comments (if any).
`X3DNode`	`get1Value(int index)` Get an individual value from the existing field array.
`X3DNode[]`	`getPrimitiveValue()` Provides current value of the field as a Java primitive type.
`void`	`getValue(X3DNode[] valueDestination)` Get the current value of this MFNodeObject by copying it into the valueDestination array, leaving the current object unchanged.
`void`	`initialize()` Initialization for MFNodeObject applies default initial value.
`void`	`insertValue(int index, X3DNode newValue)` Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
`boolean`	`isDefaultValue()` Determine whether current value matches DEFAULT_VALUE
`void`	`remove(int index)` Remove one SFNode element of the field array at index position, if found.
`void`	`set1Value(int index, X3DNode newValue)` Replace a single value at the appropriate location in the existing value array.
`void`	`setValue(int size, X3DNode[] newValue)` Assign an array subset to this field.
`MFNodeObject`	`setValue(MFNodeObject newValue)` Apply an MFNodeObject value to this field.
`MFNodeObject`	`setValue(SFNodeObject newValue)` Assign a single-field SFNodeObject as new array value.
`void`	`setValue(X3DNode[] newValue)` Assign a new X3DNode[] value to this field.
`int`	`size()` Get the size of the underlying data array, meaning the number of simple SFNode elements for the given data type.
`java.lang.String`	`toString()` Provides current value as a String.
`static java.lang.String`	`toString(X3DNode[] value)` Static utility method to provide String representation of a correctly typed input value.

Methods inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField
addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.web3d.x3d.sai.X3DField
addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: MFNode
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE
```
public static final X3DNode[] DEFAULT_VALUE
```
    Default value for this field type is an empty array.
    
    See Also:
    
    Java Tutorials: Primitive Data Types
  - DEFAULT_VALUE_STRING
```
public static final java.lang.String DEFAULT_VALUE_STRING
```
    Default string value for this field type is "".
    
    See Also:
    
    Constant Field Values
  - TUPLE_SIZE
```
public static final int TUPLE_SIZE
```
    Default tuple size for this field type is 1 (i.e. number of component values making up a single-field SF object).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MFNodeObject
```
public MFNodeObject()
```
    Constructor for MFNodeObject performs value initialization.
  - MFNodeObject
```
public MFNodeObject(X3DNode newValue)
```
    Utility constructor for MFNodeObject to assign a single X3DNode as new initial array value.
    
    Parameters:
    
    newValue - is new value to assign
  - MFNodeObject
```
public MFNodeObject(SFNodeObject newValue)
```
    Utility constructor for MFNodeObject using a corresponding SFNodeObject as new initial value (which must pass parsing validation checks).
    
    Parameters:
    
    newValue - is new value to assign
  - MFNodeObject
```
public MFNodeObject(MFNodeObject newValue)
```
    Constructor to copy an MFNodeObject value as initial value for this new field object.
    
    Parameters:
    
    newValue - The newValue to apply
  - MFNodeObject
```
public MFNodeObject(X3DNode[] newValue)
```
    Constructor for MFNodeObject using a corresponding Java primitive X3DNode[] array as new initial value.
    
    Parameters:
    
    newValue - is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
- Method Detail
  - initialize
```
public void initialize()
```
    Initialization for MFNodeObject applies default initial value.
    
    Specified by:
    
    initialize in class X3DConcreteField
    
    See Also:
    
    DEFAULT_VALUE
  - toString
```
public static java.lang.String toString(X3DNode[] value)
```
    Static utility method to provide String representation of a correctly typed input value.
    
    Parameters:
    
    value - The value to convert to a String
    
    Returns:
    
    String version of the provided value
    
    See Also:
    
    X3D Tooltips: type
  - getValue
```
public void getValue(X3DNode[] valueDestination)
```
    Get the current value of this MFNodeObject by copying it into the valueDestination array, leaving the current object unchanged.
    
    Specified by:
    
    getValue in interface MFNode
    
    Parameters:
    
    valueDestination - The array to be filled in with current field values.
  - getPrimitiveValue
```
public X3DNode[] getPrimitiveValue()
```
    Provides current value of the field as a Java primitive type.
    
    Returns:
    
    current value
  - toString
```
public java.lang.String toString()
```
    Provides current value as a String.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String version of the provided value
    
    See Also:
    
    X3D Tooltips: type MFNode
  - get1Value
```
public X3DNode get1Value(int index)
```
    Get an individual value from the existing field array.
    If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.
    
    Specified by:
    
    get1Value in interface MFNode
    
    Parameters:
    
    index - is position of selected value in current array
    
    Returns:
    
    The selected value
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.
  - setValue
```
public void setValue(int size,
                     X3DNode[] newValue)
```
    Assign an array subset to this field.
    
    Specified by:
    
    setValue in interface MFNode
    
    Parameters:
    
    size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
    
    newValue - The replacement value array to (potentially) slice and then assign.
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - setValue
```
public void setValue(X3DNode[] newValue)
```
    Assign a new X3DNode[] value to this field.
    
    Parameters:
    
    newValue - is replacement value array to assign
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - setValue
```
public MFNodeObject setValue(SFNodeObject newValue)
```
    Assign a single-field SFNodeObject as new array value.
    
    Parameters:
    
    newValue - The replacement value to assign.
    
    Returns:
    
    MFNodeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - set1Value
```
public void set1Value(int index,
                      X3DNode newValue)
               throws java.lang.ArrayIndexOutOfBoundsException
```
    Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.
    
    Specified by:
    
    set1Value in interface MFNode
    
    Parameters:
    
    index - is position of selected value in current array
    
    newValue - provides new value to apply
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - append
```
public void append(X3DNode newValue)
```
    Places new value(s) at the end of the existing value array, increasing the field length accordingly.
    
    Specified by:
    
    append in interface MFNode
    
    Parameters:
    
    newValue - The newValue to append
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - append
```
public void append(X3DNode[] newValue)
```
    Appends another array at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec4f tuple size of 4.
    
    Parameters:
    
    newValue - The newValue to append
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - append
```
public MFNodeObject append(SFNodeObject newValue)
```
    Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for incrementally constructing arrays.
    
    Parameters:
    
    newValue - The newValue to append
    
    Returns:
    
    MFNodeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - append
```
public MFNodeObject append(MFNodeObject newValue)
```
    Appends a new MFNodeObject to the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for constructing long arrays.
    
    Parameters:
    
    newValue - The newValue to append
    
    Returns:
    
    MFNodeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - insertValue
```
public void insertValue(int index,
                        X3DNode newValue)
```
    Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
    
    Specified by:
    
    insertValue in interface MFNode
    
    Parameters:
    
    index - The position for the inserted value in the current array
    
    newValue - The newValue to insert
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - size
```
public int size()
```
    Get the size of the underlying data array, meaning the number of simple SFNode elements for the given data type.
    
    Specified by:
    
    size in interface MField
    
    Returns:
    
    The number of SFNode elements in this field array.
  - clear
```
public void clear()
```
    Removes all values in the field array, changing the array size to zero.
    
    Specified by:
    
    clear in interface MField
  - remove
```
public void remove(int index)
```
    Remove one SFNode element of the field array at index position, if found. Initial element is at index 0.
    
    Specified by:
    
    remove in interface MField
    
    Parameters:
    
    index - position of element in field array that gets removed
  - setValue
```
public MFNodeObject setValue(MFNodeObject newValue)
```
    Apply an MFNodeObject value to this field.
    
    Parameters:
    
    newValue - The newValue to apply
    
    Returns:
    
    MFNodeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - clearChildren
```
public MFNodeObject clearChildren()
```
    Utility method to clear all contained children including nodes, statements and comments (if any).
    
    Returns:
    
    MFNodeObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - isDefaultValue
```
public boolean isDefaultValue()
```
    Determine whether current value matches DEFAULT_VALUE
    
    Returns:
    
    whether current value matches DEFAULT_VALUE
    
    See Also:
    
    DEFAULT_VALUE

Class MFNodeObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

Methods inherited from class java.lang.Object

Methods inherited from interface org.web3d.x3d.sai.X3DField

Field Detail

NAME

DEFAULT_VALUE

DEFAULT_VALUE_STRING

TUPLE_SIZE

Constructor Detail

MFNodeObject

MFNodeObject

MFNodeObject

MFNodeObject

MFNodeObject

Method Detail

initialize

toString

getValue

getPrimitiveValue

toString

get1Value

setValue

setValue

setValue

set1Value

append

append

append

append

insertValue

size

clear

remove

setValue

clearChildren

isDefaultValue