Package com.qtsurfer.api.sdk

Enum Class SweepOrder

java.lang.Object

java.lang.Enum<SweepOrder>

com.qtsurfer.api.sdk.SweepOrder

All Implemented Interfaces:

Serializable, Comparable<SweepOrder>, Constable

public enum SweepOrder
extends Enum<SweepOrder>

Which view of a sweep's rows to read: the display leaderboard, or every row in a stable order.

The two answer different questions, and the choice decides whether SweepRanking means anything at all — see NATURAL.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NATURAL	Every available row, untruncated, in deterministic runIx order.
RANKED	The display leaderboard: sorted, and capped at a display limit.

Method Summary

Modifier and Type	Method	Description
static SweepOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SweepOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
String	wire()	Internal: the value sent as the order query parameter.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RANKED

public static final SweepOrder RANKED

The display leaderboard: sorted, and capped at a display limit.

This is the platform default, and the view SweepRanking applies to. ExecuteSweepResult.getTruncated() is true when the cap actually bit, in which case rows exist that this view does not carry — NATURAL is how to reach them.

NATURAL

public static final SweepOrder NATURAL

Every available row, untruncated, in deterministic runIx order.

This is the view to read when you are materialising durable trial rows rather than showing a top-N, and the only way to reach rows the ranked view dropped when ExecuteSweepResult.getTruncated() is true.

SweepRanking is ignored here. This view is always ordered by runIx, so a plateau or raw preference set alongside it has no effect and the response reports raw. Rank, plateau score and neighbour count belong to the ranked view and are not part of this one.

Method Details

values

public static SweepOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SweepOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

wire

public String wire()

Internal: the value sent as the order query parameter. Exposed so the SDK's own helpers can pass it through without re-encoding.

Returns:

the wire token for this view