Class SFTimeObject

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFTimeObject
All Implemented Interfaces:
SFTime, X3DField

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


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). The SFTime field specifies a single time value. Time values are specified as a double-precision floating point number. Typically, SFTime fields represent the number of seconds since Jan 1, 1970, 00:00:00 GMT.

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

    Fields 
    Modifier and Type Field Description
    static double DEFAULT_VALUE
    Default value for this field type is a -1 value.
    static java.lang.String DEFAULT_VALUE_STRING
    Default string value for this field type is "-1.0".
    static java.lang.String NAME
    String constant NAME provides name of this element: SFTime
    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
    SFTimeObject()
    Constructor for SFTimeObject performs value initialization.
    SFTimeObject​(double newValue)
    Constructor for SFTimeObject using a corresponding Java primitive double as new initial value.
    SFTimeObject​(float newValue)
    Constructor using float as new initial value.
    SFTimeObject​(int newValue)
    Constructor using int as new initial value.
    SFTimeObject​(SFTimeObject newValue)
    Constructor to copy an SFTimeObject value as initial value for this new field object.
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(SFTimeObject comparisonSFTimeObject)
    Determine whether two objects contain equal values.
    long getJavaValue()
    Get the current value.
    double getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    double getValue()
    Get the current value.
    void initialize()
    Initialization for SFTimeObject 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​(double newValue)
    Assign a new value to this field.
    SFTimeObject setValue​(float newValue)
    Apply a float value to this double field type, note change in precision.
    SFTimeObject setValue​(int newValue)
    Apply an int value to this double field type, note change in precision.
    void setValue​(long newValue)
    Assign a new value, converting seconds from (long) to (double).
    SFTimeObject setValue​(SFTimeObject newValue)
    Apply an SFTimeObject value to this field.
    SFTimeObject setValueByString​(java.lang.String newValue)
    Utility accessor for SFTimeObject using String value (which must pass parsing validation checks).
    java.lang.String stripTrailingZeroes()
    Utility method to strip trailing fractional zeroes from String representations of the current object's value.
    static java.lang.String stripTrailingZeroes​(double value)
    Utility method to always strip trailing fractional zeroes from String value of any given double.
    java.lang.String toString()
    Provides current value as a String.
    static java.lang.String toString​(double 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