public class VariableCollection
extends java.lang.Object
implements java.lang.Iterable
To learn more, visit the Work with Document Properties documentation article.
Remarks:
Variable names and values are strings.
Variable names are case-insensitive.
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
| Modifier and Type | Method and Description |
|---|---|
void |
add(java.lang.String name,
java.lang.String value)
Adds a document variable to the collection.
|
void |
clear()
Removes all elements from the collection.
|
boolean |
contains(java.lang.String name)
Determines whether the collection contains a document variable with the given name.
|
java.lang.String |
get(int index)
Gets a document variable at the specified index.
|
java.lang.String |
get(java.lang.String name)
|
int |
getCount()
Gets the number of elements contained in the collection.
|
int |
indexOfKey(java.lang.String name)
Returns the zero-based index of the specified document variable in the collection.
|
java.util.Iterator |
iterator()
Returns an enumerator object that can be used to iterate over all variable in the collection.
|
void |
remove(java.lang.String name)
Removes a document variable with the specified name from the collection.
|
void |
removeAt(int index)
Removes a document variable at the specified index.
|
void |
set(int index,
java.lang.String value)
Sets a document variable at the specified index.
|
void |
set(java.lang.String name,
java.lang.String value)
|
public int getCount()
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
public java.lang.String get(java.lang.String name)
null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
String value.public void set(java.lang.String name,
java.lang.String value)
null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
value - The corresponding String value.public java.lang.String get(int index)
null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
index - Zero-based index of the document variable.public void set(int index,
java.lang.String value)
null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
index - Zero-based index of the document variable.value - A document variable at the specified index.public java.util.Iterator iterator()
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
iterator in interface java.lang.Iterablepublic void add(java.lang.String name,
java.lang.String value)
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
name - The case-insensitive name of the variable to add.value - The value of the variable. The value cannot be null, if value is null empty string will be used instead.public boolean contains(java.lang.String name)
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
name - Case-insensitive name of the document variable to locate.true if item is found in the collection; otherwise, false.public int indexOfKey(java.lang.String name)
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
name - The case-insensitive name of the variable.public void remove(java.lang.String name)
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
name - The case-insensitive name of the variable.public void removeAt(int index)
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);
index - The zero based index.public void clear()
Examples:
Shows how to work with a document's variable collection.
Document doc = new Document();
VariableCollection variables = doc.getVariables();
// Every document has a collection of key/value pair variables, which we can add items to.
variables.add("Home address", "123 Main St.");
variables.add("City", "London");
variables.add("Bedrooms", "3");
Assert.assertEquals(3, variables.getCount());
// We can display the values of variables in the document body using DOCVARIABLE fields.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
field.setVariableName("Home address");
field.update();
Assert.assertEquals("123 Main St.", field.getResult());
// Assigning values to existing keys will update them.
variables.add("Home address", "456 Queen St.");
// We will then have to update DOCVARIABLE fields to ensure they display an up-to-date value.
Assert.assertEquals("123 Main St.", field.getResult());
field.update();
Assert.assertEquals("456 Queen St.", field.getResult());
// Verify that the document variables with a certain name or value exist.
Assert.assertTrue(variables.contains("City"));
Assert.assertTrue(IterableUtils.matchesAny(variables, s -> s.getValue() == "London"));
// The collection of variables automatically sorts variables alphabetically by name.
Assert.assertEquals(0, variables.indexOfKey("Bedrooms"));
Assert.assertEquals(1, variables.indexOfKey("City"));
Assert.assertEquals(2, variables.indexOfKey("Home address"));
// Below are three ways of removing document variables from a collection.
// 1 - By name:
variables.remove("City");
Assert.assertFalse(variables.contains("City"));
// 2 - By index:
variables.removeAt(1);
Assert.assertFalse(variables.contains("Home address"));
// 3 - Clear the whole collection at once:
variables.clear();
Assert.assertEquals(variables.getCount(), 0);