|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.infinispan.tools.doclet.html.HtmlGenerator org.infinispan.tools.doclet.config.AbstractConfigHtmlGenerator
public abstract class AbstractConfigHtmlGenerator
Field Summary | |
---|---|
protected static String |
CONFIG_REF
|
protected static String |
CONFIG_REF_DESC_ATT
|
protected static String |
CONFIG_REF_NAME_ATT
|
protected static String |
CONFIG_REF_PARENT_NAME_ATT
|
protected com.sun.javadoc.RootDoc |
rootDoc
|
protected StringBuilder |
sb
|
Constructor Summary | |
---|---|
AbstractConfigHtmlGenerator(String encoding,
String title,
String bottom,
String footer,
String header,
String metaDescription,
List<String> metaKeywords)
|
Method Summary | |
---|---|
protected void |
extractConfigurationDocComments(AnnotatedElement e,
Map<String,String> m,
ConfigurationDoc cd)
|
protected Map<String,String> |
findDescription(AnnotatedElement e)
|
protected com.sun.javadoc.Doc |
findDocElement(Class<?> c,
String elementName)
|
protected Field |
findField(Class<?> clazz,
String name)
|
protected String |
generateContents()
|
protected void |
generateHeaderForConfigurationElement(StringBuilder sb,
XMLTreeOutputWalker tw,
TreeNode n)
|
protected void |
generateTableRowForAttribute(com.sun.xml.xsom.XSAttributeDecl a,
StringBuilder sb,
Object beanClassInstance)
|
protected InputStream |
getAsInputStreamFromClassLoader(String filename)
|
protected abstract List<Class<?>> |
getConfigBeans()
|
com.sun.javadoc.RootDoc |
getRootDoc()
|
protected abstract String |
getRootElementName()
Name of the root element in the schema |
protected abstract String |
getSchemaFile()
Returns name of the schema file. |
protected StringBuilder |
getStringBuilder()
|
protected String |
getTitle()
|
InputStream |
lookupFile(String filename)
|
protected boolean |
postVisitNode(TreeNode n)
Callback invoked after visiting the specified node n. |
protected void |
postXMLTableOfContentsCreate(XSOMSchemaTreeWalker w,
XMLTreeOutputWalker tw)
Invoked after creation of XML tree table of contents for configuration elements in schema |
protected boolean |
preVisitNode(TreeNode n)
Callback invoked prior to visiting the specified node n. |
protected void |
preXMLTableOfContentsCreate(XSOMSchemaTreeWalker sw,
XMLTreeOutputWalker tw)
Invoked prior to creation of XML tree table of contents for configuration elements in schema |
void |
setRootDoc(com.sun.javadoc.RootDoc rootDoc)
|
Methods inherited from class org.infinispan.tools.doclet.html.HtmlGenerator |
---|
generateHtml, generateHtml, isValid |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String CONFIG_REF
protected static final String CONFIG_REF_NAME_ATT
protected static final String CONFIG_REF_PARENT_NAME_ATT
protected static final String CONFIG_REF_DESC_ATT
protected com.sun.javadoc.RootDoc rootDoc
protected StringBuilder sb
Constructor Detail |
---|
public AbstractConfigHtmlGenerator(String encoding, String title, String bottom, String footer, String header, String metaDescription, List<String> metaKeywords)
Method Detail |
---|
protected abstract List<Class<?>> getConfigBeans() throws Exception
Exception
protected abstract String getSchemaFile()
Note that schema file should be placed on a classpath.
protected abstract String getRootElementName()
protected void preXMLTableOfContentsCreate(XSOMSchemaTreeWalker sw, XMLTreeOutputWalker tw)
sw
- tw
- protected void postXMLTableOfContentsCreate(XSOMSchemaTreeWalker w, XMLTreeOutputWalker tw)
sw
- tw
- protected boolean preVisitNode(TreeNode n)
n
-
protected boolean postVisitNode(TreeNode n)
n
-
protected String getTitle()
public com.sun.javadoc.RootDoc getRootDoc()
public void setRootDoc(com.sun.javadoc.RootDoc rootDoc)
public InputStream lookupFile(String filename)
protected InputStream getAsInputStreamFromClassLoader(String filename)
protected StringBuilder getStringBuilder()
protected String generateContents()
generateContents
in class HtmlGenerator
protected void generateTableRowForAttribute(com.sun.xml.xsom.XSAttributeDecl a, StringBuilder sb, Object beanClassInstance)
protected void generateHeaderForConfigurationElement(StringBuilder sb, XMLTreeOutputWalker tw, TreeNode n)
protected Field findField(Class<?> clazz, String name)
protected Map<String,String> findDescription(AnnotatedElement e)
protected void extractConfigurationDocComments(AnnotatedElement e, Map<String,String> m, ConfigurationDoc cd)
protected com.sun.javadoc.Doc findDocElement(Class<?> c, String elementName)
|
--> | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |