Package com.inductiveautomation.ignition.gateway.storeforward.flavor

Class DefaultFlavorContainer<T extends PersistentData>

java.lang.Object

com.inductiveautomation.ignition.gateway.storeforward.flavor.DefaultFlavorContainer<T>

Type Parameters:

T - a subclass of PersistentData that is relevant to this flavor container

All Implemented Interfaces:

FlavorContainer<T>, PersistentFlavor<T>

public final class DefaultFlavorContainer<T extends PersistentData>
extends Object
implements FlavorContainer<T>

A default implementation of the FlavorContainer interface that stores a set of flavors. The container itself is a PersistentFlavor.

Constructor Summary

Constructors

Constructor	Description
DefaultFlavorContainer(String signature, LocalizedString description, PersistentSerializer<T,?> serializer, @Nullable SystemIdentifier systemType)	Creates a new default flavor container with the given signature, description, serializer, and optional system type.

Method Summary

Modifier and Type	Method	Description
void	addFlavor(PersistentFlavor<? extends T> flavor)	Adds a PersistentFlavor to this container.
Collection<PersistentFlavor<? extends T>>	childFlavors()	Returns the data linked to this PersistentFlavor.
static <T extends PersistentData> DefaultFlavorContainer<T>	createWithFlavors(String signature, LocalizedString description, SystemIdentifier systemType, Class<T> type, PersistentFlavor<? extends T>... flavors)	Creates a new DefaultFlavorContainer with the given flavors.
Class<T>	dataClass()	Returns the T PersistentData class that this flavor is associated with.
LocalizedString	description()	Returns a localized description of this flavor.
boolean	equals(Object o)
int	hashCode()
void	removeFlavor(PersistentFlavor<? extends T> flavor)	Removes a PersistentFlavor from this container.
PersistentSerializer<T,?>	serializer()	Returns a serializer suitable for this flavor.
String	signature()	Returns a unique signature for this flavor.
Optional<SystemIdentifier>	systemType()	Returns the system type identifier for this flavor, if available.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultFlavorContainer

public DefaultFlavorContainer(String signature,
 LocalizedString description,
 PersistentSerializer<T,?> serializer,
 @Nullable SystemIdentifier systemType)

Creates a new default flavor container with the given signature, description, serializer, and optional system type.

Parameters:

signature - The signature of this container.

description - A localized description of this container.

serializer - The serializer used to serialize / deserialize data belonging to this flavor.

systemType - The system type associated with this container, or null if none is specified.

Method Details

signature

public String signature()

Description copied from interface: PersistentFlavor

Returns a unique signature for this flavor.

Specified by:

signature in interface PersistentFlavor<T extends PersistentData>

Returns:

a String representing the flavor's signature

description

public LocalizedString description()

Description copied from interface: PersistentFlavor

Returns a localized description of this flavor.

Specified by:

description in interface PersistentFlavor<T extends PersistentData>

Returns:

a LocalizedString providing a description

serializer

public PersistentSerializer<T,?> serializer()

Description copied from interface: PersistentFlavor

Returns a serializer suitable for this flavor.

Specified by:

serializer in interface PersistentFlavor<T extends PersistentData>

Returns:

a GenericDeserializer capable of handling T instances

systemType

public Optional<SystemIdentifier> systemType()

Description copied from interface: PersistentFlavor

Returns the system type identifier for this flavor, if available.

Specified by:

systemType in interface PersistentFlavor<T extends PersistentData>

Returns:

an Optional containing the SystemIdentifier, or empty if not applicable

dataClass

public Class<T> dataClass()

Description copied from interface: PersistentFlavor

Returns the T PersistentData class that this flavor is associated with.

Specified by:

dataClass in interface PersistentFlavor<T extends PersistentData>

Returns:

the PersistentData class that is associated with this flavor

childFlavors

public Collection<PersistentFlavor<? extends T>> childFlavors()

Returns the data linked to this PersistentFlavor. In this case, the data is the set of PersistentFlavors.

Specified by:

childFlavors in interface FlavorContainer<T extends PersistentData>

Returns:

The set of all flavors

addFlavor

public void addFlavor(PersistentFlavor<? extends T> flavor)

Adds a PersistentFlavor to this container.

Parameters:

flavor - The flavor to be added

removeFlavor

public void removeFlavor(PersistentFlavor<? extends T> flavor)

Removes a PersistentFlavor from this container.

Parameters:

flavor - The flavor to be removed

createWithFlavors

@SafeVarargs
public static <T extends PersistentData>
DefaultFlavorContainer<T> createWithFlavors(String signature,
 LocalizedString description,
 SystemIdentifier systemType,
 Class<T> type,
 PersistentFlavor<? extends T>... flavors)

Creates a new DefaultFlavorContainer with the given flavors.

Type Parameters:

T - a subclass of PersistentData that is relevant to this flavor container

Parameters:

signature - the signature of the container

description - the description of the container

systemType - the system identifier of the container

type - the class of the persistent data that can use this flavor container

flavors - the flavors to add to the container

Returns:

a new DefaultFlavorContainer with the given flavors

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object