Package org.web3d.x3d.jsail.fields

Class SFInt32

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFInt32
All Implemented Interfaces:
SFInt32, X3DField
public class SFInt32
extends X3DConcreteField
implements SFInt32
This utility class provides a concrete implementation corresponding to SFInt32 X3D field type.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFInt32 specifies one 32-bit signed integer.

Related field object: MFInt32
See Also:
X3D Tooltips: type SFInt32, 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 0.
    static java.lang.String DEFAULT_VALUE_STRING
    Default string value for this field type is "0".
    static java.lang.String NAME
    String constant NAME provides name of this element: SFInt32
    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
    SFInt32()
    Constructor for SFInt32 performs value initialization.
    SFInt32​(int newValue)
    Constructor for SFInt32 using a corresponding Java primitive int as new initial value.
    SFInt32​(SFInt32 newValue)
    Constructor to copy an SFInt32 value as initial value for this new field object.

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(SFInt32 comparisonSFInt32)
    Determine whether two objects contain equal values.
    int getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    int getValue()
    Get the current value.
    void initialize()
    Initialization for SFInt32 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.
    void setValue​(int newValue)
    Assign a new value to this field.
    SFInt32 setValue​(SFInt32 newValue)
    Apply an SFInt32 value to this field.
    SFInt32 setValueByString​(java.lang.String newValue)
    Utility accessor for SFInt32 using String value (which must pass parsing validation checks).
    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 value 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 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

    Methods inherited from interface org.web3d.x3d.sai.X3DField

    addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener

  • Field Details

  • Constructor Details

    • SFInt32

      public SFInt32()
      Constructor for SFInt32 performs value initialization.

    • SFInt32

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

    • SFInt32

      public SFInt32​(int newValue)
      Constructor for SFInt32 using a corresponding Java primitive int 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 SFInt32 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​(SFInt32 comparisonSFInt32)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonSFInt32 - 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 SFInt32 setValueByString​(java.lang.String newValue) throws InvalidFieldValueException
      Utility accessor for SFInt32 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​(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 int getValue()
      Get the current value.
      Specified by:
      getValue in interface SFInt32
      Returns:
      current value

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

    • toStringHexadecimal

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

    • setValue

      public void setValue​(int newValue)
      Assign a new value to this field.
      Specified by:
      setValue in interface SFInt32
      Parameters:
      newValue - The replacement value to assign.
      See Also:
      X3DConcreteField.getTupleSize(String)

    • setValue

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