info.magnolia.module.model
Class ModuleDefinition

java.lang.Object
  extended by info.magnolia.module.model.ModuleDefinition

public class ModuleDefinition
extends Object

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

Version:
$Revision: $ ($Author: $)
Author:
gjoseph

Constructor Summary
ModuleDefinition()
           
ModuleDefinition(String name, Version version, String className, Class<? extends ModuleVersionHandler> versionHandler)
           
 
Method Summary
 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 setDescription(String description)
           
 void setDisplayName(String displayName)
           
 void setName(String name)
           
 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()

addDependency

public void addDependency(DependencyDefinition dep)

getServlets

public Collection<ServletDefinition> getServlets()

addServlet

public void addServlet(ServletDefinition def)

getRepositories

public Collection<RepositoryDefinition> getRepositories()

addRepository

public void addRepository(RepositoryDefinition repository)

getProperties

public Collection<PropertyDefinition> getProperties()

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


Copyright © 2003-2012 Magnolia International Ltd.. All Rights Reserved.