Package com.inductiveautomation.ignition.common.project.resource

Class ProjectResourceId

java.lang.Object

com.inductiveautomation.ignition.common.project.resource.ProjectResourceId

All Implemented Interfaces:

java.io.Serializable

public class ProjectResourceId
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	projectName
protected ResourcePath	resourcePath

Constructor Summary

Constructors

Constructor	Description
ProjectResourceId(java.lang.String project, ResourcePath resourcePath)
ProjectResourceId(java.lang.String project, ResourceType resourceType, java.lang.String path)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static ProjectResourceId	fromJson(com.inductiveautomation.ignition.common.gson.JsonElement e)
java.lang.String	getFolderPath()	Shortcut for getResourcePath().getPath().toString()
java.lang.String	getProjectName()
ResourcePath	getResourcePath()
ResourceType	getResourceType()
int	hashCode()
com.inductiveautomation.ignition.common.gson.JsonObject	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

projectName

protected java.lang.String projectName

resourcePath

protected ResourcePath resourcePath

Constructor Detail

ProjectResourceId

public ProjectResourceId(java.lang.String project,
                         ResourceType resourceType,
                         java.lang.String path)

ProjectResourceId

public ProjectResourceId(java.lang.String project,
                         ResourcePath resourcePath)

Method Detail

getProjectName

public java.lang.String getProjectName()

getResourceType

public ResourceType getResourceType()

getResourcePath

public ResourcePath getResourcePath()

Returns:

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

getFolderPath

public java.lang.String getFolderPath()

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJson

public com.inductiveautomation.ignition.common.gson.JsonObject toJson()

fromJson

public static ProjectResourceId fromJson(com.inductiveautomation.ignition.common.gson.JsonElement e)