Record Class ResourceCollectionManifest
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionManifest
- Record Components:
title- Title of the resource collectiondescription- Description of the resource collectionenabled- Whether the resource collection is enabledinheritable- Whether other resource collections can have this one as a parentparent- Optional parent resource collection, null or empty meaning no parent.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionResourceCollectionManifest(String title, String description, boolean enabled, boolean inheritable, @Nullable String parent) Creates an instance of aResourceCollectionManifestrecord class. -
Method Summary
Modifier and TypeMethodDescriptioncopy()Create a copy of thisResourceCollectionManifest.copy(Consumer<ResourceCollectionManifest.Builder> consumer) Create a copy of thisResourceCollectionManifest, allowing for modifications to take place prior via the consumedResourceCollectionManifest.Builder.@NonNull StringReturns the value of thedescriptionrecord component.booleanenabled()Returns the value of theenabledrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanReturns the value of theinheritablerecord component.Create a newResourceCollectionManifest.Builder.@NonNull Stringparent()Returns the value of theparentrecord component.@NonNull Stringtitle()Returns the value of thetitlerecord component.final StringtoString()Returns a string representation of this record class.
-
Field Details
-
PROJECT_MANIFEST_FILE_NAME
- See Also:
-
CONFIG_MANIFEST_FILE_NAME
- See Also:
-
-
Constructor Details
-
ResourceCollectionManifest
public ResourceCollectionManifest(String title, String description, boolean enabled, boolean inheritable, @Nullable String parent) Creates an instance of aResourceCollectionManifestrecord class.- Parameters:
title- the value for thetitlerecord componentdescription- the value for thedescriptionrecord componentenabled- the value for theenabledrecord componentinheritable- the value for theinheritablerecord componentparent- the value for theparentrecord component
-
-
Method Details
-
title
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
parent
-
copy
Create a copy of thisResourceCollectionManifest.- Returns:
- a copy of this
ResourceCollectionManifest.
-
copy
Create a copy of thisResourceCollectionManifest, allowing for modifications to take place prior via the consumedResourceCollectionManifest.Builder.- Parameters:
consumer- theResourceCollectionManifest.Builderconsumer.- Returns:
- a copy of this
ResourceCollectionManifest.
-
toBuilder
- Returns:
- a new
ResourceCollectionManifest.Builderpre-set with all the values from thisResourceCollectionManifest.
-
newBuilder
Create a newResourceCollectionManifest.Builder.- Returns:
- a new
ResourceCollectionManifest.Builder.
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
enabled
-
inheritable
public boolean inheritable()Returns the value of theinheritablerecord component.- Returns:
- the value of the
inheritablerecord component
-