org.docgene.model

Class XMLIncludedAPIMember

java.lang.Object

org.docgene.model.XMLIncludedAPIMember

All Implemented Interfaces:

ParagraphElement, ParagraphElementParent, StyledElement

public class XMLIncludedAPIMember
extends java.lang.Object
implements ParagraphElement, ParagraphElementParent

Represent an link to an included API <memberégt; tag under a <javaAPI> or <pythonAPI> tag

Field Summary

Fields

Modifier and Type	Field and Description
static short	CONSTRUCTOR Constructor members.
static short	FIELD Field members.
static short	METHOD Method members.
protected java.lang.String	path The member path.

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLIncludedAPIMember(short type) Create an included API member.

Method Summary

Modifier and Type	Method and Description
boolean	acceptArguments() Return true if the member accept arguments declaration.
void	addElement(ParagraphElement element) Add an element.
java.util.List<XMLIncludedAPIArgument>	getArguments() Return the list of arguments.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.util.List<ParagraphElement>	getElements() Return the list of elements.
java.lang.String	getMemberDeclaration() Return the member method declaration.
java.lang.String	getModifierAndType() Return the member modifier and type.
java.lang.String	getModifiers() Return the modifiers.
java.lang.String	getName() Return the member name.
XMLIncludedAPI	getParentAPI() Return the parent API.
java.lang.String	getPath() Return the path.
short	getType() Return the element type.
boolean	hasArgumentsDeclaration() Return true if there are arguments declaration.
void	setElements(java.util.List<ParagraphElement> elements) Set the list of elements.
void	setModifiers(java.lang.String modifiers) Set the modifiers.
void	setParentAPI(XMLIncludedAPI api) Set the parent API.
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

getCustomStyles, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Field Detail

FIELD

public static final short FIELD

Field members.

See Also:

Constant Field Values

METHOD

public static final short METHOD

Method members.

See Also:

Constant Field Values

CONSTRUCTOR

public static final short CONSTRUCTOR

Constructor members.

See Also:

Constant Field Values

path

protected java.lang.String path

The member path.

Constructor Detail

XMLIncludedAPIMember

public XMLIncludedAPIMember(short type)

Create an included API member.

Parameters:

type - the member type

Method Detail

setParentAPI

public void setParentAPI(XMLIncludedAPI api)

Set the parent API.

Parameters:

api - the parent API

getParentAPI

public XMLIncludedAPI getParentAPI()

Return the parent API.

Returns:

the parent API

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

getModifierAndType

public java.lang.String getModifierAndType()

Return the member modifier and type.

Returns:

the member modifier and type

getMemberDeclaration

public java.lang.String getMemberDeclaration()

Return the member method declaration.

Returns:

the member method declaration

getName

public java.lang.String getName()

Return the member name.

Returns:

the member name

acceptArguments

public boolean acceptArguments()

Return true if the member accept arguments declaration.

Returns:

true if the member accept arguments declaration

getType

public short getType()

Return the element type.

Returns:

the element type

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

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

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

getArguments

public java.util.List<XMLIncludedAPIArgument> getArguments()

Return the list of arguments.

Returns:

the list of arguments

hasArgumentsDeclaration

public boolean hasArgumentsDeclaration()

Return true if there are arguments declaration.

Returns:

true if there are arguments declaration