Package com.inductiveautomation.ignition.common.resourcecollection

Class ResourceId

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.ResourceId

All Implemented Interfaces:

Serializable

public class ResourceId
extends Object
implements Serializable

Unique ID for a resource, containing the resource collection name, module id, type id, and folder path.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	collectionName
protected ResourcePath	resourcePath

Constructor Summary

Constructors

Constructor	Description
ResourceId(String resourceCollectionName, ResourcePath resourcePath)
ResourceId(String resourceCollectionName, ResourceType resourceType, String path)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getFolderPath()	Shortcut for getResourcePath().getPath().toString()
String	getResourceCollectionName()
ResourcePath	getResourcePath()
ResourceType	getResourceType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

collectionName

protected String collectionName

resourcePath

protected ResourcePath resourcePath

Constructor Details

ResourceId

public ResourceId(String resourceCollectionName,
 ResourceType resourceType,
 String path)

ResourceId

public ResourceId(String resourceCollectionName,
 ResourcePath resourcePath)

Method Details

getResourceCollectionName

public String getResourceCollectionName()

getResourceType

public ResourceType getResourceType()

getResourcePath

public ResourcePath getResourcePath()

Returns:

The resource path, which is the resource type id + folder path.

getFolderPath

public String getFolderPath()

Shortcut for getResourcePath().getPath().toString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object