Package com.inductiveautomation.ignition.common.resourcecollection

Class ResourceCollectionChangeEvent

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionChangeEvent

public class ResourceCollectionChangeEvent
extends Object

Represents a change event in a resource collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ResourceCollectionChangeEvent.ChangeType

Constructor Summary

Constructors

Constructor	Description
ResourceCollectionChangeEvent(ResourceCollectionChangeEvent.ChangeType changeType, String name)
ResourceCollectionChangeEvent(ResourceCollectionChangeEvent.ChangeType changeType, String name, @Nullable Object contextObject)

Method Summary

Modifier and Type	Method	Description
static ResourceCollectionChangeEvent	added(String name)	Create a new ResourceCollectionChangeEvent representing an added resource collection.
static ResourceCollectionChangeEvent	deleted(String name)	Create a new ResourceCollectionChangeEvent representing a deleted resource collection.
ResourceCollectionChangeEvent.ChangeType	getChangeType()
Optional<Object>	getContextObject()
String	getName()

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceCollectionChangeEvent

public ResourceCollectionChangeEvent(ResourceCollectionChangeEvent.ChangeType changeType,
 String name)

ResourceCollectionChangeEvent

public ResourceCollectionChangeEvent(ResourceCollectionChangeEvent.ChangeType changeType,
 String name,
 @Nullable
 @Nullable Object contextObject)

Method Details

getChangeType

public ResourceCollectionChangeEvent.ChangeType getChangeType()

Returns:

the type of change that occurred

getName

public String getName()

Returns:

the name of the resource collection that was changed

getContextObject

public Optional<Object> getContextObject()

Returns:

the context object associated with the change, if any was provided in the push operation. If no context object was provided, or this change was caused by something other than a push operation (e.g. a filesystem scan) this will return an empty Optional.

added

public static ResourceCollectionChangeEvent added(String name)

Create a new ResourceCollectionChangeEvent representing an added resource collection.

deleted

public static ResourceCollectionChangeEvent deleted(String name)

Create a new ResourceCollectionChangeEvent representing a deleted resource collection.