DataSnapshot

public classDataSnapshot


A DataSnapshot instance contains data from a Firebase Database location. Any time you read Database data, you receive the data as a DataSnapshot. DataSnapshots are passed to the methods in listeners that you attach withaddValueEventListener,addChildEventListener, oraddListenerForSingleValueEvent. They are efficiently-generated immutable copies of the data at a Firebase Database location. They can't be modified and will never change. To modify data at a location, use aDatabaseReference reference (e.g. withsetValue).

Summary

Public methods

@NonNullDataSnapshot

Get a DataSnapshot for the location at the specified relative path.

boolean

Returns true if the snapshot contains a non-null value.

@NonNullIterable<DataSnapshot>

Gives access to all of the immediate children of this snapshot.

long
@NullableString
@NullableObject

Returns the priority of the data contained in this snapshot as a native type.

@NonNullDatabaseReference

Used to obtain a reference to the source location for this snapshot.

@NullableObject

getValue() returns the data contained in this snapshot as native types.

@Nullable T

Due to the way that Java implements generics, it takes an extra step to get back a properly-typed Collection.

@NullableObject
getValue(boolean useExportFormat)

getValue() returns the data contained in this snapshot as native types.

@Nullable T
<T>getValue(@NonNullClass<T> valueType)

This method is used to marshall the data contained in this snapshot into a class of your choosing.

boolean

Can be used to determine if this DataSnapshot has data at a particular location

boolean

Indicates whether this snapshot has any children

String

Extension functions

final T

Returns the content of the DataSnapshot converted to a POJO.

Public methods

child

public @NonNullDataSnapshot child(@NonNullString path)

Get a DataSnapshot for the location at the specified relative path. The relative path can either be a simple child key (e.g. 'fred') or a deeper slash-separated path (e.g. 'fred/name/first'). If the child location has no data, an empty DataSnapshot is returned.

Parameters
@NonNullString path

A relative path to the location of child data

Returns
@NonNullDataSnapshot

The DataSnapshot for the child location

exists

public boolean exists()

Returns true if the snapshot contains a non-null value.

Returns
boolean

True if the snapshot contains a non-null value, otherwise false

getChildren

public @NonNullIterable<DataSnapshotgetChildren()

Gives access to all of the immediate children of this snapshot. Can be used in native for loops:

for (DataSnapshot child : parent.getChildren()) {      ...}
Returns
@NonNullIterable<DataSnapshot>

The immediate children of this snapshot

getChildrenCount

public long getChildrenCount()
Returns
long

The number of immediate children in the this snapshot

getKey

public @NullableString getKey()
Returns
@NullableString

The key name for the source location of this snapshot or null if this snapshot points to the database root.

getPriority

public @NullableObject getPriority()

Returns the priority of the data contained in this snapshot as a native type. Possible return types:

  • Double
  • String
Note that null is also allowed
Returns
@NullableObject

the priority of the data contained in this snapshot as a native type

getRef

public @NonNullDatabaseReference getRef()

Used to obtain a reference to the source location for this snapshot.

Returns
@NonNullDatabaseReference

A DatabaseReference corresponding to the location that this snapshot came from

getValue

public @NullableObject getValue()

getValue() returns the data contained in this snapshot as native types. The possible types returned are:

  • Boolean
  • String
  • Long
  • Double
  • Map<String, Object>
  • List<Object>
This list is recursive; the possible types forjava.lang.Object in the above list is given by the same list. These types correspond to the types available in JSON.
Returns
@NullableObject

The data contained in this snapshot as native types or null if there is no data at this location.

getValue

public @Nullable T <T>getValue(@NonNullGenericTypeIndicator<T> t)

Due to the way that Java implements generics, it takes an extra step to get back a properly-typed Collection. So, in the case where you want ajava.util.List of Message instances, you will need to do something like the following:

    GenericTypeIndicator<List<Message>> t = new GenericTypeIndicator<List<Message>>() {};    List<Message> messages = snapshot.getValue(t);
It is important to use a subclass ofGenericTypeIndicator. SeeGenericTypeIndicator for more details
Parameters
<T>

The type to return. Implicitly defined from theGenericTypeIndicator passed in

@NonNullGenericTypeIndicator<T> t

A subclass ofGenericTypeIndicator indicating the type of generic collection to be returned.

Returns
@Nullable T

A properly typed collection, populated with the data from this snapshot, or null if there is no data at this location.

getValue

public @NullableObject getValue(boolean useExportFormat)

getValue() returns the data contained in this snapshot as native types. The possible types returned are:

  • Boolean
  • String
  • Long
  • Double
  • Map<String, Object>
  • List<Object>
This list is recursive; the possible types forjava.lang.Object in the above list is given by the same list. These types correspond to the types available in JSON.

If useExportFormat is set to true, priority information will be included in the output. Priority information shows up as a .priority key in a map. For data that would not otherwise be a map, the map will also include a .value key with the data.

Parameters
boolean useExportFormat

Whether or not to include priority information

Returns
@NullableObject

The data in native types, along with its priority, or null if there is no data at this location.

getValue

public @Nullable T <T>getValue(@NonNullClass<T> valueType)

This method is used to marshall the data contained in this snapshot into a class of your choosing. The class must fit 2 simple constraints:

  1. The class must have a default constructor that takes no arguments
  2. The class must define public getters for the properties to be assigned. Properties without a public getter will be set to their default value when an instance is deserialized
An example class might look like:
classMessage {privateStringauthor;privateStringtext;privateMessage() {}publicMessage(Stringauthor,Stringtext) {this.author =author;this.text =text;        }publicStringgetAuthor() {returnauthor;        }publicStringgetText() {returntext;        }    }    //LaterMessagem = snapshot.getValue(Message.class);
Parameters
<T>

The type to return. Implicitly defined from the class passed in

@NonNullClass<T> valueType

The class into which this snapshot should be marshalled

Returns
@Nullable T

An instance of the class passed in, populated with the data from this snapshot, or null if there is no data at this location.

hasChild

public boolean hasChild(@NonNullString path)

Can be used to determine if this DataSnapshot has data at a particular location

Parameters
@NonNullString path

A relative path to the location of child data

Returns
boolean

Whether or not the specified child location has data

hasChildren

public boolean hasChildren()

Indicates whether this snapshot has any children

Returns
boolean

True if the snapshot has any children, otherwise false

toString

public String toString()

Extension functions

DatabaseKt.getValue

public final T <T extends Object>DatabaseKt.getValue(@NonNullDataSnapshot receiver)

Returns the content of the DataSnapshot converted to a POJO.

Supports generics like List<> or Map<>. Use @JvmSuppressWildcards to force the compiler to use the typeT, and not? extends T.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-21 UTC.