XMLIncludedAPI (DocJGenerator Scripting API)

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

All Implemented Interfaces:

ParagraphElement, ParagraphElementParent, StyledElement
```
public class XMLIncludedAPI
extends java.lang.Object
implements ParagraphElement, ParagraphElementParent
```
A general included API link. This is used for both the <javaAPI> and <pythonAPI> tags.

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String api
The API.

static short CLASS
class.

static short ENUM
enum.

static short INTERFACE
interface.
- Fields inherited from interface org.docgene.model.StyledElement
  TYPE_NONE

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`api` The API.
`static short`	`CLASS` class.
`static short`	`ENUM` enum.
`static short`	`INTERFACE` interface.

Constructor Summary

Constructors
Constructor and Description

XMLIncludedAPI(short language, short type)

Constructors
Constructor and Description
`XMLIncludedAPI(short language, short type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElement(ParagraphElement element)` Add an element.
`int`	`countFields()` Count the number of fields.
`int`	`countMethods()` Count the number of methods.
`java.lang.String`	`getAPI()` Return the API name.
`java.util.List<XMLIncludedAPIMember>`	`getConstructors()` Return the list of constructors.
`java.util.Set<java.lang.String>`	`getCustomStyles()` Return the element custom classes.
`java.lang.String`	`getDeclaration()` Return the declaration ID of the element.
`java.util.List<ParagraphElement>`	`getElements()` Return the list of elements.
`java.lang.String`	`getElementType()` Return the element type as a String.
`java.util.SortedMap<java.lang.String,XMLIncludedAPIMember>`	`getFields()` Return the map of fields.
`java.util.SortedMap<java.lang.String,java.util.List<XMLIncludedAPIMember>>`	`getFieldsAsList()` Return the map of fields as a map of lists.
`short`	`getLanguage()` Return the API language.
`java.util.SortedMap<java.lang.String,java.util.List<XMLIncludedAPIMember>>`	`getMethods()` Return the map of methods.
`java.lang.String`	`getModifiers()` Return the modifiers.
`java.lang.String`	`getPath()` Return the path.
`short`	`getType()` Return the element type.
`boolean`	`hasConstructors()` Return true if there are constructors declarations in the API.
`boolean`	`hasFields()` Return true if there are fields declarations in the API.
`boolean`	`hasMethods()` Return true if there are methods declarations in the API.
`boolean`	`hasThematicBreak()` Return true if the api has thematic breaks("hr").
`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.
`void`	`setThematicBreak(boolean hasHR)` Set if the api has thematic breaks("hr").

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
getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

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

- Field Detail
  - CLASS
```
public static final short CLASS
```
    class.
    
    See Also:
    
    Constant Field Values
  - ENUM
```
public static final short ENUM
```
    enum.
    
    See Also:
    
    Constant Field Values
  - INTERFACE
```
public static final short INTERFACE
```
    interface.
    
    See Also:
    
    Constant Field Values
  - api
```
protected java.lang.String api
```
    The API.
- Constructor Detail
  - XMLIncludedAPI
```
public XMLIncludedAPI(short language,
                      short type)
```
- Method Detail
  - getType
```
public short getType()
```
    Return the element type.
    
    Returns:
    
    the element type
  - getElementType
```
public java.lang.String getElementType()
```
    Return the element type as a String.
    
    Returns:
    
    the element type as a String
  - getDeclaration
```
public java.lang.String getDeclaration()
```
    Return the declaration ID of the element.
    
    Specified by:
    
    getDeclaration in interface StyledElement
    
    Returns:
    
    the declaration ID of the element
  - getLanguage
```
public short getLanguage()
```
    Return the API language.
    
    Returns:
    
    the API language
  - setModifiers
```
public void setModifiers(java.lang.String modifiers)
```
    Set the modifiers.
    
    Parameters:
    
    modifiers - the modifiers
  - getModifiers
```
public java.lang.String getModifiers()
```
    Return the modifiers.
    
    Returns:
    
    the modifiers
  - getAPI
```
public java.lang.String getAPI()
```
    Return the API name.
    
    Returns:
    
    the API name
  - 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
  - setThematicBreak
```
public void setThematicBreak(boolean hasHR)
```
    Set if the api has thematic breaks("hr").
    
    Parameters:
    
    hasHR - true if the api has thematic breaks("hr")
  - hasThematicBreak
```
public boolean hasThematicBreak()
```
    Return true if the api has thematic breaks("hr").
    
    Returns:
    
    true true if the api has thematic breaks("hr")
  - 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
  - countFields
```
public int countFields()
```
    Count the number of fields.
    
    Returns:
    
    the number of fields.
  - countMethods
```
public int countMethods()
```
    Count the number of methods.
    
    Returns:
    
    the number of methods.
  - getFields
```
public java.util.SortedMap<java.lang.String,XMLIncludedAPIMember> getFields()
```
    Return the map of fields.
    
    Returns:
    
    the map of fields
  - getFieldsAsList
```
public java.util.SortedMap<java.lang.String,java.util.List<XMLIncludedAPIMember>> getFieldsAsList()
```
    Return the map of fields as a map of lists.
    
    Returns:
    
    the map of fields as a map of lists
  - hasFields
```
public boolean hasFields()
```
    Return true if there are fields declarations in the API.
    
    Returns:
    
    true if there are fields declarations in the API
  - getConstructors
```
public java.util.List<XMLIncludedAPIMember> getConstructors()
```
    Return the list of constructors.
    
    Returns:
    
    the list of constructors
  - hasConstructors
```
public boolean hasConstructors()
```
    Return true if there are constructors declarations in the API.
    
    Returns:
    
    true if there are constructors declarations in the API
  - getMethods
```
public java.util.SortedMap<java.lang.String,java.util.List<XMLIncludedAPIMember>> getMethods()
```
    Return the map of methods.
    
    Returns:
    
    the map of methods
  - hasMethods
```
public boolean hasMethods()
```
    Return true if there are methods declarations in the API.
    
    Returns:
    
    true if there are methods declarations in the API

Class XMLIncludedAPI

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

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

Field Detail

CLASS

ENUM

INTERFACE

api

Constructor Detail

XMLIncludedAPI

Method Detail

getType

getElementType

getDeclaration

getLanguage

setModifiers

getModifiers

getAPI

setPath

getPath

setThematicBreak

hasThematicBreak

setCustomStyles

getCustomStyles

setElements

addElement

getElements

countFields

countMethods

getFields

getFieldsAsList

hasFields

getConstructors

hasConstructors

getMethods

hasMethods