org.docgene.model

Class XMLPythonAPI

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.AbstractAPI

org.docgene.model.XMLPythonAPI

All Implemented Interfaces:

ElementReference, ExternalLink, ParagraphElement, StyledElement

public class XMLPythonAPI
extends AbstractAPI

Represent an link to a python API.

Field Summary

Fields

Modifier and Type	Field and Description
static short	API_CLASS A link to a class.
static short	API_METHOD A link to a method.
static short	API_MODULE A link to a module.

Fields inherited from class org.docgene.model.AbstractAPI

altPath, altText, api, isResolved, location, member, path, text, url

Fields inherited from class org.docgene.model.AbstractLink

isAbsolute, isValid

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLPythonAPI() Create a link to the default Python 3 API.
XMLPythonAPI(java.lang.String api) Create a Python API link.
XMLPythonAPI(java.net.URL location) Create a .NET API link.

Method Summary

Modifier and Type	Method and Description
short	getAPIType() Return the API type.
java.lang.String	getClassName() Return the API class name.
java.lang.String	getDeclaration() Return the declaration ID of the element.
void	setAPIType(short type) Set the API type.
void	setClassName(java.lang.String className) Set the API class name.

Methods inherited from class org.docgene.model.AbstractAPI

bind, bind, getAltPath, getAltText, getAPI, getAPILocation, getMember, getMemberPath, getPath, getShownPath, getText, getURL, hasAPI, hasAPILocation, isConstructor, isResolved, setAltPath, setConstructor, setMember, setMember, setPath

Methods inherited from class org.docgene.model.AbstractLink

getCustomStyles, getLineNumber, isAbsolute, isValid, setCustomStyles, setLineNumber, setValid

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.ExternalLink

getNotNullURL, getURLAsString, getURLAsString, getURLAsString

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Field Detail

API_MODULE

public static final short API_MODULE

A link to a module.

See Also:

Constant Field Values

API_CLASS

public static final short API_CLASS

A link to a class.

See Also:

Constant Field Values

API_METHOD

public static final short API_METHOD

A link to a method.

See Also:

Constant Field Values

Constructor Detail

XMLPythonAPI

public XMLPythonAPI()

Create a link to the default Python 3 API.

See Also:

APIsSpecs.PYTHON3

XMLPythonAPI

public XMLPythonAPI(java.lang.String api)

Create a Python API link.

Parameters:

api - the .NET API

See Also:

APILocations.getPythonAPIs()

XMLPythonAPI

public XMLPythonAPI(java.net.URL location)

Create a .NET API link.

Parameters:

location - the location

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Returns:

the declaration ID of the element

setAPIType

public void setAPIType(short type)

Set the API type.

Parameters:

type - the API type

getAPIType

public short getAPIType()

Return the API type.

Returns:

the API type

setClassName

public void setClassName(java.lang.String className)

Set the API class name.

Parameters:

className - the class name

getClassName

public java.lang.String getClassName()

Return the API class name.

Returns:

the class name