ar.com.jmfsg.documentation
Class DocumentationLoader

java.lang.Object
  ar.com.jmfsg.documentation.DocumentationLoader

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class DocumentationLoader
extends Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

Loads all DocumentationDescriptor with the actual documentation information.

Author:

jformoso

Constructor Summary

DocumentationLoader()

Method Summary

void	addDocumentationDescriptor(String beanName, DocumentationDescriptor documentationDescriptor)
void	addDocumentationListener(DocumentationListener listener)
void	afterPropertiesSet()
Map<String,String>	getDictionary()
Map<String,List<Method>>	getDocumentation()
List<Method>	getDocumentationForModule(String prefix)
General	getGeneral()
Map<String,Group>	getGroups()
net.sf.json.JSONObject	getRawDoc()
Map<String,Tag>	getTags()
boolean	hasDocumentationDescriptor(String beanName)
static String	readAll(org.springframework.core.io.Resource res)
void	setApplicationContext(org.springframework.context.ApplicationContext ctx)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationLoader

public DocumentationLoader()

Method Detail

getDocumentationForModule

public List<Method> getDocumentationForModule(String prefix)

getDocumentation

public Map<String,List<Method>> getDocumentation()

hasDocumentationDescriptor

public boolean hasDocumentationDescriptor(String beanName)

addDocumentationDescriptor

public void addDocumentationDescriptor(String beanName,
                                       DocumentationDescriptor documentationDescriptor)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext ctx)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

readAll

public static String readAll(org.springframework.core.io.Resource res)
                      throws IOException

Throws:

IOException

getGeneral

public General getGeneral()

getRawDoc

public net.sf.json.JSONObject getRawDoc()

getDictionary

public Map<String,String> getDictionary()

getGroups

public Map<String,Group> getGroups()

getTags

public Map<String,Tag> getTags()

addDocumentationListener

public void addDocumentationListener(DocumentationListener listener)