org.x4o.xml.eld.doc.api.dom

Class ApiDoc

java.lang.Object

org.x4o.xml.eld.doc.api.dom.ApiDoc

public class ApiDoc
extends Object

ApiDoc holds all config and data to write a full api doc structure.

Version:

1.0 May 12, 2013

Author:

Willem Cazander

Constructor Summary

Constructors

Constructor and Description
ApiDoc()

Method Summary

Methods

Modifier and Type	Method and Description
ApiDocConcept	addConcept(ApiDocConcept concept)
void	addDocKeyword(String keyword)
void	addDocKeywordAll(Collection<String> keywords)
ApiDocPage	addDocPage(ApiDocPage page)
ApiDocNodeWriter	addNodeBodyWriter(ApiDocNodeWriter writer)
Class<?>	addTreeNodeClassExclude(Class<?> excludeClass)
void	checkModel()
void	createDocCopyright(String owner) Creates default copyright message for owner.
ApiDocPage	findDocPageById(String docPageId)
List<ApiDocConcept>	getConcepts()
String	getDescription()
String	getDocAbout()
String	getDocCopyright()
List<String>	getDocKeywords()
List<ApiDocPage>	getDocPages()
Class<?>	getFrameNavConceptClass()
Boolean	getFrameNavOverviewPrintParent()
Boolean	getFrameNavPrintParent()
Boolean	getFrameNavPrintParentId()
Boolean	getFrameNavPrintParentParent()
String	getName()
List<ApiDocNodeWriter>	getNodeBodyWriters()
ApiDocNode	getRootNode()
ApiDocNode	getRootNodeTreePage()
List<Class<?>>	getTreeNodeClassExcludes()
boolean	removeConcept(ApiDocConcept concept)
boolean	removeDocKeyword(String keyword)
boolean	removeDocPage(ApiDocPage page)
boolean	removeNodeBodyWriter(ApiDocNodeWriter writer)
boolean	removeTreeNodeClassExclude(Class<?> excludeClass)
void	setDescription(String description)
void	setDocAbout(String docAbout)
void	setDocCopyright(String docCopyright)
void	setFrameNavConceptClass(Class<?> frameNavConceptClass)
void	setFrameNavOverviewPrintParent(Boolean frameNavOverviewPrintParent)
void	setFrameNavPrintParent(Boolean frameNavPrintParent)
void	setFrameNavPrintParentId(Boolean frameNavPrintParentId)
void	setFrameNavPrintParentParent(Boolean frameNavPrintParentParent)
void	setName(String name)
void	setRootNode(ApiDocNode rootNode)
void	setRootNodeTreePage(ApiDocNode rootNodeTreePage)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDoc

public ApiDoc()

Method Detail

checkModel

public void checkModel()
                throws NullPointerException,
                       IllegalArgumentException

Throws:

NullPointerException

IllegalArgumentException

addNodeBodyWriter

public ApiDocNodeWriter addNodeBodyWriter(ApiDocNodeWriter writer)

removeNodeBodyWriter

public boolean removeNodeBodyWriter(ApiDocNodeWriter writer)

getNodeBodyWriters

public List<ApiDocNodeWriter> getNodeBodyWriters()

addConcept

public ApiDocConcept addConcept(ApiDocConcept concept)

removeConcept

public boolean removeConcept(ApiDocConcept concept)

getConcepts

public List<ApiDocConcept> getConcepts()

addDocKeyword

public void addDocKeyword(String keyword)

addDocKeywordAll

public void addDocKeywordAll(Collection<String> keywords)

removeDocKeyword

public boolean removeDocKeyword(String keyword)

getDocKeywords

public List<String> getDocKeywords()

getDocCopyright

public String getDocCopyright()

Returns:

the docCopyright

setDocCopyright

public void setDocCopyright(String docCopyright)

Parameters:

docCopyright - the docCopyright to set

createDocCopyright

public void createDocCopyright(String owner)

Creates default copyright message for owner.

Parameters:

owner - The owner of the copyright.

getDocAbout

public String getDocAbout()

Returns:

the docAbout

setDocAbout

public void setDocAbout(String docAbout)

Parameters:

docAbout - the docAbout to set

addDocPage

public ApiDocPage addDocPage(ApiDocPage page)

removeDocPage

public boolean removeDocPage(ApiDocPage page)

getDocPages

public List<ApiDocPage> getDocPages()

findDocPageById

public ApiDocPage findDocPageById(String docPageId)

addTreeNodeClassExclude

public Class<?> addTreeNodeClassExclude(Class<?> excludeClass)

removeTreeNodeClassExclude

public boolean removeTreeNodeClassExclude(Class<?> excludeClass)

getTreeNodeClassExcludes

public List<Class<?>> getTreeNodeClassExcludes()

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getRootNodeTreePage

public ApiDocNode getRootNodeTreePage()

Returns:

the rootNodeTreePage

setRootNodeTreePage

public void setRootNodeTreePage(ApiDocNode rootNodeTreePage)

Parameters:

rootNodeTreePage - the rootNodeTreePage to set

getRootNode

public ApiDocNode getRootNode()

Returns:

the rootNode

setRootNode

public void setRootNode(ApiDocNode rootNode)

Parameters:

rootNode - the rootNode to set

getFrameNavConceptClass

public Class<?> getFrameNavConceptClass()

Returns:

the frameNavConceptClass

setFrameNavConceptClass

public void setFrameNavConceptClass(Class<?> frameNavConceptClass)

Parameters:

frameNavConceptClass - the frameNavConceptClass to set

getFrameNavPrintParent

public Boolean getFrameNavPrintParent()

Returns:

the frameNavPrintParent

setFrameNavPrintParent

public void setFrameNavPrintParent(Boolean frameNavPrintParent)

Parameters:

frameNavPrintParent - the frameNavPrintParent to set

getFrameNavPrintParentParent

public Boolean getFrameNavPrintParentParent()

Returns:

the frameNavPrintParentParent

setFrameNavPrintParentParent

public void setFrameNavPrintParentParent(Boolean frameNavPrintParentParent)

Parameters:

frameNavPrintParentParent - the frameNavPrintParentParent to set

getFrameNavOverviewPrintParent

public Boolean getFrameNavOverviewPrintParent()

Returns:

the frameNavOverviewPrintParent

setFrameNavOverviewPrintParent

public void setFrameNavOverviewPrintParent(Boolean frameNavOverviewPrintParent)

Parameters:

frameNavOverviewPrintParent - the frameNavOverviewPrintParent to set

getFrameNavPrintParentId

public Boolean getFrameNavPrintParentId()

Returns:

the frameNavPrintParentId

setFrameNavPrintParentId

public void setFrameNavPrintParentId(Boolean frameNavPrintParentId)

Parameters:

frameNavPrintParentId - the frameNavPrintParentId to set