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

Class ProjectResourceManifest

java.lang.Object

com.inductiveautomation.ignition.common.project.resource.ProjectResourceManifest

public class ProjectResourceManifest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectResourceManifest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESOURCE_MANIFEST_FILE_NAME
static final int	RESOURCE_VERSION

Constructor Summary

Constructors

Constructor	Description
ProjectResourceManifest(String scope, String documentation, int version, boolean restricted, boolean overridable, Set<String> files, Map<String,com.inductiveautomation.ignition.common.gson.JsonElement> attributes)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ProjectResourceManifest	fromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)	Decode a JsonElement into a ProjectResourceManifest.
static ProjectResourceManifest	fromJson(String json)	Decode a String containing a JSON-encoded ProjectResourceManifest.
Map<String,com.inductiveautomation.ignition.common.gson.JsonElement>	getAttributes()
String	getDocumentation()
List<String>	getFiles()
String	getScope()
int	getVersion()
int	hashCode()
boolean	isOverridable()
boolean	isRestricted()
static ProjectResourceManifest.Builder	newBuilder()	Create a new ProjectResourceManifest.Builder.
static com.inductiveautomation.ignition.common.gson.JsonObject	toGson(ProjectResourceManifest manifest)	Encode a ProjectResourceManifest into a JsonObject.
static String	toJson(ProjectResourceManifest manifest)	Encode a ProjectResourceManifest into a pretty-printed JSON String.

Methods inherited from class java.lang.Object

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

Field Details

RESOURCE_VERSION

public static final int RESOURCE_VERSION

See Also:

• Constant Field Values

RESOURCE_MANIFEST_FILE_NAME

public static final String RESOURCE_MANIFEST_FILE_NAME

See Also:

• Constant Field Values

Constructor Details

ProjectResourceManifest

public ProjectResourceManifest(String scope,
 String documentation,
 int version,
 boolean restricted,
 boolean overridable,
 Set<String> files,
 Map<String,com.inductiveautomation.ignition.common.gson.JsonElement> attributes)

Method Details

getScope

public String getScope()

getVersion

public int getVersion()

getDocumentation

public String getDocumentation()

isRestricted

public boolean isRestricted()

isOverridable

public boolean isOverridable()

getFiles

public List<String> getFiles()

getAttributes

public Map<String,com.inductiveautomation.ignition.common.gson.JsonElement> getAttributes()

fromGson

public static ProjectResourceManifest fromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)

Decode a JsonElement into a ProjectResourceManifest.

Parameters:

json - a JsonElement containing a JSON-encoded ProjectResourceManifest.

Returns:

a ProjectResourceManifest.

fromJson

public static ProjectResourceManifest fromJson(String json)

Decode a String containing a JSON-encoded ProjectResourceManifest.

Parameters:

json - a String containing a JSON-encoded ProjectResourceManifest.

Returns:

a ProjectResourceManifest decoded from json.

toGson

public static com.inductiveautomation.ignition.common.gson.JsonObject toGson(ProjectResourceManifest manifest)

Encode a ProjectResourceManifest into a JsonObject.

Parameters:

manifest - the ProjectResourceManifest to encode.

Returns:

a JsonObject containing a JSON-encoded ProjectResourceManifest.

toJson

public static String toJson(ProjectResourceManifest manifest)

Encode a ProjectResourceManifest into a pretty-printed JSON String.

Parameters:

manifest - the ProjectResourceManifest to encode.

Returns:

a pretty-printed JSON String encoding of manifest.

newBuilder

public static ProjectResourceManifest.Builder newBuilder()

Create a new ProjectResourceManifest.Builder.

Returns:

a new ProjectResourceManifest.Builder.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object