Package org.nuxeo.runtime.migration

Class MigrationDescriptor

java.lang.Object

org.nuxeo.runtime.migration.MigrationDescriptor

All Implemented Interfaces:

Descriptor

public class MigrationDescriptor
extends Object
implements Descriptor

Descriptor of a Migration, consisting of States and Steps.

Since:

9.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MigrationDescriptor.MigrationStateDescriptor
static class	MigrationDescriptor.MigrationStepDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
String	defaultState
String	description
String	descriptionLabel
String	id
Class<?>	klass
Map<String,MigrationDescriptor.MigrationStateDescriptor>	states
Map<String,MigrationDescriptor.MigrationStepDescriptor>	steps

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
MigrationDescriptor()

Method Summary

Modifier and Type	Method	Description
String	getDefaultState()
String	getDescription()
String	getDescriptionLabel()
String	getId()	The descriptor id, descriptors with same id are merged.
Class<?>	getKlass()
Map<String,MigrationDescriptor.MigrationStateDescriptor>	getStates()
Map<String,MigrationDescriptor.MigrationStepDescriptor>	getSteps()
Descriptor	merge(Descriptor o)	Returns a descriptor representing other merged into this

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove

Field Details

id

public String id

descriptionLabel

public String descriptionLabel

description

public String description

klass

public Class<?> klass

defaultState

public String defaultState

states

public Map<String,MigrationDescriptor.MigrationStateDescriptor> states

steps

public Map<String,MigrationDescriptor.MigrationStepDescriptor> steps

Constructor Details

MigrationDescriptor

public MigrationDescriptor()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

getDescriptionLabel

public String getDescriptionLabel()

getDescription

public String getDescription()

getKlass

public Class<?> getKlass()

getDefaultState

public String getDefaultState()

getStates

public Map<String,MigrationDescriptor.MigrationStateDescriptor> getStates()

getSteps

public Map<String,MigrationDescriptor.MigrationStepDescriptor> getSteps()

merge

public Descriptor merge(Descriptor o)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor