Class SFString

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

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFString defines a single string encoded with the UTF-8 universal character set.

Related field object: MFString
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_VALUE
    Default value for this field type is an empty String.
    static final String
    DEFAULT_VALUE_STRING
    Default string value for this field type is "".
    static final String
    NAME
    String constant NAME provides name of this element: SFString
    static final String
    NameCharFilter
    XML Regular Expression NameChar.
    static final String
    NameFilter
    XML Regular Expression NameFilter.
    static final String
    NameStartCharFilter
    XML Regular Expression NameStartChar.
    static final String
    NmtokenFilter
    XML Regular Expression Nmtoken.
    static final Pattern
    PATTERN
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    static final String
    REGEX
    Default regular expression (regex) pattern for this field type is (\s|\S)*
    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).

    Fields inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

    validationResult

  • Constructor Summary

    Constructors
    Constructor
    Description
    SFString()
    Constructor for SFString performs value initialization.
    SFString(String newValue)
    Constructor for SFString using a corresponding Java primitive String as new initial value.
    SFString(SFString newValue)
    Constructor to copy an SFString value as initial value for this new field object.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    appendValue(String newValue)
    Append an additional String to this field.
    boolean
    equals(SFString comparisonSFString)
    Determine whether two objects contain equal values.
    String
    getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    String
    getValue()
    Get the current value.
    final void
    initialize()
    Initialization for SFString applies default initial value.
    static final boolean
    isArray()
    Whether or not this field type is an array (false)
    boolean
    isDefaultValue()
    Determine whether current value matches DEFAULT_VALUE
    static final boolean
    isNMTOKEN(String value)
    Utility method to determine if string meets XML NMTOKEN requirements
    static boolean
    isX3dNodeName(String value)
    Case-insensitive test whether or not string is a reserved X3D node name.
    static boolean
    isX3dStatementName(String value)
    Case-insensitive test whether or not string is a reserved X3D statement name.
    final boolean
    matches()
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    static final boolean
    matches(String value)
    Test PATTERN match with regular expression (regex) of provided value.
    static final boolean
    meetsX3dInteroperabilityNamingConventions(String value)
    Utility method to determine if string meets suggested X3D naming conventions: starts with letter or underscore character, includes letter character numeral or underscore characters.
    void
    prependValue(String newValue)
    Prepend an additional String to this field.
    void
    setValue(String newValue)
    Assign a new value to this field.
    SFString
    setValue(SFString newValue)
    Apply an SFString value to this field.
    SFString
    setValueByString(String newValue)
    Utility accessor for SFString using String value
    String
    toString()
    Provides current value as a String.
    static String
    toString(String value)
    Static utility method to provide String representation of a correctly typed input value.
    String
    toStringClassicVRML()
    Provide String representation of this SFString object, properly escaped using ClassicVRML (.x3dv) or VRML97 (.wrl) syntax.
    static String
    toStringClassicVRML(String value)
    Static utility method to provide SFString representation of input String, properly escaped using ClassicVRML (.x3dv) or VRML97 (.wrl) syntax.
    String
    toStringX3D()
    Provide String representation of this SFString object, properly escaped for XML-based X3D syntax and conforming to X3D Canonical Form.
    static String
    toStringX3D(String value)
    Static utility method to provide String representation of input String, properly escaped using XML-based X3D syntax.
    final String
    validate()
    Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.
    final 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