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.


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:
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 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 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.
    void initialize()
    Initialization for SFBool applies default initial value.
    static boolean isArray()
    Whether or not this field type is an array (false)
    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.
    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​(java.lang.String newValue)
    Utility accessor for SFBool 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 get/set comparison tests
    java.lang.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 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 Details

    • 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 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:
      Stack Overflow: How to check if a given Regex is valid?, DEFAULT_VALUE
    • 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 java.lang.String validate()
      Validate current value via get/set comparison tests
      Returns:
      empty string if get/set testing passes, warning otherwise
      See Also:
      validate(), validateRegex()
    • validateRegex

      public final java.lang.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:
      REGEX, PATTERN, matches(), matches(String), validate(), 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 SFBool setValueByString​(java.lang.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:
      X3DLoaderDOM.toX3dModelInstance(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 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:
      DEFAULT_VALUE