Package org.web3d.x3d.jsail.fields

Class MFString

java.lang.Object

org.web3d.x3d.jsail.fields.X3DConcreteField

org.web3d.x3d.jsail.fields.MFString

All Implemented Interfaces:

MField, MFString, X3DField

public class MFString
extends X3DConcreteField
implements MFString

This utility class provides a concrete implementation corresponding to MFString 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). MFString is an array of SFString values, each "quoted" and separated by whitespace. Individual SFString array values are optionally separated by commas in XML syntax.

Related field object: SFString

See Also:

• X3D Tooltips: type MFString
• SAI Java Specification: B.4.11 X3DFieldTypes
• SAI Abstract Specification: 5.2.15 SAIFieldType
• X3D Abstract Specification: SFStringAndMFString
• X3D Tooltips
• X3D Tooltips: field
• X3D Tooltips: fieldValue
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	DEFAULT_VALUE	Default value for this field type is an empty array.
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: MFString
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
MFString()	Constructor for MFString performs value initialization.
MFString(String newValue)	Constructor to parse String as new initial value.
MFString(String[] newValue)	Constructor for MFString using a corresponding Java primitive String[] array as new initial value.
MFString(MFString newValue)	Constructor to copy an MFString value as initial value for this new field object.
MFString(SFString newValue)	Utility constructor for MFString to assign a single SFString as new initial value.

Method Summary

Modifier and Type	Method	Description
void	append(String newValue)	Places new value(s) at the end of the existing value array, increasing the field length accordingly.
void	append(String[] newValue)	Appends another array at the end of the existing value array, increasing the field length accordingly.
MFString	append(MFString newValue)	Appends a new MFString to the end of the existing value array, increasing the field length accordingly.
MFString	append(SFString newValue)	Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
static String	cleanupEnumerationValue(String value)	Utility method for single enumeration value to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets to create an unadorned enumeration String.
MFString	cleanupEnumerationValues()	Modify current object values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets.
static String[]	cleanupEnumerationValues(String values)	Utility method for a single String containing multiple enumeration values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets to create unadorned MFString elements as a String[] array.
static String[]	cleanupEnumerationValues(String[] values)	Utility method for multiple enumeration values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets in a String[] array.
static ArrayList<String>	cleanupEnumerationValues(ArrayList<String> values)	Utility method for multiple enumeration values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets from a ArrayList of values.
MFString	cleanupUnescapedEnclosingQuotes()	Modify current object values to trim enclosing quotes and outer whitespace.
static String	cleanupUnescapedEnclosingQuotes(String singleValue)	Utility method to trim enclosing quotes and outer whitespace from an arbitrary String value, without removing escaped quotation marks (\").
static String[]	cleanupUnescapedEnclosingQuotes(String[] values)	Utility method to trim enclosing quotes and outer whitespace from elements in an arbitrary String[] array.
static ArrayList<String>	cleanupUnescapedEnclosingQuotes(ArrayList<String> values)	Utility method to trim enclosing quotes and outer whitespace from elements in an ArrayList of arbitrary String values.
void	clear()	Removes all values in the field array, changing the array size to zero.
boolean	equals(MFString comparisonMFString)	Determine whether two objects contain equal values.
String	get1Value(int index)	Get an individual value from the existing field array.
String[]	getPrimitiveValue()	Provides current value of the field as a Java primitive type.
void	getValue(String[] valueDestination)	Get the current value of this MFString by copying it into the valueDestination array, leaving the current object unchanged.
final void	initialize()	Initialization for MFString applies default initial value.
void	insertValue(int index, String newValue)	Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
static final boolean	isArray()	Whether or not this field type is an array (true)
boolean	isDefaultValue()	Determine whether current value matches DEFAULT_VALUE
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.
void	remove(int index)	Remove one SFString element of the field array at index position, if found.
void	set1Value(int index, String newValue)	Replace a single value at the appropriate location in the existing value array.
void	setValue(int size, String[] newValue)	Assign an array subset to this field.
void	setValue(String[] newValue)	Assign a new String[] value to this field.
MFString	setValue(MFString newValue)	Apply an MFString value to this field.
MFString	setValue(SFString newValue)	Assign a single-field SFString as new array value.
MFString	setValueByString(String newValue)	Utility accessor for MFString using String value
int	size()	Get the size of the underlying data array, meaning the number of simple SFString elements for the given data type.
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	toStringX3D()	Provide String representation of this object, properly escaped for XML-based X3D syntax and conforming to X3D Canonical Form.
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

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: MFString

See Also:

• Constant Field Values

DEFAULT_VALUE

public static final String[] DEFAULT_VALUE

Default value for this field type is an empty array.

See Also:

• Java Tutorials: Primitive Data Types

DEFAULT_VALUE_STRING

public static final String DEFAULT_VALUE_STRING

Default string value for this field type is "".

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

REGEX

public static final String REGEX

Default regular expression (regex) pattern for this field type is (\s|\S)*

See Also:

• PATTERN
• matches()
• matches(String)
• validate()
• X3D Regular Expressions: MFString
• Constant Field Values

PATTERN

public static final Pattern PATTERN

Precompiled regular expression (regex) pattern for this field type using default REGEX value.

See Also:

• REGEX
• matches()
• matches(String)
• validate()
• java.util.regex.Pattern

Constructor Details

MFString

public MFString()

Constructor for MFString performs value initialization.

MFString

public MFString(MFString newValue)

Constructor to copy an MFString value as initial value for this new field object.

Parameters:

newValue - The newValue to apply

MFString

public MFString(String[] newValue)

Constructor for MFString using a corresponding Java primitive String[] array as new initial value.

Parameters:

newValue - is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)

MFString

public MFString(String newValue)

Constructor to parse String as new initial value.

Parameters:

newValue - is new value to assign

MFString

public MFString(SFString newValue)

Utility constructor for MFString to assign a single SFString as new initial value.

Parameters:

newValue - is new value to assign

Method Details

isArray

public static final boolean isArray()

Whether or not this field type is an array (true)

Returns:

true if array type

initialize

public final void initialize()

Initialization for MFString 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

cleanupEnumerationValues

public MFString cleanupEnumerationValues()

Modify current object values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets.

Returns:

MFString - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).

See Also:

• cleanupUnescapedEnclosingQuotes()

cleanupEnumerationValue

public static String cleanupEnumerationValue(String value)

Utility method for single enumeration value to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets to create an unadorned enumeration String.

Parameters:

value - single enumeration string intended for use as an SFString or MFString value

Returns:

unquoted string values containing no whitespace as MFString list

See Also:

• cleanupUnescapedEnclosingQuotes(String)

cleanupEnumerationValues

public static String[] cleanupEnumerationValues(String values)

Utility method for a single String containing multiple enumeration values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets to create unadorned MFString elements as a String[] array.

Parameters:

values - zero or more enumeration values intended for use as an MFString list

Returns:

unquoted string values containing no whitespace as MFString list

See Also:

• cleanupUnescapedEnclosingQuotes(String)

cleanupEnumerationValues

public static String[] cleanupEnumerationValues(String[] values)

Utility method for multiple enumeration values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets in a String[] array.

Parameters:

values - zero or more enumeration values intended for use as an MFString list

Returns:

unquoted string values containing no whitespace as String[] array

See Also:

• cleanupEnumerationValue(String)
• cleanupEnumerationValues(String)
• cleanupUnescapedEnclosingQuotes(String)

cleanupEnumerationValues

public static ArrayList<String> cleanupEnumerationValues(ArrayList<String> values)

Utility method for multiple enumeration values to ignore all whitespace, remove all embedded quotes, remove all commas, and remove all square brackets from a ArrayList of values.

Parameters:

values - zero or more enumeration values intended for use as an MFString list

Returns:

unquoted string values containing no whitespace as MFString list

See Also:

• cleanupEnumerationValue(String)
• cleanupEnumerationValues(String)
• cleanupUnescapedEnclosingQuotes(String)

cleanupUnescapedEnclosingQuotes

public MFString cleanupUnescapedEnclosingQuotes()

Modify current object values to trim enclosing quotes and outer whitespace.

Returns:

MFString - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).

See Also:

• cleanupEnumerationValues()

cleanupUnescapedEnclosingQuotes

public static String cleanupUnescapedEnclosingQuotes(String singleValue)

Utility method to trim enclosing quotes and outer whitespace from an arbitrary String value, without removing escaped quotation marks (\").

Warning: do not use this method on a String that contains multiple quoted values, use cleanupEnumerationValues() instead.

Parameters:

singleValue - input String for use with MFString list, which must be unquoted

Returns:

unquoted String value

See Also:

• cleanupEnumerationValue(String)

cleanupUnescapedEnclosingQuotes

public static String[] cleanupUnescapedEnclosingQuotes(String[] values)

Utility method to trim enclosing quotes and outer whitespace from elements in an arbitrary String[] array.

Parameters:

values - String[] array for use with MFString list, which must be unquoted

Returns:

unquoted String[] array

See Also:

• cleanupUnescapedEnclosingQuotes(String)
• cleanupEnumerationValue(String)
• cleanupEnumerationValues(String)

cleanupUnescapedEnclosingQuotes

public static ArrayList<String> cleanupUnescapedEnclosingQuotes(ArrayList<String> values)

Utility method to trim enclosing quotes and outer whitespace from elements in an ArrayList of arbitrary String values.

Parameters:

values - existing ArrayList of String values for use with MFString list, which must be unquoted

Returns:

unquoted String[] array

See Also:

• cleanupUnescapedEnclosingQuotes(String)
• cleanupEnumerationValue(String)
• cleanupEnumerationValues(String)

equals

public boolean equals(MFString comparisonMFString)

Determine whether two objects contain equal values.

Parameters:

comparisonMFString - field type to compare

Returns:

true if equivalent, false otherwise

validate

public final String validate()

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:

• java.util.regex.Pattern
• validate()
• validateRegex()

validateRegex

public final 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(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 MFString setValueByString(String newValue)
                          throws InvalidFieldValueException

Utility accessor for MFString using String value

Parameters:

newValue - is new value to assign

Returns:

MFMatrix4d - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).

Throws:

InvalidFieldValueException

toString

public static String toString(String[] value)

Static utility method to provide String representation of a correctly typed input value.

Parameters:

value - The value to convert to a String

Returns:

XML/X3D-escaped String version of the provided value

See Also:

• X3D Tooltips: type
• SFString.toStringX3D(java.lang.String)
• toStringX3D()
• X3D Abstract Specification: 5.3.14 SFString and MFString
• X3D XML Encoding: 5.15 SFString and MFString
• X3D Tooltips: Text
• X3D Tooltips: type

toStringX3D

public String toStringX3D()

Provide String representation of this object, properly escaped for XML-based X3D syntax and conforming to X3D Canonical Form.

Returns:

XML/X3D-escaped String version of this object

See Also:

• SFString.toStringX3D(java.lang.String)
• SFString.toStringX3D(String)
• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D Tooltips: type MFString
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

getValue

public void getValue(String[] valueDestination)

Get the current value of this MFString by copying it into the valueDestination array, leaving the current object unchanged.

Specified by:

getValue in interface MFString

Parameters:

valueDestination - The array to be filled in with current field values.

getPrimitiveValue

public String[] getPrimitiveValue()

Provides current value of the field as a Java primitive type.

Returns:

current value

toString

public String toString()

Provides current value as a String.

Overrides:

toString in class Object

Returns:

String version of the provided value

See Also:

• X3D Tooltips: type MFString

get1Value

public String get1Value(int index)

Get an individual value from the existing field array.

If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

Specified by:

get1Value in interface MFString

Parameters:

index - is position of selected value in current array

Returns:

The selected value

Throws:

ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.

setValue

public void setValue(int size,
 String[] newValue)

Assign an array subset to this field.

Specified by:

setValue in interface MFString

Parameters:

size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.

newValue - The replacement value array to (potentially) slice and then assign.

See Also:

• X3DConcreteField.getTupleSize(String)

setValue

public void setValue(String[] newValue)

Assign a new String[] value to this field.

Parameters:

newValue - is replacement value array to assign

See Also:

• X3DConcreteField.getTupleSize(String)

setValue

public MFString setValue(SFString newValue)

Assign a single-field SFString as new array value.

Parameters:

newValue - The replacement value to assign.

Returns:

MFString - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).

set1Value

public void set1Value(int index,
 String newValue)
               throws ArrayIndexOutOfBoundsException

Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.

Specified by:

set1Value in interface MFString

Parameters:

index - is position of selected value in current array

newValue - provides new value to apply

Throws:

ArrayIndexOutOfBoundsException

See Also:

• X3DConcreteField.getTupleSize(String)

append

public void append(String newValue)

Places new value(s) at the end of the existing value array, increasing the field length accordingly.

Specified by:

append in interface MFString

Parameters:

newValue - The newValue to append

See Also:

• X3DConcreteField.getTupleSize(String)

append

public void append(String[] newValue)

Appends another array at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec4f tuple size of 4.

Parameters:

newValue - The newValue to append

See Also:

• X3DConcreteField.getTupleSize(String)

append

public MFString append(SFString newValue)

Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for incrementally constructing arrays.

Parameters:

newValue - The newValue to append

Returns:

MFString - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

append

public MFString append(MFString newValue)

Appends a new MFString to the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for constructing long arrays.

Parameters:

newValue - The newValue to append

Returns:

MFString - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3DConcreteField.getTupleSize(String)

insertValue

public void insertValue(int index,
 String newValue)

Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.

Specified by:

insertValue in interface MFString

Parameters:

index - The position for the inserted value in the current array

newValue - The newValue to insert

See Also:

• X3DConcreteField.getTupleSize(String)

size

public int size()

Get the size of the underlying data array, meaning the number of simple SFString elements for the given data type.

Specified by:

size in interface MField

Returns:

The number of SFString elements in this field array.

clear

public void clear()

Removes all values in the field array, changing the array size to zero.

Specified by:

clear in interface MField

remove

public void remove(int index)

Remove one SFString element of the field array at index position, if found. Initial element is at index 0.

Specified by:

remove in interface MField

Parameters:

index - position of element in field array that gets removed

setValue

public MFString setValue(MFString newValue)

Apply an MFString value to this field.

Parameters:

newValue - The newValue to apply

Returns:

MFString - 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