uk.ac.starlink.hapi

Interface HapiCapabilities

public interface HapiCapabilities

Models the HAPI Capabilities response object, as obtained from the capabilities endpoint.

Since:

11 Jan 2024

See Also:

HAPI 3.1 sec 3.4

Method Summary

Modifier and Type	Method and Description
static HapiCapabilities	fromJson(org.json.JSONObject json) Reads HapiCapabilities from a JSON object, with structure defined by the HAPI capabilities endpoint.
HapiVersion	getHapiVersion() Returns the protocol version.
java.lang.String[]	getOutputFormats() Returns the supported output formats.

Method Detail

getHapiVersion

HapiVersion getHapiVersion()

Returns the protocol version.

Returns:

version object, not null

getOutputFormats

java.lang.String[] getOutputFormats()

Returns the supported output formats.

Returns:

output format list, not null and will contain at least one entry

fromJson

static HapiCapabilities fromJson(org.json.JSONObject json)

Reads HapiCapabilities from a JSON object, with structure defined by the HAPI capabilities endpoint.

Parameters:

json - JSON object

Returns:

capabilities object, not null