Package org.yamcs.http.api

Class NamedObjectPageToken

java.lang.Object

org.yamcs.http.api.NamedObjectPageToken

public class NamedObjectPageToken
extends Object

Stateless continuation token for paged MDB requests.

Field Summary

Fields

Modifier and Type	Field	Description
String	name	Qualified name of the last object that was emitted.
boolean	spaceSystem	Whether this represents a space system.

Constructor Summary

Constructors

Constructor	Description
NamedObjectPageToken(String name, boolean spaceSystem)

Method Summary

Modifier and Type	Method	Description
static NamedObjectPageToken	decode(String encoded)
String	encodeAsString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

public String name

Qualified name of the last object that was emitted.

Consuming routes should not assume that this name still exists, and rather do an alphabetic comparison (this also implies that the endpoint should return results in alphabetic order.

spaceSystem

public boolean spaceSystem

Whether this represents a space system. Pagination is based on an ordering where space systems are returned before the actual items.

Constructor Details

NamedObjectPageToken

public NamedObjectPageToken(String name,
 boolean spaceSystem)

Method Details

decode

public static NamedObjectPageToken decode(String encoded)

encodeAsString

public String encodeAsString()