Package com.appliedolap.essbase

Record Class EssApiSpec

java.lang.Object

java.lang.Record

com.appliedolap.essbase.EssApiSpec

Record Components:

format - openapi or swagger, reflecting which specification the document follows; Essbase moved from Swagger 2.0 to OpenAPI 3.0 between 21.7 and 26.1

version - the specification version the document declares, e.g. 3.0.1

json - the document exactly as the server served it, unparsed - the point of fetching it is usually to keep or feed it to something else, and reserialising would gratuitously reformat it

public record EssApiSpec(String format, String version, String json)
extends Record

The server's own machine-readable description of its REST API - what its Swagger UI renders.

Constructor Summary

Constructors

Constructor	Description
EssApiSpec(String format, String version, String json)	Creates an instance of a EssApiSpec record class.

Method Summary

Modifier and Type	Method	Description
String	describe()	e.g.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	format()	Returns the value of the format record component.
final int	hashCode()	Returns a hash code value for this object.
String	json()	Returns the value of the json record component.
final String	toString()	Returns a string representation of this record class.
String	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

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

Constructor Details

EssApiSpec

public EssApiSpec(String format,
 String version,
 String json)

Creates an instance of a EssApiSpec record class.

Parameters:

format - the value for the format record component

version - the value for the version record component

json - the value for the json record component

Method Details

describe

public String describe()

e.g. OpenAPI 3.0.1, for telling someone what they just got.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

format

public String format()

Returns the value of the format record component.

Returns:

the value of the format record component

version

public String version()

Returns the value of the version record component.

Returns:

the value of the version record component

json

public String json()

Returns the value of the json record component.

Returns:

the value of the json record component