info.magnolia.module.model.reader

Class LightModuleDefinitionReader.LightModuleVersionHandler

java.lang.Object

info.magnolia.module.model.reader.LightModuleDefinitionReader.LightModuleVersionHandler

All Implemented Interfaces:

ModuleVersionHandler

Enclosing class:

LightModuleDefinitionReader

public static final class LightModuleDefinitionReader.LightModuleVersionHandler
extends Object
implements ModuleVersionHandler

ModuleVersionHandler that doesn't do a thing, not even register a module version in JCR. This is what we want because light modules are volatile and shouldn't clutter the repository.

Constructor Summary

Constructors

Constructor and Description
LightModuleVersionHandler()

Method Summary

Modifier and Type	Method and Description
Version	getCurrentlyInstalled(InstallContext ctx) Gets the currently installed version number of this module.
List<Delta>	getDeltas(InstallContext installContext, Version from) Returns the deltas to be applied to update from the given Version from to the current one.
Delta	getStartupDelta(InstallContext ctx) Returns a Delta that needs to be executed always before this module is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

LightModuleVersionHandler

public LightModuleVersionHandler()

Method Detail

getCurrentlyInstalled

public Version getCurrentlyInstalled(InstallContext ctx)

Description copied from interface: ModuleVersionHandler

Gets the currently installed version number of this module.

Specified by:

getCurrentlyInstalled in interface ModuleVersionHandler

getDeltas

public List<Delta> getDeltas(InstallContext installContext,
                             Version from)

Description copied from interface: ModuleVersionHandler

Returns the deltas to be applied to update from the given Version from to the current one. If from is null, it means the module is being installed, and we should thus return the necessary deltas to install it. It is also responsible for updating the current version number of the module, wherever it is stored.

Specified by:

getDeltas in interface ModuleVersionHandler

getStartupDelta

public Delta getStartupDelta(InstallContext ctx)

Description copied from interface: ModuleVersionHandler

Returns a Delta that needs to be executed always before this module is started. These tasks will be silently applied at startup.

Specified by:

getStartupDelta in interface ModuleVersionHandler

Parameters:

ctx - InstallContext