Class SFFloatObject

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static float DEFAULT_VALUE
      Default value for this field type is 0.0.
      static java.lang.String DEFAULT_VALUE_STRING
      Default string value for this field type is "0.0".
      static java.lang.String NAME
      String constant NAME provides name of this element: SFFloat
      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).
    • Constructor Summary

      Constructors 
      Constructor Description
      SFFloatObject()
      Constructor for SFFloatObject performs value initialization.
      SFFloatObject​(double newValue)
      Constructor using double as new initial value.
      SFFloatObject​(float newValue)
      Constructor for SFFloatObject using a corresponding Java primitive float as new initial value.
      SFFloatObject​(int newValue)
      Constructor using int as new initial value.
      SFFloatObject​(SFFloatObject newValue)
      Constructor to copy an SFFloatObject value as initial value for this new field object.
    • Method Summary

      Modifier and Type Method Description
      boolean equals​(SFFloatObject comparisonSFFloatObject)
      Determine whether two objects contain equal values.
      float getPrimitiveValue()
      Provides current value of the field as a Java primitive type.
      float getValue()
      Get the current value.
      void initialize()
      Initialization for SFFloatObject applies default initial value.
      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.
      SFFloatObject setValue​(double newValue)
      Apply a double value to this float field type, note change in precision.
      void setValue​(float newValue)
      Assign a new value to this field.
      SFFloatObject setValue​(int newValue)
      Apply an int value to this float field type, note change in precision.
      SFFloatObject setValue​(SFFloatObject newValue)
      Apply an SFFloatObject value to this field.
      SFFloatObject setValueByString​(java.lang.String newValue)
      Utility accessor for SFFloatObject 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​(float value)
      Utility method to always strip trailing fractional zeroes from String value of any given float.
      java.lang.String toString()
      Provides current value as a String.
      static java.lang.String toString​(float 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
    • Constructor Detail

      • SFFloatObject

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

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

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

        public SFFloatObject​(double newValue)
        Constructor using double as new initial value.
        Parameters:
        newValue - is new value to assign
      • SFFloatObject

        public SFFloatObject​(int newValue)
        Constructor using int as new initial value.
        Parameters:
        newValue - is new value to assign
    • Method Detail

      • equals

        public boolean equals​(SFFloatObject comparisonSFFloatObject)
        Determine whether two objects contain equal values.
        Parameters:
        comparisonSFFloatObject - 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()
      • 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 SFFloatObject setValueByString​(java.lang.String newValue)
                                       throws InvalidFieldValueException
        Utility accessor for SFFloatObject 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​(float 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 float getValue()
        Get the current value.
        Specified by:
        getValue in interface SFFloat
        Returns:
        current value
      • getPrimitiveValue

        public float 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 SFFloat
      • setValue

        public SFFloatObject setValue​(double newValue)
        Apply a double value to this float field type, note change in precision.
        Parameters:
        newValue - The double newValue to apply
        Returns:
        SFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setValue

        public SFFloatObject setValue​(int newValue)
        Apply an int value to this float field type, note change in precision.
        Parameters:
        newValue - The int newValue to apply
        Returns:
        SFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • stripTrailingZeroes

        public static java.lang.String stripTrailingZeroes​(float value)
        Utility method to always strip trailing fractional zeroes from String value of any given float. Applicability: first converting an integer (such as 100) to float and then String results in trailing decimal point and zero (such as 100.0). Note: not affected by ConfigurationProperties.setStripTrailingZeroes(boolean).
        Parameters:
        value - a single-precision number
        Returns:
        string value with trailing zeros and decimal points stripped
        See Also:
        stripTrailingZeroes(float)
      • setValue

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