doc/JavaDoc/ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242-release) on Fri Jun 04 18:15:41 CEST 2021 -->
<title>FirebaseDatabaseSnapshot</title>
<meta name="date" content="2021-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FirebaseDatabaseSnapshot";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseReference.html" title="class in ch.epfl.sdp.peakar.database.providers.firebase"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html" target="_top">Frames</a></li>
<li><a href="FirebaseDatabaseSnapshot.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ch.epfl.sdp.peakar.database.providers.firebase</div>
<h2 title="Class FirebaseDatabaseSnapshot" class="title">Class FirebaseDatabaseSnapshot</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ch.epfl.sdp.peakar.database.providers.firebase.FirebaseDatabaseSnapshot</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FirebaseDatabaseSnapshot</span>
extends java.lang.Object
implements <a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></pre>
<div class="block">This is a concrete implementation of DatabaseSnapshot.
Its implementation makes use of Firebase API, so needs to be modified if database provider is changed.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html#FirebaseDatabaseSnapshot-com.google.firebase.database.DataSnapshot-">FirebaseDatabaseSnapshot</a></span>(com.google.firebase.database.DataSnapshot firebaseDatabaseSnapshot)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html#child-java.lang.String-">child</a></span>(java.lang.String path)</code>
<div class="block">Get a snapshot of the given child.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html#exists--">exists</a></span>()</code>
<div class="block">Check if the current DB snapshot exists.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Iterable<<a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html#getChildren--">getChildren</a></span>()</code>
<div class="block">Give access to all of the immediate children of this snapshot.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html#getKey--">getKey</a></span>()</code>
<div class="block">Get the key of the current DB snapshot.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html#getValue--">getValue</a></span>()</code>
<div class="block">Get the value of the current DB snapshot.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><T> T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html#getValue-java.lang.Class-">getValue</a></span>(java.lang.Class<T> valueType)</code>
<div class="block">Get the value of the current DB snapshot.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FirebaseDatabaseSnapshot-com.google.firebase.database.DataSnapshot-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FirebaseDatabaseSnapshot</h4>
<pre>protected FirebaseDatabaseSnapshot(com.google.firebase.database.DataSnapshot firebaseDatabaseSnapshot)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="child-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>child</h4>
<pre>public <a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a> child(java.lang.String path)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#child-java.lang.String-">DatabaseSnapshot</a></code></span></div>
<div class="block">Get a snapshot of the given child.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#child-java.lang.String-">child</a></code> in interface <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - path of the new child from the current snapshot.</dd>
</dl>
</li>
</ul>
<a name="getKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKey</h4>
<pre>public java.lang.String getKey()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getKey--">DatabaseSnapshot</a></code></span></div>
<div class="block">Get the key of the current DB snapshot.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getKey--">getKey</a></code> in interface <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></code></dd>
</dl>
</li>
</ul>
<a name="getValue-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public <T> T getValue(@NonNull
java.lang.Class<T> valueType)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getValue-java.lang.Class-">DatabaseSnapshot</a></code></span></div>
<div class="block">Get the value of the current DB snapshot.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getValue-java.lang.Class-">getValue</a></code> in interface <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - type of the retrieved value.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>valueType</code> - type of the retrieved value.</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.Object getValue()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getValue--">DatabaseSnapshot</a></code></span></div>
<div class="block">Get the value of the current DB snapshot.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getValue--">getValue</a></code> in interface <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value as an object.</dd>
</dl>
</li>
</ul>
<a name="exists--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exists</h4>
<pre>public boolean exists()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#exists--">DatabaseSnapshot</a></code></span></div>
<div class="block">Check if the current DB snapshot exists.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#exists--">exists</a></code> in interface <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the snapshot is not empty, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getChildren--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getChildren</h4>
<pre>public java.lang.Iterable<<a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a>> getChildren()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getChildren--">DatabaseSnapshot</a></code></span></div>
<div class="block">Give access to all of the immediate children of this snapshot.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html#getChildren--">getChildren</a></code> in interface <code><a href="../../../../../../../ch/epfl/sdp/peakar/database/DatabaseSnapshot.html" title="interface in ch.epfl.sdp.peakar.database">DatabaseSnapshot</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseReference.html" title="class in ch.epfl.sdp.peakar.database.providers.firebase"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?ch/epfl/sdp/peakar/database/providers/firebase/FirebaseDatabaseSnapshot.html" target="_top">Frames</a></li>
<li><a href="FirebaseDatabaseSnapshot.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>