Class MFInt32Object

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.MFInt32Object
All Implemented Interfaces:
MField, MFInt32, X3DField

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


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). An MFInt32 field defines an array of 32-bit signed integers. Array values are optionally separated by commas.

Related field object: SFInt32Object
See Also:
X3D Tooltips: type MFInt32, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFInt32AndMFInt32, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int[] DEFAULT_VALUE
    Default value for this field type is an empty array.
    static java.lang.String DEFAULT_VALUE_STRING
    Default string value for this field type is "".
    static java.lang.String NAME
    String constant NAME provides name of this element: MFInt32
    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)*([+-]?
    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
    MFInt32Object()
    Constructor for MFInt32Object performs value initialization.
    MFInt32Object​(int newValue)
    Utility constructor for MFInt32Object to assign a single int as new initial array value.
    MFInt32Object​(int[] newValue)
    Constructor for MFInt32Object using a corresponding Java primitive int[] array as new initial value.
    MFInt32Object​(MFInt32Object newValue)
    Constructor to copy an MFInt32Object value as initial value for this new field object.
    MFInt32Object​(SFInt32Object newValue)
    Utility constructor for MFInt32Object using a corresponding SFInt32Object as new initial value (which must pass parsing validation checks).
  • Method Summary

    Modifier and Type Method Description
    void append​(int newValue)
    Places new value(s) at the end of the existing value array, increasing the field length accordingly.
    void append​(int[] newValue)
    Appends another array at the end of the existing value array, increasing the field length accordingly.
    MFInt32Object append​(MFInt32Object newValue)
    Appends a new MFInt32Object to the end of the existing value array, increasing the field length accordingly.
    MFInt32Object append​(SFInt32Object newValue)
    Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
    void clear()
    Removes all values in the field array, changing the array size to zero.
    boolean equals​(MFInt32Object comparisonMFInt32Object)
    Determine whether two objects contain equal values.
    int get1Value​(int index)
    Get an individual value from the existing field array.
    int[] getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    void getValue​(int[] valueDestination)
    Get the current value of this MFInt32Object by copying it into the valueDestination array, leaving the current object unchanged.
    void initialize()
    Initialization for MFInt32Object applies default initial value.
    void insertValue​(int index, int newValue)
    Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
    static boolean isArray()
    Whether or not this field type is an array (true)
    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.
    MFInt32Object multiply​(int scaleFactor)
    Multiply scaleFactor times all values in this field type.
    void remove​(int index)
    Remove one SFInt32 element of the field array at index position, if found.
    void set1Value​(int index, int newValue)
    Replace a single value at the appropriate location in the existing value array.
    void setValue​(int newValue)
    Assign a single int value as new array (of length 1).
    void setValue​(int[] newValue)
    Assign a new int[] value to this field.
    void setValue​(int size, int[] newValue)
    Assign an array subset to this field.
    MFInt32Object setValue​(MFInt32Object newValue)
    Apply an MFInt32Object value to this field.
    MFInt32Object setValue​(SFInt32Object newValue)
    Assign a single-field SFInt32Object as new array value.
    MFInt32Object setValueByString​(java.lang.String newValue)
    Utility accessor for MFInt32Object using String value (which must pass parsing validation checks).
    int size()
    Get the size of the underlying data array, meaning the number of simple SFInt32 elements for the given data type.
    java.lang.String toString()
    Provides current value as a String.
    static java.lang.String toString​(int[] value)
    Static utility method to provide String representation of a correctly typed input value.
    java.lang.String toStringHexadecimal()
    Provide pixel values in hexadecimal format.
    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

  • Constructor Details

    • MFInt32Object

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

      public MFInt32Object​(int newValue)
      Utility constructor for MFInt32Object to assign a single int as new initial array value.
      Parameters:
      newValue - is new value to assign
    • MFInt32Object

      public MFInt32Object​(SFInt32Object newValue)
      Utility constructor for MFInt32Object using a corresponding SFInt32Object as new initial value (which must pass parsing validation checks).
      Parameters:
      newValue - is new value to assign
    • MFInt32Object

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

      public MFInt32Object​(int[] newValue)
      Constructor for MFInt32Object using a corresponding Java primitive int[] array 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 (true)
    • initialize

      public final void initialize()
      Initialization for MFInt32Object 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​(MFInt32Object comparisonMFInt32Object)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonMFInt32Object - 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 MFInt32Object setValueByString​(java.lang.String newValue) throws InvalidFieldValueException
      Utility accessor for MFInt32Object 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:
      X3DLoaderDOM.toX3dObjectTree(org.w3c.dom.Node)
    • toString

      public static java.lang.String toString​(int[] 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​(int[] valueDestination)
      Get the current value of this MFInt32Object by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface MFInt32
      Parameters:
      valueDestination - The array to be filled in with current field values.
    • getPrimitiveValue

      public int[] 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 MFInt32
    • toStringHexadecimal

      public java.lang.String toStringHexadecimal()
      Provide pixel values in hexadecimal format.
      Returns:
      String version of the provided value in hexadecimal format
      See Also:
      X3D Tooltips: type MFInt32
    • get1Value

      public int 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 MFInt32
      Parameters:
      index - is position of selected value in current array
      Returns:
      The selected value
      Throws:
      java.lang.ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.
    • setValue

      public void setValue​(int size, int[] newValue)
      Assign an array subset to this field.
      Specified by:
      setValue in interface MFInt32
      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​(int[] newValue)
      Assign a new int[] value to this field.
      Parameters:
      newValue - is replacement value array to assign
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

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

      public MFInt32Object setValue​(SFInt32Object newValue)
      Assign a single-field SFInt32Object as new array value.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      MFInt32Object - 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, int newValue) throws java.lang.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 MFInt32
      Parameters:
      index - is position of selected value in current array
      newValue - provides new value to apply
      Throws:
      java.lang.ArrayIndexOutOfBoundsException
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

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

      public void append​(int[] 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 MFInt32Object append​(SFInt32Object 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:
      MFInt32Object - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • append

      public MFInt32Object append​(MFInt32Object newValue)
      Appends a new MFInt32Object 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:
      MFInt32Object - 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, int 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 MFInt32
      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 SFInt32 elements for the given data type.
      Specified by:
      size in interface MField
      Returns:
      The number of SFInt32 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 SFInt32 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
    • setValue

      public MFInt32Object setValue​(MFInt32Object newValue)
      Apply an MFInt32Object value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      MFInt32Object - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • multiply

      public MFInt32Object multiply​(int scaleFactor)
      Multiply scaleFactor times all values in this field type.
      Parameters:
      scaleFactor - scalar value for vector multiplication
      Returns:
      MFInt32Object - 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