SFNodeObject (X3DJSAIL, X3D Java Scene Access Interface Library)

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

All Implemented Interfaces:

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

Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). The SFNode field specifies an X3D node; the default empty value of an uninitialized SFNode field is sometimes described as NULL.

Related field object: MFNodeObject

See Also:

X3D Tooltips: type SFNode, 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 a null node.
`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: SFNode
`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
`SFNodeObject()` Constructor for SFNodeObject performs value initialization.
`SFNodeObject(SFNodeObject newValue)` Constructor to copy an SFNodeObject value as initial value for this new field object.
`SFNodeObject(X3DNode newValue)` Constructor for SFNodeObject using a corresponding Java primitive X3DNode as new initial value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SFNodeObject`	`clearChildren()` Utility method to clear all contained children including nodes, statements and comments (if any).
`X3DNode`	`getPrimitiveValue()` Provides current value of the field as a Java primitive type.
`X3DNode`	`getValue()` Get the current value.
`void`	`initialize()` Initialization for SFNodeObject applies default initial value.
`boolean`	`isDefaultValue()` Determine whether current value matches DEFAULT_VALUE
`SFNodeObject`	`setValue(SFNodeObject newValue)` Apply an SFNodeObject value to this field.
`void`	`setValue(X3DNode newValue)` Assign a new value to this field.
`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: SFNode
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE
```
public static final X3DNode DEFAULT_VALUE
```
    Default value for this field type is a null node.
    
    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
  - SFNodeObject
```
public SFNodeObject()
```
    Constructor for SFNodeObject performs value initialization.
  - SFNodeObject
```
public SFNodeObject(SFNodeObject newValue)
```
    Constructor to copy an SFNodeObject value as initial value for this new field object.
    
    Parameters:
    
    newValue - The newValue to apply
  - SFNodeObject
```
public SFNodeObject(X3DNode newValue)
```
    Constructor for SFNodeObject using a corresponding Java primitive X3DNode 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 SFNodeObject 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 X3DNode getValue()
```
    Get the current value.
    
    Specified by:
    
    getValue in interface SFNode
    
    Returns:
    
    current value
  - 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 SFNode
  - setValue
```
public void setValue(X3DNode newValue)
```
    Assign a new value to this field.
    
    Specified by:
    
    setValue in interface SFNode
    
    Parameters:
    
    newValue - The replacement value to assign.
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - setValue
```
public SFNodeObject setValue(SFNodeObject newValue)
```
    Apply an SFNodeObject value to this field.
    
    Parameters:
    
    newValue - The newValue to apply
    
    Returns:
    
    SFNodeObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - clearChildren
```
public SFNodeObject clearChildren()
```
    Utility method to clear all contained children including nodes, statements and comments (if any).
    
    Returns:
    
    SFNodeObject - 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 SFNodeObject

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

SFNodeObject

SFNodeObject

SFNodeObject

Method Detail

initialize

toString

getValue

getPrimitiveValue

toString

setValue

setValue

clearChildren

isDefaultValue