Class Cursor (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Cursor getDefaultInstance()
Returns
TypeDescription
Cursor

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Cursor.Builder newBuilder()
Returns
TypeDescription
Cursor.Builder

newBuilder(Cursor prototype)

public static Cursor.Builder newBuilder(Cursor prototype)
Parameter
NameDescription
prototypeCursor
Returns
TypeDescription
Cursor.Builder

parseDelimitedFrom(InputStream input)

public static Cursor parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cursor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Cursor parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cursor parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cursor parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Cursor parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Cursor parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cursor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cursor
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Cursor> parser()
Returns
TypeDescription
Parser<Cursor>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
boolean

The before.

getDefaultInstanceForType()

public Cursor getDefaultInstanceForType()
Returns
TypeDescription
Cursor

getParserForType()

public Parser<Cursor> getParserForType()
Returns
TypeDescription
Parser<Cursor>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.firestore.v1.ValueOrBuilder>

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Cursor.Builder newBuilderForType()
Returns
TypeDescription
Cursor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cursor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Cursor.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Cursor.Builder toBuilder()
Returns
TypeDescription
Cursor.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException