org.docgene.model

Interface ExternalLink

All Superinterfaces:

ElementReference, ParagraphElement, StyledElement

All Known Implementing Classes:

AbstractAPI, AbstractLink, AbstractWikiLink, XMLArchiveURL, XMLAudio, XMLCitation, XMLDotNetAPI, XMLDoxygenAPI, XMLExternalLink, XMLJavaAPI, XMLMediawikiLink, XMLPythonAPI, XMLQtAPI, XMLVideo, XMLWikipediaLink

public interface ExternalLink
extends ParagraphElement, ElementReference

Represent an external link, which can be a bare link or a link to a class in a Java API.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Method Summary

Modifier and Type	Method and Description
default java.net.URL	getNotNullURL() Return a not null link URL.
default java.lang.String	getPath() Return the link path.
java.lang.String	getText() Return the link description text.
java.net.URL	getURL() Return the link URL.
default java.lang.String	getURLAsString() Return the complete link URL as a String.
default java.lang.String	getURLAsString(java.net.URL baseURL) Return the link relative to a base URL.
default java.lang.String	getURLAsString(XMLParentArticle article) Return the path of the link relative to its article.
default boolean	isAbsolute() Return true if the link is absolute.
boolean	isValid() Return true if the link is valid.
void	setValid(boolean isValid) Set if the link is valid.

Methods inherited from interface org.docgene.model.StyledElement

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

Methods inherited from interface org.docgene.model.ElementReference

getLineNumber, hasLineNumber

Method Detail

setValid

void setValid(boolean isValid)

Set if the link is valid.

Parameters:

isValid - true if the link is valid

isValid

boolean isValid()

Return true if the link is valid.

Returns:

true if the link is valid

getURL

java.net.URL getURL()

Return the link URL.

Returns:

the link URL

getNotNullURL

default java.net.URL getNotNullURL()

Return a not null link URL.

Returns:

a not null link URL

getPath

default java.lang.String getPath()

Return the link path. Return null by default.

Returns:

the link path

isAbsolute

default boolean isAbsolute()

Return true if the link is absolute. Retuern true by default.

Returns:

true if the link is absolute

getURLAsString

default java.lang.String getURLAsString(java.net.URL baseURL)

Return the link relative to a base URL.

Parameters:

baseURL - the base URL

Returns:

the complete link URL as a String

getURLAsString

default java.lang.String getURLAsString(XMLParentArticle article)

Return the path of the link relative to its article.

Parameters:

article - the article

Returns:

the link path

getURLAsString

default java.lang.String getURLAsString()

Return the complete link URL as a String. Defer by default to getURL() and return the String value of the URL.

Returns:

the complete link URL as a String

getText

java.lang.String getText()

Return the link description text.

Returns:

the link description text