info.magnolia.module.model.reader

Class LightModuleDefinitionReader

java.lang.Object

info.magnolia.module.model.reader.LightModuleDefinitionReader

All Implemented Interfaces:

ModuleDefinitionReader

@Singleton
public class LightModuleDefinitionReader
extends Object
implements ModuleDefinitionReader

LightModuleDefinitionReader is capable of finding and reading the light module definitions. The following assumptions/requirements must hold for successful resolution of such definitions:

• light module descriptor file must have the name module.yaml
• light module descriptor file must contain YAML data which follows the structure of LightModuleDefinitionReader.LightModuleDefinition

Note: unless specified explicitly the name of the light module is assigned with the name of the descriptor file's parent directory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LightModuleDefinitionReader.LightModuleDefinition Similar to ModuleDefinition this class supports only a sub-set of usual module definition properties.
static class	LightModuleDefinitionReader.LightModuleDependencyDefinition DependencyDefinition targeted for light module definitions.
static class	LightModuleDefinitionReader.LightModuleVersionHandler ModuleVersionHandler that doesn't do a thing, not even register a module version in JCR.

Constructor Summary

Constructors

Constructor and Description
LightModuleDefinitionReader(MagnoliaConfigurationProperties configurationProperties, Map2BeanTransformer map2BeanTransformer)

Method Summary

Modifier and Type	Method and Description
ModuleDefinition	read(Reader in)
Map<String,ModuleDefinition>	readAll() Reads all found module definitions.
ModuleDefinition	readFromResource(String resourcePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

LightModuleDefinitionReader

@Inject
public LightModuleDefinitionReader(MagnoliaConfigurationProperties configurationProperties,
                                           Map2BeanTransformer map2BeanTransformer)

Method Detail

readAll

public Map<String,ModuleDefinition> readAll()
                                     throws ModuleManagementException

Description copied from interface: ModuleDefinitionReader

Reads all found module definitions.

Specified by:

readAll in interface ModuleDefinitionReader

Returns:

a Map where the key is the module name.

Throws:

ModuleManagementException

read

public ModuleDefinition read(Reader in)
                      throws ModuleManagementException

Specified by:

read in interface ModuleDefinitionReader

Throws:

ModuleManagementException

readFromResource

public ModuleDefinition readFromResource(String resourcePath)
                                  throws ModuleManagementException

Specified by:

readFromResource in interface ModuleDefinitionReader

Throws:

ModuleManagementException