Package com.inductiveautomation.ignition.common.resourcecollection

Record Class ResourceCollectionManifest

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.common.resourcecollection.ResourceCollectionManifest

Record Components:

title - Title of the resource collection

description - Description of the resource collection

enabled - Whether the resource collection is enabled

inheritable - Whether other resource collections can have this one as a parent

parent - Optional parent resource collection, null or empty meaning no parent.

public record ResourceCollectionManifest(String title, String description, boolean enabled, boolean inheritable, @Nullable String parent)
extends Record

Contains the metadata for an entire resource collection, including inheritance linkage information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceCollectionManifest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_MANIFEST_FILE_NAME
static final String	PROJECT_MANIFEST_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
ResourceCollectionManifest(String title, String description, boolean enabled, boolean inheritable, String parent)	Creates an instance of a ResourceCollectionManifest record class.

Method Summary

Modifier and Type	Method	Description
ResourceCollectionManifest	copy()	Create a copy of this ResourceCollectionManifest.
ResourceCollectionManifest	copy(Consumer<ResourceCollectionManifest.Builder> consumer)	Create a copy of this ResourceCollectionManifest, allowing for modifications to take place prior via the consumed ResourceCollectionManifest.Builder.
String	description()	Returns the value of the description record component.
boolean	enabled()	Returns the value of the enabled record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	inheritable()	Returns the value of the inheritable record component.
static ResourceCollectionManifest.Builder	newBuilder()	Create a new ResourceCollectionManifest.Builder.
String	parent()	Returns the value of the parent record component.
String	title()	Returns the value of the title record component.
ResourceCollectionManifest.Builder	toBuilder()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

PROJECT_MANIFEST_FILE_NAME

public static final String PROJECT_MANIFEST_FILE_NAME

See Also:

• Constant Field Values

CONFIG_MANIFEST_FILE_NAME

public static final String CONFIG_MANIFEST_FILE_NAME

See Also:

• Constant Field Values

Constructor Details

ResourceCollectionManifest

public ResourceCollectionManifest(String title,
 String description,
 boolean enabled,
 boolean inheritable,
 @Nullable
 String parent)

Creates an instance of a ResourceCollectionManifest record class.

Parameters:

title - the value for the title record component

description - the value for the description record component

enabled - the value for the enabled record component

inheritable - the value for the inheritable record component

parent - the value for the parent record component

Method Details

title

@Nonnull
public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

description

@Nonnull
public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

parent

@Nonnull
public String parent()

Returns the value of the parent record component.

Returns:

the value of the parent record component

copy

public ResourceCollectionManifest copy()

Create a copy of this ResourceCollectionManifest.

Returns:

a copy of this ResourceCollectionManifest.

copy

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

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

Parameters:

consumer - the ResourceCollectionManifest.Builder consumer.

Returns:

a copy of this ResourceCollectionManifest.

toBuilder

public ResourceCollectionManifest.Builder toBuilder()

Returns:

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

newBuilder

public static ResourceCollectionManifest.Builder newBuilder()

Create a new ResourceCollectionManifest.Builder.

Returns:

a new ResourceCollectionManifest.Builder.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

enabled

public boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component

inheritable

public boolean inheritable()

Returns the value of the inheritable record component.

Returns:

the value of the inheritable record component