Package com.inductiveautomation.ignition.common.project

Class ProjectDiff

java.lang.Object

com.inductiveautomation.ignition.common.project.ProjectDiff

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ProjectDiff.AbsoluteDiff, ProjectDiff.EffectiveDiff

public abstract class ProjectDiff
extends Object
implements Serializable

The ChangeOperations associated with a project when pulled from the Gateway.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
List<ChangeOperation>	getChangeOperations()
String	getProjectName()
boolean	isAbsoluteDiff()
boolean	isEffectiveDiff()
boolean	isEmpty()
static ProjectDiff.AbsoluteDiff	newAbsoluteDiff(String projectName, List<ChangeOperation> changeOperations)	Create an ProjectDiff.AbsoluteDiff.
static ProjectDiff.EffectiveDiff	newEffectiveDiff(String projectName, List<ChangeOperation> changeOperations)	Create an ProjectDiff.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.

getProjectName

public String getProjectName()

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 ProjectDiff.AbsoluteDiff.

isEffectiveDiff

public boolean isEffectiveDiff()

Returns:

true if this diff is an ProjectDiff.EffectiveDiff.

toString

public String toString()

Overrides:

toString in class Object

newAbsoluteDiff

public static ProjectDiff.AbsoluteDiff newAbsoluteDiff(String projectName,
 List<ChangeOperation> changeOperations)

Create an ProjectDiff.AbsoluteDiff.

Parameters:

projectName - the name of the project the diff applies to.

changeOperations - the list of ChangeOperations.

Returns:

an ProjectDiff.AbsoluteDiff.

See Also:

• ProjectDiff.AbsoluteDiff

newEffectiveDiff

public static ProjectDiff.EffectiveDiff newEffectiveDiff(String projectName,
 List<ChangeOperation> changeOperations)

Create an ProjectDiff.EffectiveDiff.

Parameters:

projectName - the name of the project the diff applies to.

changeOperations - the list of ChangeOperations.

Returns:

an ProjectDiff.EffectiveDiff.

See Also:

• ProjectDiff.EffectiveDiff