Package com.inductiveautomation.ignition.common.document

Class ExtendedDocument

java.lang.Object

com.inductiveautomation.ignition.common.document.DocumentElement

com.inductiveautomation.ignition.common.document.Document

com.inductiveautomation.ignition.common.document.ExtendedDocument

All Implemented Interfaces:

java.io.Serializable

public class ExtendedDocument
extends Document

Allows cloning a Document without having to create a deep copy of all it's elements. This is managed by tracking all modifications to a delegate Document instead of applying those modifications directly to the Document. If extend(com.inductiveautomation.ignition.common.document.Document) is called on an ExtendedDocument the delegate Document is reused and modifications are copied to the new ExtendedDocument.

It's extremely important that the delegate Document is never modified. In cases where the delegate Document might change, Document.deepCopy() should be used instead.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.document.Document

members

Method Summary

Modifier and Type	Method	Description
void	add(java.lang.String property, DocumentElement value)	Adds a member, which is a name-value pair, to self.
void	addProperty(java.lang.String property, java.lang.Object value)
Document	deepCopy()	Creates a deep copy of this element and all its children
java.util.Set<java.util.Map.Entry<java.lang.String,DocumentElement>>	entrySet()	Returns a set of members of this object.
static Document	extend(Document document)
DocumentElement	get(java.lang.String memberName)	Returns the member with the specified name.
Document	getAsDocument(java.lang.String memberName)	Convenience method to get the specified member as a Document.
DocumentArray	getAsDocumentArray(java.lang.String memberName)	Convenience method to get the specified member as a JsonArray.
DocumentPrimitive	getAsDocumentPrimitive(java.lang.String memberName)	Convenience method to get the specified member as a JsonPrimitive element.
boolean	has(java.lang.String memberName)	Convenience method to check if a member with the specified name is present in this object.
java.util.Set<java.lang.String>	keySet()	Returns a set of members key values.
DocumentElement	remove(java.lang.String property)	Removes the property from this Document.
int	size()	Returns the number of key/value pairs in the object.
protected java.util.Set<java.util.Map.Entry<java.lang.String,DocumentElement>>	unsafeEntrySet()

Methods inherited from class com.inductiveautomation.ignition.common.document.Document

add, add, add, add, equals, hashCode, toJsonElement

Methods inherited from class com.inductiveautomation.ignition.common.document.DocumentElement

fromJson, getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsByte, getAsCharacter, getAsDocument, getAsDocumentArray, getAsDocumentNull, getAsDocumentPrimitive, getAsDouble, getAsFloat, getAsInt, getAsLong, getAsNumber, getAsShort, getAsString, isDocument, isDocumentArray, isDocumentNull, isDocumentPrimitive, toString, toStringNoIndent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

extend

public static Document extend(Document document)

deepCopy

public Document deepCopy()

Description copied from class: Document

Creates a deep copy of this element and all its children

Overrides:

deepCopy in class Document

unsafeEntrySet

protected java.util.Set<java.util.Map.Entry<java.lang.String,DocumentElement>> unsafeEntrySet()

Overrides:

unsafeEntrySet in class Document

add

public void add(java.lang.String property,
                DocumentElement value)

Description copied from class: Document

Adds a member, which is a name-value pair, to self. The name must be a String, but the value can be an arbitrary DocumentElement, thereby allowing you to build a full tree of DocumentElements rooted at this node.

Overrides:

add in class Document

Parameters:

property - name of the member.

value - the member object.

remove

public DocumentElement remove(java.lang.String property)

Description copied from class: Document

Removes the property from this Document.

Overrides:

remove in class Document

Parameters:

property - name of the member that should be removed.

Returns:

the DocumentElement object that is being removed.

addProperty

public void addProperty(java.lang.String property,
                        java.lang.Object value)

Overrides:

addProperty in class Document

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,DocumentElement>> entrySet()

Description copied from class: Document

Returns a set of members of this object. The set is ordered, and the order is in which the elements were added.

Overrides:

entrySet in class Document

Returns:

a set of members of this object.

keySet

public java.util.Set<java.lang.String> keySet()

Description copied from class: Document

Returns a set of members key values.

Overrides:

keySet in class Document

Returns:

a set of member keys as Strings

size

public int size()

Description copied from class: Document

Returns the number of key/value pairs in the object.

Overrides:

size in class Document

Returns:

the number of key/value pairs in the object.

has

public boolean has(java.lang.String memberName)

Description copied from class: Document

Convenience method to check if a member with the specified name is present in this object.

Overrides:

has in class Document

Parameters:

memberName - name of the member that is being checked for presence.

Returns:

true if there is a member with the specified name, false otherwise.

get

public DocumentElement get(java.lang.String memberName)

Description copied from class: Document

Returns the member with the specified name.

Overrides:

get in class Document

Parameters:

memberName - name of the member that is being requested.

Returns:

the member matching the name. Null if no such member exists.

getAsDocumentPrimitive

public DocumentPrimitive getAsDocumentPrimitive(java.lang.String memberName)

Description copied from class: Document

Convenience method to get the specified member as a JsonPrimitive element.

Overrides:

getAsDocumentPrimitive in class Document

Parameters:

memberName - name of the member being requested.

Returns:

the JsonPrimitive corresponding to the specified member.

getAsDocumentArray

public DocumentArray getAsDocumentArray(java.lang.String memberName)

Description copied from class: Document

Convenience method to get the specified member as a JsonArray.

Overrides:

getAsDocumentArray in class Document

Parameters:

memberName - name of the member being requested.

Returns:

the JsonArray corresponding to the specified member.

getAsDocument

public Document getAsDocument(java.lang.String memberName)

Description copied from class: Document

Convenience method to get the specified member as a Document.

Overrides:

getAsDocument in class Document

Parameters:

memberName - name of the member being requested.

Returns:

the Document corresponding to the specified member.