Package org.ametys.plugins.repository.data.holder.values

Class SynchronizationContext

java.lang.Object

org.ametys.plugins.repository.data.holder.values.SynchronizationContext

Direct Known Subclasses:

ContentSynchronizationContext

public class SynchronizationContext
extends Object

Object that gives some context for values synchronization

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SynchronizationContext()	Creates a new instance of a SynchronizationContext

Method Summary

Modifier and Type	Method	Description
boolean	forceStatusIfNotPresent()	Determines if the status has to be forced if there is no status yet This case can happen if a data is newly externalizable
Map<String,Object>	getExternalizableDataContext()	Retrieves the context Map that is used to determine if a data is externalizable
ExternalizableDataProvider.ExternalizableDataStatus	getStatusToSynchronize()	Determines which values (locals or externals) have to be synchronized
boolean	ignoreIncompatibleValues()	Determines if values that are incompatible with their data type (defined in model) have to be ignored If false (default behavior), a BadItemTypeException is thrown if a value to synchronize is incompatible with its type If true, such values are ignored.
static SynchronizationContext	newInstance()	Creates a new instance of a SynchronizationContext
boolean	useDefaultFromModel()	Checks if synchronization has to use the default value from the model
SynchronizationContext	withDefaultFromModel(boolean useDefaultFromModel)	Set to true to use the default value from the model (default to false)
SynchronizationContext	withExternalizableDataContextEntry(String entryKey, Object entryValue)	Add an entry in the context Map that is used to determine if a data is externalizable
SynchronizationContext	withIncompatibleValuesIgnored(boolean ignoreIncompatibleValues)	Set to true to ignore values that are incompatible with their data type (defined in model) (default to false
SynchronizationContext	withStatus(ExternalizableDataProvider.ExternalizableDataStatus externalizableDataStatus)	Sets the status to determine which values (locals or externals) have to be synchronized (default to local)
SynchronizationContext	withStatusForcedIfNotPresent(boolean forceStatusIfNotPresent)	Set to false if the status has not to be forced (default to true)

Methods inherited from class java.lang.Object

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

Constructor Details

SynchronizationContext

protected SynchronizationContext()

Creates a new instance of a SynchronizationContext

Method Details

newInstance

public static SynchronizationContext newInstance()

Creates a new instance of a SynchronizationContext

Returns:

the created instance

useDefaultFromModel

public boolean useDefaultFromModel()

Checks if synchronization has to use the default value from the model

Returns:

true to use the default value from the model, false otherwise

withDefaultFromModel

public SynchronizationContext withDefaultFromModel(boolean useDefaultFromModel)

Set to true to use the default value from the model (default to false)

Parameters:

useDefaultFromModel - true to use the default value from the model, false otherwise

Returns:

the current SynchronizationContext

getStatusToSynchronize

public ExternalizableDataProvider.ExternalizableDataStatus getStatusToSynchronize()

Determines which values (locals or externals) have to be synchronized

Returns:

the status of the value to synchronize

withStatus

public SynchronizationContext withStatus(ExternalizableDataProvider.ExternalizableDataStatus externalizableDataStatus)

Sets the status to determine which values (locals or externals) have to be synchronized (default to local)

Parameters:

externalizableDataStatus - the status to determine which values have to be synchronized

Returns:

the current SynchronizationContext

getExternalizableDataContext

public Map<String,Object> getExternalizableDataContext()

Retrieves the context Map that is used to determine if a data is externalizable

Returns:

the context Map

withExternalizableDataContextEntry

public SynchronizationContext withExternalizableDataContextEntry(String entryKey,
 Object entryValue)

Add an entry in the context Map that is used to determine if a data is externalizable

Parameters:

entryKey - the key of the entry

entryValue - the value of the entry

Returns:

the current SynchronizationContext

forceStatusIfNotPresent

public boolean forceStatusIfNotPresent()

Determines if the status has to be forced if there is no status yet This case can happen if a data is newly externalizable

Returns:

true if the status has to be forced, false otherwise

withStatusForcedIfNotPresent

public SynchronizationContext withStatusForcedIfNotPresent(boolean forceStatusIfNotPresent)

Set to false if the status has not to be forced (default to true)

Parameters:

forceStatusIfNotPresent - true to force the status if it is not yet present, false otherwise

Returns:

the current SynchronizationContext

ignoreIncompatibleValues

public boolean ignoreIncompatibleValues()

Determines if values that are incompatible with their data type (defined in model) have to be ignored If false (default behavior), a BadItemTypeException is thrown if a value to synchronize is incompatible with its type If true, such values are ignored. No exception is thrown

Returns:

true if incompatible values have to be ignored, false otherwise

withIncompatibleValuesIgnored

public SynchronizationContext withIncompatibleValuesIgnored(boolean ignoreIncompatibleValues)

Set to true to ignore values that are incompatible with their data type (defined in model) (default to false

Parameters:

ignoreIncompatibleValues - true to ignore incompatible values, false otherwise

Returns:

the current SynchronizationContext