AbstractXMLAPIDoc (DocJGenerator API)

java.lang.Object
- org.docgene.model.AbstractXMLAPIDoc

All Implemented Interfaces:

org.docgene.model.globals.apidocs.APIDocTypes, ParagraphElement, ParagraphElementParent, StyledElement

Direct Known Subclasses:

XMLAPIDoc, XMLAPIDocElement
```
public abstract class AbstractXMLAPIDoc
extends java.lang.Object
implements ParagraphElement, ParagraphElementParent, org.docgene.model.globals.apidocs.APIDocTypes
```
A general API documentation.

Since:

1.4.17

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`api` The API.
`protected org.docgene.model.globals.apidocs.APIDoc.Element`	`element` The element specification.
`protected java.lang.String`	`modifiers` The modifiers.
`protected java.lang.String`	`path` The path.

Fields inherited from interface org.docgene.model.StyledElement
TYPE_NONE

Fields inherited from interface org.docgene.model.globals.apidocs.APIDocTypes
ELEMENT_ARGUMENT, ELEMENT_CLASS, ELEMENT_CONSTANT, ELEMENT_CONSTRUCTOR, ELEMENT_DESTRUCTOR, ELEMENT_ENUM, ELEMENT_EVENT, ELEMENT_FIELD, ELEMENT_FUNCTION, ELEMENT_GETTER, ELEMENT_HEADER, ELEMENT_INTERFACE, ELEMENT_MACRO, ELEMENT_METHOD, ELEMENT_MODULE, ELEMENT_OPERATOR, ELEMENT_PROPERTY, ELEMENT_RETURN, ELEMENT_SETTER, ELEMENT_SOURCE, ELEMENT_STRUCT, ELEMENT_TYPEDEF, TYPE_CSHARP, TYPE_DOXYGEN, TYPE_JAVA, TYPE_PYTHON, TYPE_QT, UNDEF

Constructor Summary

Constructors
Constructor and Description

AbstractXMLAPIDoc(org.docgene.model.globals.apidocs.APIDoc.Element element)

Constructors
Constructor and Description
`AbstractXMLAPIDoc(org.docgene.model.globals.apidocs.APIDoc.Element element)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElement(ParagraphElement element)` Add an element.
`int`	`countDocElements(java.lang.String name)` Count the number of elements of a specified name.
`org.docgene.model.globals.apidocs.APIDoc`	`getAPI()` Return the associated parent API specification.
`java.lang.String`	`getAPIID()` Return the API ID.
`java.util.Set<java.lang.String>`	`getCustomStyles()` Return the element custom classes.
`java.util.SortedMap<java.lang.String,java.util.List<XMLAPIDocElement>>`	`getDocElements(java.lang.String name)` Return the map of API doc elements of a specified name.
`java.util.List<XMLAPIDocElement>`	`getDocElementsAsList(java.lang.String name)` Return the list of API doc elements of a specified name.
`java.util.List<org.docgene.model.globals.apidocs.APIDoc.OrderedChild>`	`getDocElementsList()` Return the ordered list of API elements specifications, including only those which are present.
`java.util.List<ParagraphElement>`	`getElements()` Return the list of elements.
`org.docgene.model.globals.apidocs.APIDoc.Element`	`getElementSpecification()` Return the element specification.
`java.lang.String`	`getElementTypeName()` Return the element type name.
`abstract java.lang.String`	`getModifiers()` Return the modifiers.
`java.lang.String`	`getName()` Return the member name.
`short`	`getParentType()` Return the element parent type.
`java.lang.String`	`getPath()` Return the path.
`short`	`getType()` Return the element type.
`boolean`	`hasDocElement(java.lang.String name)` Return true if there are elements declarations of a specified name in the API.
`void`	`setCustomStyles(java.util.Set<java.lang.String> classes)` Set the element custom classes.
`void`	`setElements(java.util.List<ParagraphElement> elements)` Set the list of elements.
`void`	`setModifiers(java.lang.String modifiers)` Set the modifiers.
`void`	`setPath(java.lang.String path)` Set the path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.docgene.model.StyledElement
getDeclaration, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ParagraphElementParent
countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.globals.apidocs.APIDocTypes
getElementType, getParentType, pathRequired

- Field Detail
  - element
```
protected final org.docgene.model.globals.apidocs.APIDoc.Element element
```
    The element specification.
  - modifiers
```
protected java.lang.String modifiers
```
    The modifiers.
  - path
```
protected java.lang.String path
```
    The path.
  - api
```
protected java.lang.String api
```
    The API.
- Constructor Detail
  - AbstractXMLAPIDoc
```
public AbstractXMLAPIDoc(org.docgene.model.globals.apidocs.APIDoc.Element element)
```
- Method Detail
  - getElementSpecification
```
public org.docgene.model.globals.apidocs.APIDoc.Element getElementSpecification()
```
    Return the element specification.
    
    Returns:
    
    the element specification
  - getName
```
public java.lang.String getName()
```
    Return the member name.
    
    Returns:
    
    the member name
  - getParentType
```
public short getParentType()
```
    Return the element parent type.
    
    Returns:
    
    the element parent type
  - getType
```
public short getType()
```
    Return the element type.
    
    Returns:
    
    the element type
  - getElementTypeName
```
public java.lang.String getElementTypeName()
```
    Return the element type name.
    
    Returns:
    
    the element type name
  - getAPI
```
public org.docgene.model.globals.apidocs.APIDoc getAPI()
```
    Return the associated parent API specification.
    
    Returns:
    
    the API
  - getAPIID
```
public java.lang.String getAPIID()
```
    Return the API ID.
    
    Returns:
    
    the API ID
  - setModifiers
```
public void setModifiers(java.lang.String modifiers)
```
    Set the modifiers.
    
    Parameters:
    
    modifiers - the modifiers
  - getModifiers
```
public abstract java.lang.String getModifiers()
```
    Return the modifiers.
    
    Returns:
    
    the modifiers
  - setPath
```
public void setPath(java.lang.String path)
```
    Set the path.
    
    Parameters:
    
    path - the path
  - getPath
```
public java.lang.String getPath()
```
    Return the path.
    
    Returns:
    
    the path
  - setCustomStyles
```
public void setCustomStyles(java.util.Set<java.lang.String> classes)
```
    Set the element custom classes.
    
    Specified by:
    
    setCustomStyles in interface StyledElement
    
    Parameters:
    
    classes - the custom element classes
  - getCustomStyles
```
public java.util.Set<java.lang.String> getCustomStyles()
```
    Return the element custom classes.
    
    Specified by:
    
    getCustomStyles in interface StyledElement
    
    Returns:
    
    the custom classes
  - setElements
```
public void setElements(java.util.List<ParagraphElement> elements)
```
    Set the list of elements.
    
    Specified by:
    
    setElements in interface ParagraphElementParent
    
    Parameters:
    
    elements - the list of elements
  - addElement
```
public void addElement(ParagraphElement element)
```
    Add an element.
    
    Specified by:
    
    addElement in interface ParagraphElementParent
    
    Parameters:
    
    element - the element
  - getElements
```
public java.util.List<ParagraphElement> getElements()
```
    Return the list of elements.
    
    Specified by:
    
    getElements in interface ParagraphElementParent
    
    Returns:
    
    the list of elements
  - countDocElements
```
public int countDocElements(java.lang.String name)
```
    Count the number of elements of a specified name.
    
    Parameters:
    
    name -
    
    Returns:
    
    the number of methods.
  - hasDocElement
```
public boolean hasDocElement(java.lang.String name)
```
    Return true if there are elements declarations of a specified name in the API.
    
    Parameters:
    
    name - the element name
    
    Returns:
    
    true if there are elements declarations of the specified name in the API
  - getDocElements
```
public java.util.SortedMap<java.lang.String,java.util.List<XMLAPIDocElement>> getDocElements(java.lang.String name)
```
    Return the map of API doc elements of a specified name.
    
    Parameters:
    
    name - the element name
    
    Returns:
    
    the map of API doc elements of a specified name
  - getDocElementsAsList
```
public java.util.List<XMLAPIDocElement> getDocElementsAsList(java.lang.String name)
```
    Return the list of API doc elements of a specified name.
    
    Parameters:
    
    name - the element name
    
    Returns:
    
    the list of API doc elements of a specified name
  - getDocElementsList
```
public java.util.List<org.docgene.model.globals.apidocs.APIDoc.OrderedChild> getDocElementsList()
```
    Return the ordered list of API elements specifications, including only those which are present.
    
    Returns:
    
    the ordered list of API elements specifications

Class AbstractXMLAPIDoc

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

Fields inherited from interface org.docgene.model.globals.apidocs.APIDocTypes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.docgene.model.StyledElement

Methods inherited from interface org.docgene.model.ParagraphElementParent

Methods inherited from interface org.docgene.model.globals.apidocs.APIDocTypes

Field Detail

element

modifiers

path

api

Constructor Detail

AbstractXMLAPIDoc

Method Detail

getElementSpecification

getName

getParentType

getType

getElementTypeName

getAPI

getAPIID

setModifiers

getModifiers

setPath

getPath

setCustomStyles

getCustomStyles

setElements

addElement

getElements

countDocElements

hasDocElement

getDocElements

getDocElementsAsList

getDocElementsList