uk.ac.newcastle.team22.usb.firebase

Enum FirestoreDatabaseCollection

java.lang.Object

java.lang.Enum<FirestoreDatabaseCollection>

uk.ac.newcastle.team22.usb.firebase.FirestoreDatabaseCollection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FirestoreDatabaseCollection>

public enum FirestoreDatabaseCollection
extends java.lang.Enum<FirestoreDatabaseCollection>

A Firestore Database collection. See Firestore Data Model for more information on collections.

Version:

1.0

Author:

Alexander MacLeod

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAFE_MENU
CONFIGURATION
FLOORS
NAVIGATION_NODES
OPENING_HOURS
ROOMS
STAFF

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionIdentifier() Returns the identifier of the collection.
java.lang.Class<? extends FirestoreConstructable>	getDocumentType() Returns the class of each document in the collection.
static FirestoreDatabaseCollection	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FirestoreDatabaseCollection[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLOORS

public static final FirestoreDatabaseCollection FLOORS

ROOMS

public static final FirestoreDatabaseCollection ROOMS

STAFF

public static final FirestoreDatabaseCollection STAFF

CAFE_MENU

public static final FirestoreDatabaseCollection CAFE_MENU

NAVIGATION_NODES

public static final FirestoreDatabaseCollection NAVIGATION_NODES

OPENING_HOURS

public static final FirestoreDatabaseCollection OPENING_HOURS

CONFIGURATION

public static final FirestoreDatabaseCollection CONFIGURATION

Method Detail

values

public static FirestoreDatabaseCollection[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FirestoreDatabaseCollection c : FirestoreDatabaseCollection.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FirestoreDatabaseCollection valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCollectionIdentifier

@NotNull
public java.lang.String getCollectionIdentifier()

Returns the identifier of the collection.

getDocumentType

public java.lang.Class<? extends FirestoreConstructable> getDocumentType()

Returns the class of each document in the collection.