Class ProjectManifest
- java.lang.Object
-
- com.inductiveautomation.ignition.common.project.ProjectManifest
-
- All Implemented Interfaces:
java.io.Serializable
public class ProjectManifest extends java.lang.Object implements java.io.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 java.lang.String
PROJECT_MANIFEST_FILE_NAME
-
Constructor Summary
Constructors Constructor Description ProjectManifest(java.lang.String title, java.lang.String description, boolean enabled, boolean inheritable, java.lang.String parent)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ProjectManifest
copy()
Create a copy of thisProjectManifest
.ProjectManifest
copy(java.util.function.Consumer<ProjectManifest.Builder> consumer)
Create a copy of thisProjectManifest
, allowing for modifications to take place prior via the consumedProjectManifest.Builder
.boolean
equals(java.lang.Object o)
static ProjectManifest
fromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)
Decode aJsonElement
containing aProjectManifest
.static ProjectManifest
fromJson(java.lang.String json)
Decode a String containing a JSON-encodedProjectManifest
.java.lang.String
getDescription()
java.lang.String
getParent()
java.lang.String
getTitle()
int
hashCode()
boolean
isEnabled()
boolean
isInheritable()
static ProjectManifest.Builder
newBuilder()
Create a newProjectManifest.Builder
.ProjectManifest.Builder
toBuilder()
Create a newProjectManifest.Builder
pre-set with all the values from thisProjectManifest
.static com.inductiveautomation.ignition.common.gson.JsonObject
toGson(ProjectManifest manifest)
Encode aProjectManifest
into aJsonObject
.static java.lang.String
toJson(ProjectManifest manifest)
Encode aProjectManifest
into a pretty-printed JSON String.
-
-
-
Field Detail
-
PROJECT_MANIFEST_FILE_NAME
public static final java.lang.String PROJECT_MANIFEST_FILE_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getTitle
@Nonnull public java.lang.String getTitle()
-
getDescription
@Nonnull public java.lang.String getDescription()
-
getParent
@Nonnull public java.lang.String getParent()
-
isEnabled
public boolean isEnabled()
-
isInheritable
public boolean isInheritable()
-
copy
public ProjectManifest copy()
Create a copy of thisProjectManifest
.- Returns:
- a copy of this
ProjectManifest
.
-
copy
public ProjectManifest copy(java.util.function.Consumer<ProjectManifest.Builder> consumer)
Create a copy of thisProjectManifest
, allowing for modifications to take place prior via the consumedProjectManifest.Builder
.- Parameters:
consumer
- theProjectManifest.Builder
consumer.- Returns:
- a copy of this
ProjectManifest
.
-
toBuilder
public ProjectManifest.Builder toBuilder()
Create a newProjectManifest.Builder
pre-set with all the values from thisProjectManifest
.- Returns:
- a new
ProjectManifest.Builder
pre-set with all the values from thisProjectManifest
.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
fromGson
public static ProjectManifest fromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)
Decode aJsonElement
containing aProjectManifest
.- Parameters:
json
- aJsonElement
containing a JSON-encodedProjectManifest
.- Returns:
- a
ProjectManifest
.
-
fromJson
public static ProjectManifest fromJson(java.lang.String json)
Decode a String containing a JSON-encodedProjectManifest
.- Parameters:
json
- a String containing a JSON-encodedProjectManifest
.- Returns:
- a
ProjectManifest
decoded fromjson
.
-
toGson
public static com.inductiveautomation.ignition.common.gson.JsonObject toGson(ProjectManifest manifest)
Encode aProjectManifest
into aJsonObject
.- Parameters:
manifest
- theProjectManifest
to encode.- Returns:
- a
JsonObject
containing a JSON-encodedProjectManifest
.
-
toJson
public static java.lang.String toJson(ProjectManifest manifest)
Encode aProjectManifest
into a pretty-printed JSON String.- Parameters:
manifest
- theProjectManifest
to encode.- Returns:
- a pretty-printed JSON String encoding of
manifest
.
-
newBuilder
public static ProjectManifest.Builder newBuilder()
Create a newProjectManifest.Builder
.- Returns:
- a new
ProjectManifest.Builder
.
-
-