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

Class ApiDocConcept

java.lang.Object

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

public class ApiDocConcept
extends Object

ApiDocConcept defines the prime concepts which for which we write documents.

Version:

1.0 May 12, 2013

Author:

Willem Cazander

Constructor Summary

Constructors

Constructor and Description
ApiDocConcept()
ApiDocConcept(ApiDocConcept parent, String[] text, Class<?> conceptClass, Class<?>... classes)
ApiDocConcept(ApiDocConcept parent, String id, Class<?> conceptClass)
ApiDocConcept(ApiDocConcept parent, String id, String name, String descriptionName, String descriptionHelp, Class<?> conceptClass, Class<?>... classes)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConceptChildClass(Class<?> targetClass)
List<Class<?>>	getConceptChildClasses()
Class<?>	getConceptClass()
String	getDescriptionHelp()
String	getDescriptionName()
String	getId()
String	getName()
ApiDocConcept	getParent()
void	removeConceptChildClass(Class<?> targetClass)
void	setConceptClass(Class<?> conceptClass)
void	setDescriptionHelp(String descriptionHelp)
void	setDescriptionName(String descriptionName)
void	setId(String id)
void	setName(String name)
void	setParent(ApiDocConcept parent)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocConcept

public ApiDocConcept()

ApiDocConcept

public ApiDocConcept(ApiDocConcept parent,
             String id,
             Class<?> conceptClass)

ApiDocConcept

public ApiDocConcept(ApiDocConcept parent,
             String[] text,
             Class<?> conceptClass,
             Class<?>... classes)

ApiDocConcept

public ApiDocConcept(ApiDocConcept parent,
             String id,
             String name,
             String descriptionName,
             String descriptionHelp,
             Class<?> conceptClass,
             Class<?>... classes)

Method Detail

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the id to set

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getDescriptionName

public String getDescriptionName()

Returns:

the descriptionName

setDescriptionName

public void setDescriptionName(String descriptionName)

Parameters:

descriptionName - the descriptionName to set

getDescriptionHelp

public String getDescriptionHelp()

Returns:

the descriptionHelp

setDescriptionHelp

public void setDescriptionHelp(String descriptionHelp)

Parameters:

descriptionHelp - the descriptionHelp to set

getConceptClass

public Class<?> getConceptClass()

Returns:

the conceptClass

setConceptClass

public void setConceptClass(Class<?> conceptClass)

Parameters:

conceptClass - the conceptClass to set

addConceptChildClass

public void addConceptChildClass(Class<?> targetClass)

removeConceptChildClass

public void removeConceptChildClass(Class<?> targetClass)

getConceptChildClasses

public List<Class<?>> getConceptChildClasses()

getParent

public ApiDocConcept getParent()

Returns:

the parent

setParent

public void setParent(ApiDocConcept parent)

Parameters:

parent - the parent to set