Package thredds.client.catalog

Class Documentation

java.lang.Object

thredds.client.catalog.Documentation

@Immutable
public class Documentation
extends Object

Client catalog documentation element

Since:

1/9/2015

Constructor Summary

Constructors

Constructor	Description
Documentation(String href, URI uri, String title, String type, String inlineContent)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getInlineContent()
String	getType()
URI	getURI()	if its a XLink, get the absolute URI
String	getXlinkHref()	if its a XLink, get the href, to display the link to the user.
String	getXlinkTitle()	if its a XLink, get the title, to display the link to the user.
int	hashCode()
boolean	hasXlink()
String	readXlinkContent()	Get inline content as a string, else null if there is none
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Documentation

public Documentation(String href,
                     URI uri,
                     String title,
                     String type,
                     String inlineContent)

Constructor.

Parameters:

href - : href of documentation, may be null.

uri - : absolute URL, or null

title - : Xlink title, may be null.

type - : user-defined InvDocumentation type

inlineContent - : optional inline contents.

Method Detail

getType

public String getType()

hasXlink

public boolean hasXlink()

getURI

public URI getURI()

if its a XLink, get the absolute URI

Returns:

the XLink URI, else null

getXlinkTitle

public String getXlinkTitle()

if its a XLink, get the title, to display the link to the user.

Returns:

the XLink title, else null

getXlinkHref

public String getXlinkHref()

if its a XLink, get the href, to display the link to the user.

Returns:

the XLink href, or null

getInlineContent

public String getInlineContent()

readXlinkContent

public String readXlinkContent()
                        throws IOException

Get inline content as a string, else null if there is none

Returns:

inline content as a string, else null

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object