Package org.web3d.x3d.jsail.fields
Class SFBool
java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFBool
This utility class provides a concrete implementation corresponding to SFBool X3D field type.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
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: XML boolean values are lower case (true|false) in order to maintain compatibility with HTML and other XML documents.
Related field object:
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
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: XML boolean values are lower case (true|false) in order to maintain compatibility with HTML and other XML documents.
Related field object:
MFBool
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final boolean
Default value for this field type is a true value.static final String
Default string value for this field type is "false".static String
String constant for boolean value false, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)static final String
String constant NAME provides name of this element: SFBoolstatic final Pattern
Precompiled regular expression (regex) pattern for this field type using default REGEX value.static final String
Default regular expression (regex) pattern for this field type is \s*(true|false)\s*static String
String constant for boolean value true, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)static final int
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 -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determine whether two objects contain equal values.boolean
Provides current value of the field as a Java primitive type.boolean
getValue()
Get the current value.final void
Initialization for SFBool applies default initial value.static final boolean
isArray()
Whether or not this field type is an array (false)boolean
Determine whether current value matches DEFAULT_VALUEfinal boolean
matches()
Test PATTERN match via regular expression (regex) check of current object's toString() value.static final boolean
Test PATTERN match with regular expression (regex) of provided value.negate()
Utility method to negate this boolean value.void
setValue
(boolean newValue) Assign a new value to this field.Apply an SFBool value to this field.setValueByString
(String newValue) Utility accessor for SFBool using String value (which must pass parsing validation checks).toString()
Provides current value as a String.static String
toString
(boolean value) Static utility method to provide String representation of a correctly typed input value.final String
validate()
Validate current value via get/set comparison testsfinal String
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
-
Field Details
-
NAME
String constant NAME provides name of this element: SFBool- See Also:
-
DEFAULT_VALUE
public static final boolean DEFAULT_VALUEDefault value for this field type is a true value.- See Also:
-
DEFAULT_VALUE_STRING
Default string value for this field type is "false".- See Also:
-
TUPLE_SIZE
public static final int TUPLE_SIZEDefault tuple size for this field type is 1 (i.e. number of component values making up a single-field SF object).- See Also:
-
REGEX
Default regular expression (regex) pattern for this field type is \s*(true|false)\s*- See Also:
-
PATTERN
Precompiled regular expression (regex) pattern for this field type using default REGEX value.- See Also:
-
TRUE
String constant for boolean value true, note lower-case value is X3D XML syntax (upper-case value is VRML syntax) -
FALSE
String constant for boolean value false, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
-
-
Constructor Details
-
SFBool
public SFBool()Constructor for SFBool performs value initialization. -
SFBool
Constructor to copy an SFBool value as initial value for this new field object.- Parameters:
newValue
- The newValue to apply
-
SFBool
public SFBool(boolean newValue) Constructor for SFBool using a corresponding Java primitive boolean as new initial value.- Parameters:
newValue
- is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
-
-
Method Details
-
isArray
public static final boolean isArray()Whether or not this field type is an array (false)- Returns:
- true if array type
-
initialize
public final void initialize()Initialization for SFBool applies default initial value. Static initializer also provided to verify that the regex pattern compiles and matches that default value.- Specified by:
initialize
in classX3DConcreteField
- See Also:
-
equals
Determine whether two objects contain equal values.- Parameters:
comparisonSFBool
- field type to compare- Returns:
- true if equivalent, false otherwise
-
validate
Validate current value via get/set comparison tests- Returns:
- empty string if get/set testing passes, warning otherwise
- See Also:
-
validateRegex
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:
-
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:
-
matches
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:
-
setValueByString
Utility accessor for SFBool 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:
MFMatrix4d
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).- Throws:
InvalidFieldValueException
- See Also:
-
toString
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:
-
getValue
-
getPrimitiveValue
public boolean getPrimitiveValue()Provides current value of the field as a Java primitive type.- Returns:
- current value
-
toString
-
setValue
-
negate
-
setValue
-
isDefaultValue
public boolean isDefaultValue()Determine whether current value matches DEFAULT_VALUE- Returns:
- whether current value matches DEFAULT_VALUE
- See Also:
-