thredds.client.catalog

Class Documentation

java.lang.Object

thredds.client.catalog.Documentation

@Immutable
public class Documentation
extends java.lang.Object

Client catalog documentation element

Since:

1/9/2015

Constructor Summary

Constructors

Constructor and Description
Documentation(java.lang.String href, java.net.URI uri, java.lang.String title, java.lang.String type, java.lang.String inlineContent) Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Documentation

public Documentation(java.lang.String href,
                     java.net.URI uri,
                     java.lang.String title,
                     java.lang.String type,
                     java.lang.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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getInlineContent

public java.lang.String getInlineContent()

getType

public java.lang.String getType()

getURI

public java.net.URI getURI()

if its a XLink, get the absolute URI

Returns:

the XLink URI, else null

getXlinkHref

public java.lang.String getXlinkHref()

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

Returns:

the XLink href, or null

getXlinkTitle

public java.lang.String getXlinkTitle()

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

Returns:

the XLink title, else null

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasXlink

public boolean hasXlink()

readXlinkContent

public java.lang.String readXlinkContent()
                                  throws java.io.IOException

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

Returns:

inline content as a string, else null

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object