Class SFBoolObject

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static boolean DEFAULT_VALUE
      Default value for this field type is a true value.
      static java.lang.String DEFAULT_VALUE_STRING
      Default string value for this field type is "true".
      static java.lang.String FALSE
      String constant for boolean value false, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
      static java.lang.String NAME
      String constant NAME provides name of this element: SFBool
      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*(true|false)\s*
      static java.lang.String TRUE
      String constant for boolean value true, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
      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
      SFBoolObject()
      Constructor for SFBoolObject performs value initialization.
      SFBoolObject​(boolean newValue)
      Constructor for SFBoolObject using a corresponding Java primitive boolean as new initial value.
      SFBoolObject​(SFBoolObject newValue)
      Constructor to copy an SFBoolObject value as initial value for this new field object.
    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: SFBool
        See Also:
        Constant Field Values
      • DEFAULT_VALUE_STRING

        public static final java.lang.String DEFAULT_VALUE_STRING
        Default string value for this field type is "true".
        See Also:
        Constant Field Values
      • TUPLE_SIZE

        public static final 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).
        See Also:
        Constant Field Values
      • TRUE

        public static java.lang.String TRUE
        String constant for boolean value true, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
      • FALSE

        public static java.lang.String FALSE
        String constant for boolean value false, note lower-case value is X3D XML syntax (upper-case value is VRML syntax)
    • Constructor Detail

      • SFBoolObject

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

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

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

      • equals

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

        public boolean 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 SFBool
      • negate

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

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