org.docgene.model

Class AbstractAPI

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.AbstractAPI

All Implemented Interfaces:

ElementReference, ExternalLink, ParagraphElement, StyledElement

Direct Known Subclasses:

XMLDotNetAPI, XMLDoxygenAPI, XMLJavaAPI, XMLPythonAPI, XMLQtAPI

public abstract class AbstractAPI
extends AbstractLink

A general API link.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	altPath The alternate API link path.
protected java.lang.String	altText The API alternate text.
protected java.lang.String	api The API (may be null is location is not null).
protected boolean	isResolved True if the API is resolved.
protected java.net.URL	location The API location (may be null is api is not null).
protected APIMember	member The API member.
protected java.lang.String	path The API link path.
protected java.lang.String	text The API text.
protected java.net.URL	url The API 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
AbstractAPI()

Method Summary

Modifier and Type	Method and Description
void	bind(java.lang.String text, java.lang.String altText) Set the API path associated text.
void	bind(java.net.URL url, java.lang.String text, java.lang.String altText) Bind the API path URL.
java.lang.String	getAltPath() Return the API alternate path.
java.lang.String	getAltText() Return the link description alternate text.
java.lang.String	getAPI() Return the API name.May be null if getAPILocation() is not null.
java.net.URL	getAPILocation() Return the API location.
APIMember	getMember() Return the API member.
java.lang.String	getMemberPath() Return the API member.
java.lang.String	getPath() Return the API link path.
java.lang.String	getShownPath() Return the API shown path.
java.lang.String	getText() Return the link description text.
java.net.URL	getURL() Return the link URL.
boolean	hasAPI() Return true if there is a specified API.
boolean	hasAPILocation() Return true if the API has a location.
boolean	isConstructor() Return true if the API desgins a constructor.
boolean	isResolved() Return true if the API is resolved.
void	setAltPath(java.lang.String altPath) Set the API alternate path.
void	setConstructor(boolean isConstructor) Set if the API desgins a constructor.
void	setMember(APIMember member) Set the API member.
void	setMember(java.lang.String member) Set the API member.
void	setPath(java.lang.String path) Set the API path.

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

getDeclaration, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Field Detail

api

protected java.lang.String api

The API (may be null is location is not null).

location

protected java.net.URL location

The API location (may be null is api is not null).

url

protected java.net.URL url

The API URL.

text

protected java.lang.String text

The API text.

altText

protected java.lang.String altText

The API alternate text.

path

protected java.lang.String path

The API link path.

altPath

protected java.lang.String altPath

The alternate API link path.

isResolved

protected boolean isResolved

True if the API is resolved.

member

protected APIMember member

The API member.

Constructor Detail

AbstractAPI

public AbstractAPI()

Method Detail

getAPI

public java.lang.String getAPI()

Return the API name.May be null if getAPILocation() is not null.

Returns:

the API name

hasAPI

public boolean hasAPI()

Return true if there is a specified API.

Returns:

true if there is a specified API

hasAPILocation

public boolean hasAPILocation()

Return true if the API has a location.

Returns:

true if the API has a location

getAPILocation

public java.net.URL getAPILocation()

Return the API location. May be null if getAPI() is not null.

Returns:

the API location

setPath

public void setPath(java.lang.String path)

Set the API path.

Parameters:

path - the API path

getPath

public java.lang.String getPath()

Return the API link path.

Returns:

the API link path

getShownPath

public java.lang.String getShownPath()

Return the API shown path.

Returns:

the API shown path

setAltPath

public void setAltPath(java.lang.String altPath)

Set the API alternate path.

Parameters:

altPath - the API alternate path

getAltPath

public java.lang.String getAltPath()

Return the API alternate path.

Returns:

the API alternate path

setConstructor

public void setConstructor(boolean isConstructor)

Set if the API desgins a constructor.

Parameters:

isConstructor - true if the API desgins a constructor

isConstructor

public boolean isConstructor()

Return true if the API desgins a constructor.

Returns:

true if the API desgins a constructor

bind

public void bind(java.lang.String text,
                 java.lang.String altText)

Set the API path associated text.

Parameters:

text - the text

altText - the alt text

bind

public void bind(java.net.URL url,
                 java.lang.String text,
                 java.lang.String altText)

Bind the API path URL.

Parameters:

url - the URL

text - the text

altText - the alt text

isResolved

public boolean isResolved()

Return true if the API is resolved.

Returns:

true if the API is resolved

getText

public java.lang.String getText()

Return the link description text.

Returns:

the link description text

getAltText

public java.lang.String getAltText()

Return the link description alternate text.

Returns:

the link description alternate text

getURL

public java.net.URL getURL()

Return the link URL.

Returns:

the link URL

setMember

public void setMember(APIMember member)

Set the API member.

Parameters:

member - the API member

setMember

public void setMember(java.lang.String member)

Set the API member.

Parameters:

member - the API member

getMember

public APIMember getMember()

Return the API member.

Returns:

the API member

getMemberPath

public java.lang.String getMemberPath()

Return the API member.

Returns:

the API member