uk.ac.newcastle.team22.usb.firebase

Interface FirestoreConstructable<T>

All Known Implementing Classes:

CafeMenuItem, Floor, Node, OpeningHours, Room, StaffMember, USBConfiguration

public interface FirestoreConstructable<T>

An interface which declares an object as constructable from a Firestore document dictionary. See FirebaseManager for more information on retrieving Firestore document dictionaries.

Version:

1.0

Author:

Alexander MacLeod

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FirestoreConstructable.InitialisationFailed The exception to throw when the initialisation of a FirestoreConstructable object fails.

Method Summary

Modifier and Type	Method and Description
T	initFromFirebase(java.util.Map<java.lang.String,java.lang.Object> firestoreDictionary, java.lang.String documentIdentifier) Constructs the object from a Firestore document dictionary.

Method Detail

initFromFirebase

T initFromFirebase(java.util.Map<java.lang.String,java.lang.Object> firestoreDictionary,
                   java.lang.String documentIdentifier)
            throws FirestoreConstructable.InitialisationFailed

Constructs the object from a Firestore document dictionary.

Parameters:

firestoreDictionary - The Firestore document dictionary.

documentIdentifier - The identifier of the Firestore document.

Returns:

The initialised object.

Throws:

FirestoreConstructable.InitialisationFailed