Package org.ametys.core.migration

Record Class MigrationEngine.MigrationComponent

java.lang.Object

java.lang.Record

org.ametys.core.migration.MigrationEngine.MigrationComponent

Record Components:

id - the component id

internal - if this component is used for internal migration data

pluginName - the component's plugin

featureName - the component's feature

versionHandlerType - the VersionHandler type

versionHandler - the VersionHandler

versionStorage - the VersionStorage

versionConfiguration - the specific VersionConfiguration created by the associated VersionHandler

initialization - the initialization action, if any

upgrades - all actions defined for uprades

Enclosing class:

MigrationEngine

public static record MigrationEngine.MigrationComponent(String id, boolean internal, String pluginName, String featureName, String versionHandlerType, VersionHandler versionHandler, VersionStorage versionStorage, VersionConfiguration versionConfiguration, ActionConfiguration initialization, List<ActionConfiguration> upgrades)
extends Record

A migration component represents a versioned feature set

Constructor Summary

Constructors

Constructor	Description
MigrationComponent(String id, boolean internal, String pluginName, String featureName, String versionHandlerType, VersionHandler versionHandler, VersionStorage versionStorage, VersionConfiguration versionConfiguration, ActionConfiguration initialization, List<ActionConfiguration> upgrades)	Creates an instance of a MigrationComponent record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	featureName()	Returns the value of the featureName record component.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
ActionConfiguration	initialization()	Returns the value of the initialization record component.
boolean	internal()	Returns the value of the internal record component.
String	pluginName()	Returns the value of the pluginName record component.
final String	toString()	Returns a string representation of this record class.
List<ActionConfiguration>	upgrades()	Returns the value of the upgrades record component.
VersionConfiguration	versionConfiguration()	Returns the value of the versionConfiguration record component.
VersionHandler	versionHandler()	Returns the value of the versionHandler record component.
String	versionHandlerType()	Returns the value of the versionHandlerType record component.
VersionStorage	versionStorage()	Returns the value of the versionStorage record component.

Methods inherited from class java.lang.Object

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

Constructor Details

MigrationComponent

public MigrationComponent(String id,
 boolean internal,
 String pluginName,
 String featureName,
 String versionHandlerType,
 VersionHandler versionHandler,
 VersionStorage versionStorage,
 VersionConfiguration versionConfiguration,
 ActionConfiguration initialization,
 List<ActionConfiguration> upgrades)

Creates an instance of a MigrationComponent record class.

Parameters:

id - the value for the id record component

internal - the value for the internal record component

pluginName - the value for the pluginName record component

featureName - the value for the featureName record component

versionHandlerType - the value for the versionHandlerType record component

versionHandler - the value for the versionHandler record component

versionStorage - the value for the versionStorage record component

versionConfiguration - the value for the versionConfiguration record component

initialization - the value for the initialization record component

upgrades - the value for the upgrades record component

Method Details

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

internal

public boolean internal()

Returns the value of the internal record component.

Returns:

the value of the internal record component

pluginName

public String pluginName()

Returns the value of the pluginName record component.

Returns:

the value of the pluginName record component

featureName

public String featureName()

Returns the value of the featureName record component.

Returns:

the value of the featureName record component

versionHandlerType

public String versionHandlerType()

Returns the value of the versionHandlerType record component.

Returns:

the value of the versionHandlerType record component

versionHandler

public VersionHandler versionHandler()

Returns the value of the versionHandler record component.

Returns:

the value of the versionHandler record component

versionStorage

public VersionStorage versionStorage()

Returns the value of the versionStorage record component.

Returns:

the value of the versionStorage record component

versionConfiguration

public VersionConfiguration versionConfiguration()

Returns the value of the versionConfiguration record component.

Returns:

the value of the versionConfiguration record component

initialization

public ActionConfiguration initialization()

Returns the value of the initialization record component.

Returns:

the value of the initialization record component

upgrades

public List<ActionConfiguration> upgrades()

Returns the value of the upgrades record component.

Returns:

the value of the upgrades record component