Package com.inductiveautomation.ignition.common.resourcecollection

Class ResourceCollectionDiff

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionDiff

Direct Known Subclasses:

ResourceCollectionDiff.AbsoluteDiff, ResourceCollectionDiff.EffectiveDiff

public abstract class ResourceCollectionDiff
extends Object

The ChangeOperations associated with a resource collection when pulled from the Gateway.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResourceCollectionDiff.AbsoluteDiff	An absolute diff, i.e.
static final class	ResourceCollectionDiff.EffectiveDiff	An effective diff, i.e.

Method Summary

Modifier and Type	Method	Description
List<ChangeOperation>	getChangeOperations()
String	getResourceCollectionName()
boolean	isAbsoluteDiff()
boolean	isEffectiveDiff()
boolean	isEmpty()
static ResourceCollectionDiff.AbsoluteDiff	newAbsoluteDiff(String resourceCollectionName, List<ChangeOperation> changeOperations)	Create an ResourceCollectionDiff.AbsoluteDiff.
static ResourceCollectionDiff.EffectiveDiff	newEffectiveDiff(String resourceCollectionName, List<ChangeOperation> changeOperations)	Create an ResourceCollectionDiff.EffectiveDiff.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

isEmpty

public boolean isEmpty()

Returns:

true if this diff has an empty ChangeOperation list.

getResourceCollectionName

public String getResourceCollectionName()

Returns:

the name of the project this diff applies to.

getChangeOperations

public List<ChangeOperation> getChangeOperations()

Returns:

the list of ChangeOperations comprising this diff.

isAbsoluteDiff

public boolean isAbsoluteDiff()

Returns:

true if this diff is an ResourceCollectionDiff.AbsoluteDiff.

isEffectiveDiff

public boolean isEffectiveDiff()

Returns:

true if this diff is an ResourceCollectionDiff.EffectiveDiff.

toString

public String toString()

Overrides:

toString in class Object

newAbsoluteDiff

public static ResourceCollectionDiff.AbsoluteDiff newAbsoluteDiff(String resourceCollectionName,
 List<ChangeOperation> changeOperations)

Create an ResourceCollectionDiff.AbsoluteDiff.

Parameters:

resourceCollectionName - the name of the collection the diff applies to.

changeOperations - the list of ChangeOperations.

Returns:

an ResourceCollectionDiff.AbsoluteDiff.

See Also:

• ResourceCollectionDiff.AbsoluteDiff

newEffectiveDiff

public static ResourceCollectionDiff.EffectiveDiff newEffectiveDiff(String resourceCollectionName,
 List<ChangeOperation> changeOperations)

Create an ResourceCollectionDiff.EffectiveDiff.

Parameters:

resourceCollectionName - the name of the collection the diff applies to.

changeOperations - the list of ChangeOperations.

Returns:

an ResourceCollectionDiff.EffectiveDiff.

See Also:

• ResourceCollectionDiff.EffectiveDiff