Class MFBool

All Implemented Interfaces:
MFBool, MField, X3DField

public class MFBool extends X3DConcreteField implements MFBool
This utility class provides a concrete implementation corresponding to MFBool X3D field type.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). MFBool is an array of boolean values. Type MFBool was previously undefined in the VRML97 Specification, but nevertheless needed for event utilities and scripting. Example use: MFBool is useful for defining a series of behavior states using a BooleanSequencer prototype. Hint: XML boolean values are lower case (true|false) in order to maintain compatibility with HTML and other XML documents.

Related field object: SFBool
See Also:
X3D Tooltips: type MFBool, 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 for this field type is an empty array.
    static String
    Default string value for this field type is "".
    static String
    String constant NAME provides name of this element: MFBool
    static Pattern
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    static String
    Default regular expression (regex) pattern for this field type is \s*((true|false)\s*,?
    static 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
    Constructor
    Description
    Constructor for MFBool performs value initialization.
    MFBool​(boolean newValue)
    Constructor for MFBool using a single corresponding Java primitive boolean as new initial value.
    MFBool​(boolean[] newValue)
    Constructor for MFBool using a corresponding Java primitive boolean[] array as new initial value.
    MFBool​(MFBool newValue)
    Constructor to copy an MFBool value as initial value for this new field object.
    MFBool​(SFBool newValue)
    Utility constructor for MFBool to assign a single SFBool as new initial value.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append​(boolean newValue)
    Places new value(s) at the end of the existing value array, increasing the field length accordingly.
    void
    append​(boolean[] newValue)
    Appends another array at the end of the existing value array, increasing the field length accordingly.
    append​(MFBool newValue)
    Appends a new MFBool to the end of the existing value array, increasing the field length accordingly.
    append​(SFBool newValue)
    Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
    void
    Removes all values in the field array, changing the array size to zero.
    boolean
    equals​(MFBool comparisonMFBool)
    Determine whether two objects contain equal values.
    boolean
    get1Value​(int index)
    Get an individual value from the existing field array.
    boolean[]
    Provides current value of the field as a Java primitive type.
    void
    getValue​(boolean[] valueDestination)
    Get the current value of this MFBool by copying it into the valueDestination array, leaving the current object unchanged.
    void
    Initialization for MFBool applies default initial value.
    void
    insertValue​(int index, boolean newValue)
    Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
    static boolean
    Whether or not this field type is an array (true)
    boolean
    Determine whether current value matches DEFAULT_VALUE
    boolean
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    static boolean
    matches​(String value)
    Test PATTERN match with regular expression (regex) of provided value.
    Utility method to negate this array of boolean values.
    void
    remove​(int index)
    Remove one SFBool element of the field array at index position, if found.
    void
    set1Value​(int index, boolean newValue)
    Replace a single value at the appropriate location in the existing value array.
    void
    setValue​(boolean newValue)
    Assign a single boolean value as new array (of length 1).
    void
    setValue​(boolean[] newValue)
    Assign a new boolean[] value to this field.
    void
    setValue​(int size, boolean[] newValue)
    Assign an array subset to this field.
    setValue​(MFBool newValue)
    Apply an MFBool value to this field.
    setValue​(SFBool newValue)
    Assign a single-field SFBool as new array value.
    setValueByString​(String newValue)
    Utility accessor for MFBool using String value (which must pass parsing validation checks).
    int
    Get the size of the underlying data array, meaning the number of simple SFBool elements for the given data type.
    Provides current value as a String.
    static String
    toString​(boolean[] value)
    Static utility method to provide String representation of a correctly typed input value.
    Validate current value via get/set comparison tests
    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
  • Field Details

  • Constructor Details

    • MFBool

      public MFBool()
      Constructor for MFBool performs value initialization.
    • MFBool

      public MFBool(MFBool newValue)
      Constructor to copy an MFBool value as initial value for this new field object.
      Parameters:
      newValue - The newValue to apply
    • MFBool

      public MFBool(boolean[] newValue)
      Constructor for MFBool using a corresponding Java primitive boolean[] array as new initial value.
      Parameters:
      newValue - is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
    • MFBool

      public MFBool(boolean newValue)
      Constructor for MFBool using a single corresponding Java primitive boolean as new initial value.
      Parameters:
      newValue - is new value to assign
    • MFBool

      public MFBool(SFBool newValue)
      Utility constructor for MFBool to assign a single SFBool as new initial value.
      Parameters:
      newValue - is new value to assign
  • Method Details

    • isArray

      public static final boolean isArray()
      Whether or not this field type is an array (true)
      Returns:
      true if array type
    • initialize

      public final void initialize()
      Initialization for MFBool 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(MFBool comparisonMFBool)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonMFBool - 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:
      validate(), validateRegex()
    • 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:
      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(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 MFBool setValueByString(String newValue) throws InvalidFieldValueException
      Utility accessor for MFBool 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 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 void getValue(boolean[] valueDestination)
      Get the current value of this MFBool by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface MFBool
      Parameters:
      valueDestination - The array to be filled in with current field values.
    • 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:
      X3D Tooltips: type MFBool
    • get1Value

      public boolean get1Value(int index)

      Get an individual value from the existing field array.

      If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

      Specified by:
      get1Value in interface MFBool
      Parameters:
      index - is position of selected value in current array
      Returns:
      The selected value
      Throws:
      ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.
    • setValue

      public void setValue(int size, boolean[] newValue)
      Assign an array subset to this field.
      Specified by:
      setValue in interface MFBool
      Parameters:
      size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
      newValue - The replacement value array to (potentially) slice and then assign.
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public void setValue(boolean[] newValue)
      Assign a new boolean[] value to this field.
      Parameters:
      newValue - is replacement value array to assign
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public void setValue(boolean newValue)
      Assign a single boolean value as new array (of length 1).
      Parameters:
      newValue - The replacement value to assign.
    • setValue

      public MFBool setValue(SFBool newValue)
      Assign a single-field SFBool as new array value.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      MFBool - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    • set1Value

      public void set1Value(int index, boolean newValue) throws ArrayIndexOutOfBoundsException
      Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.
      Specified by:
      set1Value in interface MFBool
      Parameters:
      index - is position of selected value in current array
      newValue - provides new value to apply
      Throws:
      ArrayIndexOutOfBoundsException
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public void append(boolean newValue)
      Places new value(s) at the end of the existing value array, increasing the field length accordingly.
      Specified by:
      append in interface MFBool
      Parameters:
      newValue - The newValue to append
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public void append(boolean[] newValue)
      Appends another array at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec4f tuple size of 4.
      Parameters:
      newValue - The newValue to append
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public MFBool append(SFBool newValue)
      Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for incrementally constructing arrays.
      Parameters:
      newValue - The newValue to append
      Returns:
      MFBool - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • append

      public MFBool append(MFBool newValue)
      Appends a new MFBool to the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for constructing long arrays.
      Parameters:
      newValue - The newValue to append
      Returns:
      MFBool - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3DConcreteField.getTupleSize(String)
    • insertValue

      public void insertValue(int index, boolean newValue)
      Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
      Specified by:
      insertValue in interface MFBool
      Parameters:
      index - The position for the inserted value in the current array
      newValue - The newValue to insert
      See Also:
      X3DConcreteField.getTupleSize(String)
    • size

      public int size()
      Get the size of the underlying data array, meaning the number of simple SFBool elements for the given data type.
      Specified by:
      size in interface MField
      Returns:
      The number of SFBool elements in this field array.
    • clear

      public void clear()
      Removes all values in the field array, changing the array size to zero.
      Specified by:
      clear in interface MField
    • remove

      public void remove(int index)
      Remove one SFBool element of the field array at index position, if found. Initial element is at index 0.
      Specified by:
      remove in interface MField
      Parameters:
      index - position of element in field array that gets removed
    • negate

      public MFBool negate()
      Utility method to negate this array of boolean values.
      Returns:
      MFBool - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setValue

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