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

Class ProjectResourceManifest

java.lang.Object

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

public class ProjectResourceManifest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectResourceManifest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	RESOURCE_MANIFEST_FILE_NAME
static int	RESOURCE_VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static ProjectResourceManifest	fromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)	Decode a JsonElement into a ProjectResourceManifest.
static ProjectResourceManifest	fromJson(java.lang.String json)	Decode a String containing a JSON-encoded ProjectResourceManifest.
java.util.Map<java.lang.String,com.inductiveautomation.ignition.common.gson.JsonElement>	getAttributes()
java.lang.String	getDocumentation()
java.util.List<java.lang.String>	getFiles()
java.lang.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 java.lang.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 Detail

RESOURCE_VERSION

public static final int RESOURCE_VERSION

See Also:

Constant Field Values

RESOURCE_MANIFEST_FILE_NAME

public static final java.lang.String RESOURCE_MANIFEST_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

ProjectResourceManifest

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

Method Detail

getScope

public java.lang.String getScope()

getVersion

public int getVersion()

getDocumentation

public java.lang.String getDocumentation()

isRestricted

public boolean isRestricted()

isOverridable

public boolean isOverridable()

getFiles

public java.util.List<java.lang.String> getFiles()

getAttributes

public java.util.Map<java.lang.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(java.lang.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 java.lang.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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object