org.docgene.model

Class XMLJavaAPI

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.AbstractAPI

org.docgene.model.XMLJavaAPI

All Implemented Interfaces:

ElementReference, ExternalLink, ParagraphElement, StyledElement

public class XMLJavaAPI
extends AbstractAPI

Represent an link to a Java API.

Field Summary

Fields

Modifier and Type	Field and Description
static short	API_PATH_CLASS The default value, only the class name is presented.
static short	API_PATH_FULL The full class path is presented.
static short	API_PATH_MEMBER Only the member is presented.
static short	TYPE_CLASS The default type, for class declarations.
static short	TYPE_MODULE The type for module declarations.
static short	TYPE_PACKAGE The type for package declarations.

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
XMLJavaAPI() Create a Java API link to the default JavaSE API.
XMLJavaAPI(java.lang.String api) Create a Java API link.
XMLJavaAPI(java.net.URL location) Create a Java API link.

Method Summary

Modifier and Type	Method and Description
void	bind(java.net.URL url, java.lang.String text, java.lang.String altText, boolean hasLibrary) Bind the API path URL.
short	getAPIPathType() Return the API link path type presentation.
short	getAPIType() Return the type of the API.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getModule() Return the module.
java.lang.String	getText() Return the link description text.
boolean	hasLibrary() Return true if the Java API has a stored corresponding library.
boolean	isAnyJDKAPI() Return true if the API is a JDK API for Java 8 (JavaSE or JavaFX).
boolean	isClassAPIType() Return true if the API points to a class.
boolean	isJDK8API() Return true if the API is a JDK API for Java 8 (JavaSE or JavaFX).
boolean	isResolved() Return true if the API is resolved.
void	setAPIPathType(short type) Set if the API link path type presentation.
void	setAPIType(short apiType) Set the type of the API.
void	setModule(java.lang.String module) Set the module.

Methods inherited from class org.docgene.model.AbstractAPI

bind, bind, getAltPath, getAltText, getAPI, getAPILocation, getMember, getMemberPath, getPath, getShownPath, getURL, hasAPI, hasAPILocation, isConstructor, 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_PATH_CLASS

public static final short API_PATH_CLASS

The default value, only the class name is presented.

See Also:

Constant Field Values

API_PATH_FULL

public static final short API_PATH_FULL

The full class path is presented.

See Also:

Constant Field Values

API_PATH_MEMBER

public static final short API_PATH_MEMBER

Only the member is presented.

See Also:

Constant Field Values

TYPE_CLASS

public static final short TYPE_CLASS

The default type, for class declarations.

See Also:

Constant Field Values

TYPE_PACKAGE

public static final short TYPE_PACKAGE

The type for package declarations.

See Also:

Constant Field Values

TYPE_MODULE

public static final short TYPE_MODULE

The type for module declarations.

See Also:

Constant Field Values

Constructor Detail

XMLJavaAPI

public XMLJavaAPI()

Create a Java API link to the default JavaSE API.

See Also:

APIsSpecs.JAVADOC_SE

XMLJavaAPI

public XMLJavaAPI(java.lang.String api)

Create a Java API link.

Parameters:

api - the Java API

See Also:

APILocations.getJavaAPIs()

XMLJavaAPI

public XMLJavaAPI(java.net.URL location)

Create a Java 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

isAnyJDKAPI

public boolean isAnyJDKAPI()

Return true if the API is a JDK API for Java 8 (JavaSE or JavaFX).

Returns:

true if the API is a JDK API for Java 8

isJDK8API

public boolean isJDK8API()

Return true if the API is a JDK API for Java 8 (JavaSE or JavaFX).

Returns:

true if the API is a JDK API for Java 8

setAPIType

public void setAPIType(short apiType)

Set the type of the API. The valid values are:

• TYPE_CLASS: the default value, the API specifies a class
• TYPE_PACKAGE: the API specifies a package
• TYPE_MODULE: the API specifies a module

Parameters:

apiType - the type of the API

isClassAPIType

public boolean isClassAPIType()

Return true if the API points to a class.

Returns:

true if the API points to a class

getAPIType

public short getAPIType()

Return the type of the API.

Returns:

the type of the API

setAPIPathType

public void setAPIPathType(short type)

Set if the API link path type presentation. The valid values are:

• API_PATH_CLASS: the default value, only the class name is presented
• API_PATH_FULL: the full class path is presented
• API_PATH_MEMBER: only the member is presented

Parameters:

type - the API path type

getAPIPathType

public short getAPIPathType()

Return the API link path type presentation.

Returns:

the API link path type presentation

See Also:

setAPIPathType(short)

setModule

public void setModule(java.lang.String module)

Set the module.

Parameters:

module - the module

getModule

public java.lang.String getModule()

Return the module.

Returns:

the module

getText

public java.lang.String getText()

Return the link description text.

Specified by:

getText in interface ExternalLink

Overrides:

getText in class AbstractAPI

Returns:

the link description text

hasLibrary

public boolean hasLibrary()

Return true if the Java API has a stored corresponding library.

Returns:

true if the Java API has a stored corresponding library

isResolved

public boolean isResolved()

Return true if the API is resolved.

Overrides:

isResolved in class AbstractAPI

Returns:

true if the API is resolved

bind

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

Bind the API path URL.

Parameters:

url - the URL

text - the text

altText - the alt text

hasLibrary - true if the API has an associated library