Package org.web3d.x3d.jsail.fields

Class SFBool

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFBool
All Implemented Interfaces:
SFBool, X3DField
public class SFBool extends X3DConcreteField implements 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 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

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
    DEFAULT_VALUE
    Default value for this field type is a true value.
    static final String
    DEFAULT_VALUE_STRING
    Default string value for this field type is "false".
    static String
    FALSE
    String constant for boolean value false, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
    static final String
    NAME
    String constant NAME provides name of this element: SFBool
    static final Pattern
    PATTERN
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    static final String
    REGEX
    Default regular expression (regex) pattern for this field type is \s*(true|false)\s*
    static String
    TRUE
    String constant for boolean value true, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
    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).

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

    validationResult

  • Constructor Summary

    Constructors
    Constructor
    Description
    SFBool()
    Constructor for SFBool performs value initialization.
    SFBool(boolean newValue)
    Constructor for SFBool using a corresponding Java primitive boolean as new initial value.
    SFBool(SFBool newValue)
    Constructor to copy an SFBool value as initial value for this new field object.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(SFBool comparisonSFBool)
    Determine whether two objects contain equal values.
    boolean
    getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    boolean
    getValue()
    Get the current value.
    final void
    initialize()
    Initialization for SFBool applies default initial value.
    static final boolean
    isArray()
    Whether or not this field type is an array (false)
    boolean
    isDefaultValue()
    Determine whether current value matches DEFAULT_VALUE
    final boolean
    matches()
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    static final boolean
    matches(String value)
    Test PATTERN match with regular expression (regex) of provided value.
    SFBool
    negate()
    Utility method to negate this boolean value.
    void
    setValue(boolean newValue)
    Assign a new value to this field.
    SFBool
    setValue(SFBool newValue)
    Apply an SFBool value to this field.
    SFBool
    setValueByString(String newValue)
    Utility accessor for SFBool using String value (which must pass parsing validation checks).
    String
    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 tests
    final String
    validateRegex()
    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

  • Field Details

  • Constructor Details

    • SFBool

      public SFBool()
      Constructor for SFBool performs value initialization.

    • SFBool

      public SFBool(SFBool newValue)
      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 class X3DConcreteField
      See Also:

    • equals

      public boolean equals(SFBool comparisonSFBool)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonSFBool - field type to compare
      Returns:
      true if equivalent, false otherwise

    • validate

      public final String validate()
      Validate current value via get/set comparison tests
      Returns:
      empty string if get/set testing passes, warning otherwise
      See Also:

    • validateRegex

      public final String 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

      public static final boolean matches(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:

    • setValueByString

      public SFBool setValueByString(String newValue) throws InvalidFieldValueException
      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

      public static 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:

    • 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 String toString()
      Provides current value as a String.
      Overrides:
      toString in class Object
      Returns:
      String version of the provided value
      See Also:

    • 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:

    • negate

      public SFBool negate()
      Utility method to negate this boolean value.
      Returns:
      SFBool - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setValue

      public SFBool setValue(SFBool newValue)
      Apply an SFBool value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      SFBool - 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: