info.magnolia.module.model

Class ModuleDefinition

java.lang.Object

info.magnolia.module.model.ModuleDefinition

public class ModuleDefinition
extends Object

Describes a module. Bean representation of a module's xml descriptor.

Constructor Summary

Constructors

Constructor and Description
ModuleDefinition()
ModuleDefinition(String name, Version version, String className, Class<? extends ModuleVersionHandler> versionHandler)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addComponents(ComponentsDefinition components)
void	addDependency(DependencyDefinition dep)
void	addProperty(PropertyDefinition property)
void	addRepository(RepositoryDefinition repository)
void	addServlet(ServletDefinition def)
String	getClassName()
Collection<ComponentsDefinition>	getComponents()
Collection<DependencyDefinition>	getDependencies()
String	getDescription()
String	getDisplayName() Returns the displayName or the name if displayName wasn't set.
String	getName()
Collection<PropertyDefinition>	getProperties()
String	getProperty(String propertyName) Convenience method which returns the value of the given property, or null if it does not exist.
Collection<RepositoryDefinition>	getRepositories()
Collection<ServletDefinition>	getServlets()
Version	getVersion()
Class<? extends ModuleVersionHandler>	getVersionHandler()
void	setClassName(String className)
void	setComponents(Collection<ComponentsDefinition> components)
void	setDependencies(Collection<DependencyDefinition> dependencies)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setName(String name)
void	setProperties(Collection<PropertyDefinition> properties)
void	setRepositories(Collection<RepositoryDefinition> repositories)
void	setServlets(Collection<ServletDefinition> servlets)
void	setVersion(Version version)
void	setVersionHandler(Class<? extends ModuleVersionHandler> versionHandler)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDefinition

public ModuleDefinition()

ModuleDefinition

public ModuleDefinition(String name,
                Version version,
                String className,
                Class<? extends ModuleVersionHandler> versionHandler)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getDisplayName

public String getDisplayName()

Returns the displayName or the name if displayName wasn't set.

setDisplayName

public void setDisplayName(String displayName)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getClassName

public String getClassName()

setClassName

public void setClassName(String className)

getVersionHandler

public Class<? extends ModuleVersionHandler> getVersionHandler()

setVersionHandler

public void setVersionHandler(Class<? extends ModuleVersionHandler> versionHandler)

setVersion

public void setVersion(Version version)

getVersion

public Version getVersion()

getDependencies

public Collection<DependencyDefinition> getDependencies()

setDependencies

public void setDependencies(Collection<DependencyDefinition> dependencies)

addDependency

public void addDependency(DependencyDefinition dep)

getServlets

public Collection<ServletDefinition> getServlets()

setServlets

public void setServlets(Collection<ServletDefinition> servlets)

addServlet

public void addServlet(ServletDefinition def)

getRepositories

public Collection<RepositoryDefinition> getRepositories()

setRepositories

public void setRepositories(Collection<RepositoryDefinition> repositories)

addRepository

public void addRepository(RepositoryDefinition repository)

getProperties

public Collection<PropertyDefinition> getProperties()

setProperties

public void setProperties(Collection<PropertyDefinition> properties)

addProperty

public void addProperty(PropertyDefinition property)

getComponents

public Collection<ComponentsDefinition> getComponents()

setComponents

public void setComponents(Collection<ComponentsDefinition> components)

addComponents

public boolean addComponents(ComponentsDefinition components)

getProperty

public String getProperty(String propertyName)

Convenience method which returns the value of the given property, or null if it does not exist.

toString

public String toString()

Overrides:

toString in class Object