org.carewebframework.shell.help

Class HelpXmlParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

org.carewebframework.shell.BaseXmlParser

org.carewebframework.shell.help.HelpXmlParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

public class HelpXmlParser
extends BaseXmlParser

Spring xml configuration file parser extension. Supports the definition of help modules within the configuration file in a much more abbreviated fashion than would be required without the extension.

Field Summary

Fields inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
HelpXmlParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doParse(Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder builder)
static HelpModule	fromXml(String xml) Parses a help definition from an xml string.
protected Class<?>	getBeanClass(Element element)

Methods inherited from class org.carewebframework.shell.BaseXmlParser

addProperties, findTag, fromXml, getNodeName, getResourcePath, getTagChildren

Methods inherited from class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

doParse, getBeanClassName, getParentName, parseInternal

Methods inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

parse, postProcessComponentDefinition, registerBeanDefinition, resolveId, shouldFireEvents, shouldGenerateId, shouldGenerateIdAsFallback, shouldParseNameAsAliases

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpXmlParser

public HelpXmlParser()

Method Detail

getBeanClass

protected Class<?> getBeanClass(Element element)

Overrides:

getBeanClass in class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

doParse

protected void doParse(Element element,
           org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Overrides:

doParse in class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

fromXml

public static HelpModule fromXml(String xml)
                          throws Exception

Parses a help definition from an xml string.

Parameters:

xml - XML containing help definition.

Returns:

A help definition instance.

Throws:

Exception - Unspecified exception.