Class Cursor (3.25.1)

public final class Cursor extends GeneratedMessageV3 implements CursorOrBuilder

A position in a query result set.

Protobuf type google.firestore.v1.Cursor

Implements

CursorOrBuilder

Static Fields

BEFORE_FIELD_NUMBER

public static final int BEFORE_FIELD_NUMBER
Field Value
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Cursor getDefaultInstance()
Returns
Type Description
Cursor

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Cursor.Builder newBuilder()
Returns
Type Description
Cursor.Builder

newBuilder(Cursor prototype)

public static Cursor.Builder newBuilder(Cursor prototype)
Parameter
Name Description
prototype Cursor
Returns
Type Description
Cursor.Builder

parseDelimitedFrom(InputStream input)

public static Cursor parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cursor
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cursor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cursor
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Cursor parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Cursor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cursor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cursor parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Cursor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cursor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cursor parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Cursor
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cursor
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Cursor parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cursor
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cursor
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Cursor parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Cursor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cursor
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Cursor> parser()
Returns
Type Description
Parser<Cursor>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBefore()

public boolean getBefore()

If the position is just before or just after the given values, relative to the sort order defined by the query.

bool before = 2;

Returns
Type Description
boolean

The before.

getDefaultInstanceForType()

public Cursor getDefaultInstanceForType()
Returns
Type Description
Cursor

getParserForType()

public Parser<Cursor> getParserForType()
Returns
Type Description
Parser<Cursor>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValues(int index)

public Value getValues(int index)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name Description
index int
Returns
Type Description
Value

getValuesCount()

public int getValuesCount()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type Description
int

getValuesList()

public List<Value> getValuesList()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type Description
List<Value>

getValuesOrBuilder(int index)

public ValueOrBuilder getValuesOrBuilder(int index)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name Description
index int
Returns
Type Description
ValueOrBuilder

getValuesOrBuilderList()

public List<? extends ValueOrBuilder> getValuesOrBuilderList()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type Description
List<? extends com.google.firestore.v1.ValueOrBuilder>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Cursor.Builder newBuilderForType()
Returns
Type Description
Cursor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cursor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Cursor.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Cursor.Builder toBuilder()
Returns
Type Description
Cursor.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException