SFBoolObject (X3DJSAIL, X3D Java Scene Access Interface Library)

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

All Implemented Interfaces:

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

Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFBool is a logical type with possible values (true|false) to match the XML boolean type. Hint: boolean values are lower case (true|false) in order to maintain compatibility with HTML and other XML documents.

Related field object: MFBoolObject

See Also:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_VALUE` Default value for this field type is a true value.
`static java.lang.String`	`DEFAULT_VALUE_STRING` Default string value for this field type is "true".
`static java.lang.String`	`FALSE` String constant for boolean value false, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
`static java.lang.String`	`NAME` String constant NAME provides name of this element: SFBool
`static java.util.regex.Pattern`	`PATTERN` Precompiled regular expression (regex) pattern for this field type using default REGEX value.
`static java.lang.String`	`REGEX` Default regular expression (regex) pattern for this field type is \s(true\|false)\s
`static java.lang.String`	`TRUE` String constant for boolean value true, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
`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
`SFBoolObject()` Constructor for SFBoolObject performs value initialization.
`SFBoolObject(boolean newValue)` Constructor for SFBoolObject using a corresponding Java primitive boolean as new initial value.
`SFBoolObject(SFBoolObject newValue)` Constructor to copy an SFBoolObject value as initial value for this new field object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getPrimitiveValue()` Provides current value of the field as a Java primitive type.
`boolean`	`getValue()` Get the current value.
`void`	`initialize()` Initialization for SFBoolObject applies default initial value.
`boolean`	`isDefaultValue()` Determine whether current value matches DEFAULT_VALUE
`boolean`	`matches()` Test PATTERN match via regular expression (regex) check of current object's toString() value.
`static boolean`	`matches(java.lang.String value)` Test PATTERN match with regular expression (regex) of provided value.
`SFBoolObject`	`negate()` Utility method to negate this boolean value.
`void`	`setValue(boolean newValue)` Assign a new value to this field.
`SFBoolObject`	`setValue(SFBoolObject newValue)` Apply an SFBoolObject value to this field.
`SFBoolObject`	`setValueByString(java.lang.String newValue)` Utility accessor for SFBoolObject using String value (which must pass parsing validation checks).
`java.lang.String`	`toString()` Provides current value as a String.
`static java.lang.String`	`toString(boolean value)` Static utility method to provide String representation of a correctly typed input value.
`java.lang.String`	`validate()` Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.

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: SFBool
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE
```
public static final boolean DEFAULT_VALUE
```
    Default value for this field type is a true value.
    
    See Also:
    
    Java Tutorials: Primitive Data Types, Constant Field Values
  - DEFAULT_VALUE_STRING
```
public static final java.lang.String DEFAULT_VALUE_STRING
```
    Default string value for this field type is "true".
    
    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
  - REGEX
```
public static final java.lang.String REGEX
```
    Default regular expression (regex) pattern for this field type is \s*(true|false)\s*
    
    See Also:
    
    PATTERN, matches(), matches(String), validate(), X3D Regular Expressions: SFBool, Constant Field Values
  - PATTERN
```
public static final java.util.regex.Pattern PATTERN
```
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    
    See Also:
    
    REGEX, matches(), matches(String), validate(), java.util.regex.Pattern
  - TRUE
```
public static java.lang.String TRUE
```
    String constant for boolean value true, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
  - FALSE
```
public static java.lang.String FALSE
```
    String constant for boolean value false, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
- Constructor Detail
  - SFBoolObject
```
public SFBoolObject()
```
    Constructor for SFBoolObject performs value initialization.
  - SFBoolObject
```
public SFBoolObject(SFBoolObject newValue)
```
    Constructor to copy an SFBoolObject value as initial value for this new field object.
    
    Parameters:
    
    newValue - The newValue to apply
  - SFBoolObject
```
public SFBoolObject(boolean newValue)
```
    Constructor for SFBoolObject using a corresponding Java primitive boolean 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 SFBoolObject applies default initial value. Static initializer also provided to verify that the regex pattern compiles and matches that default value.
    
    Specified by:
    
    initialize in class X3DConcreteField
    
    See Also:
    
    Stack Overflow: How to check if a given Regex is valid?, DEFAULT_VALUE
  - validate
```
public final java.lang.String validate()
```
    Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.
    
    Returns:
    
    empty string if PATTERN matches, warning otherwise
    
    See Also:
    
    REGEX, PATTERN, matches(), matches(String), validate(), java.util.regex.Pattern
  - matches
```
public final boolean matches()
```
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    
    Returns:
    
    true if PATTERN matches, false otherwise
    
    See Also:
    
    REGEX, PATTERN, matches(), matches(String), validate(), java.util.regex.Pattern
  - matches
```
public static final boolean matches(java.lang.String value)
```
    Test PATTERN match with regular expression (regex) of provided value.
    
    Parameters:
    
    value - String to check against regex pattern for successful match
    
    Returns:
    
    true if PATTERN matches, false otherwise
    
    See Also:
    
    REGEX, PATTERN, matches(), matches(String), validate(), java.util.regex.Pattern
  - setValueByString
```
public SFBoolObject setValueByString(java.lang.String newValue)
                              throws InvalidFieldValueException
```
    Utility accessor for SFBoolObject using String value (which must pass parsing validation checks).
    
    Warning: this method is not type safe at compile time! Best practice for X3DJSAIL programmers is to use strongly typed methods instead, in order to avoid potential for run-time errors.
    
    Parameters:
    
    newValue - is new value to assign, if empty then assign DEFAULT_VALUE
    
    Returns:
    
    MFMatrix4dObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    Throws:
    
    InvalidFieldValueException
    
    See Also:
    
    X3DLoaderObject.toX3dObjectTree(org.w3c.dom.Node)
  - toString
```
public static java.lang.String toString(boolean 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 boolean getValue()
```
    Get the current value.
    
    Specified by:
    
    getValue in interface SFBool
    
    Returns:
    
    current value
  - getPrimitiveValue
```
public boolean 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 SFBool
  - setValue
```
public void setValue(boolean newValue)
```
    Assign a new value to this field.
    
    Specified by:
    
    setValue in interface SFBool
    
    Parameters:
    
    newValue - The replacement value to assign.
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - negate
```
public SFBoolObject negate()
```
    Utility method to negate this boolean value.
    
    Returns:
    
    SFBoolObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setValue
```
public SFBoolObject setValue(SFBoolObject newValue)
```
    Apply an SFBoolObject value to this field.
    
    Parameters:
    
    newValue - The newValue to apply
    
    Returns:
    
    SFBoolObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - isDefaultValue
```
public boolean isDefaultValue()
```
    Determine whether current value matches DEFAULT_VALUE
    
    Returns:
    
    whether current value matches DEFAULT_VALUE
    
    See Also:
    
    DEFAULT_VALUE

Class SFBoolObject

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

REGEX

PATTERN

TRUE

FALSE

Constructor Detail

SFBoolObject

SFBoolObject

SFBoolObject

Method Detail

initialize

validate

matches

matches

setValueByString

toString

getValue

getPrimitiveValue

toString

setValue

negate

setValue

isDefaultValue