Package com.inductiveautomation.ignition.common.project

Class ProjectManifest

java.lang.Object

com.inductiveautomation.ignition.common.project.ProjectManifest

All Implemented Interfaces:

Serializable

public class ProjectManifest
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectManifest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROJECT_MANIFEST_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
ProjectManifest(String title, String description, boolean enabled, boolean inheritable, String parent)

Method Summary

Modifier and Type	Method	Description
ProjectManifest	copy()	Create a copy of this ProjectManifest.
ProjectManifest	copy(Consumer<ProjectManifest.Builder> consumer)	Create a copy of this ProjectManifest, allowing for modifications to take place prior via the consumed ProjectManifest.Builder.
boolean	equals(Object o)
static ProjectManifest	fromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)	Decode a JsonElement containing a ProjectManifest.
static ProjectManifest	fromJson(String json)	Decode a String containing a JSON-encoded ProjectManifest.
String	getDescription()
String	getParent()
String	getTitle()
int	hashCode()
boolean	isEnabled()
boolean	isInheritable()
static ProjectManifest.Builder	newBuilder()	Create a new ProjectManifest.Builder.
ProjectManifest.Builder	toBuilder()	Create a new ProjectManifest.Builder pre-set with all the values from this ProjectManifest.
static com.inductiveautomation.ignition.common.gson.JsonObject	toGson(ProjectManifest manifest)	Encode a ProjectManifest into a JsonObject.
static String	toJson(ProjectManifest manifest)	Encode a ProjectManifest into a pretty-printed JSON String.

Methods inherited from class java.lang.Object

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

Field Details

PROJECT_MANIFEST_FILE_NAME

public static final String PROJECT_MANIFEST_FILE_NAME

See Also:

• Constant Field Values

Constructor Details

ProjectManifest

public ProjectManifest(String title,
 String description,
 boolean enabled,
 boolean inheritable,
 String parent)

Method Details

getTitle

@Nonnull
public String getTitle()

getDescription

@Nonnull
public String getDescription()

getParent

@Nonnull
public String getParent()

isEnabled

public boolean isEnabled()

isInheritable

public boolean isInheritable()

copy

public ProjectManifest copy()

Create a copy of this ProjectManifest.

Returns:

a copy of this ProjectManifest.

copy

public ProjectManifest copy(Consumer<ProjectManifest.Builder> consumer)

Create a copy of this ProjectManifest, allowing for modifications to take place prior via the consumed ProjectManifest.Builder.

Parameters:

consumer - the ProjectManifest.Builder consumer.

Returns:

a copy of this ProjectManifest.

toBuilder

public ProjectManifest.Builder toBuilder()

Create a new ProjectManifest.Builder pre-set with all the values from this ProjectManifest.

Returns:

a new ProjectManifest.Builder pre-set with all the values from this ProjectManifest.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromGson

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

Decode a JsonElement containing a ProjectManifest.

Parameters:

json - a JsonElement containing a JSON-encoded ProjectManifest.

Returns:

a ProjectManifest.

fromJson

public static ProjectManifest fromJson(String json)

Decode a String containing a JSON-encoded ProjectManifest.

Parameters:

json - a String containing a JSON-encoded ProjectManifest.

Returns:

a ProjectManifest decoded from json.

toGson

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

Encode a ProjectManifest into a JsonObject.

Parameters:

manifest - the ProjectManifest to encode.

Returns:

a JsonObject containing a JSON-encoded ProjectManifest.

toJson

public static String toJson(ProjectManifest manifest)

Encode a ProjectManifest into a pretty-printed JSON String.

Parameters:

manifest - the ProjectManifest to encode.

Returns:

a pretty-printed JSON String encoding of manifest.

newBuilder

public static ProjectManifest.Builder newBuilder()

Create a new ProjectManifest.Builder.

Returns:

a new ProjectManifest.Builder.