Package me.mrnavastar.sqlib.api

Class DataStore

java.lang.Object

me.mrnavastar.sqlib.api.DataStore

public class DataStore
extends Object

This class represents a table in a Database.

Constructor Summary

Constructors

Constructor	Description
DataStore(@NonNull String modId, @NonNull String name, @NonNull Database database, @NonNull SQLConnection connection)

Method Summary

Modifier and Type	Method	Description
DataContainer	createContainer()	Creates a new DataContainer
DataContainer	getContainer(int id)
DataContainer	getContainer(@NonNull String field, @NonNull Object value)
List<DataContainer>	getContainers()
List<DataContainer>	getContainers(@NonNull String field, @NonNull Object value)
Database	getDatabase()
String	getModId()
String	getName()
DataContainer	getOrCreateContainer(int id)	Tries to get a DataContainer or creates a new DataContainer if it is missing.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DataStore

public DataStore(@NonNull
 @NonNull String modId,
 @NonNull
 @NonNull String name,
 @NonNull
 @NonNull Database database,
 @NonNull
 @NonNull SQLConnection connection)

Method Details

toString

public String toString()

Overrides:

toString in class Object

createContainer

public DataContainer createContainer()

Creates a new DataContainer

getOrCreateContainer

public DataContainer getOrCreateContainer(int id)

Tries to get a DataContainer or creates a new DataContainer if it is missing. Note that the created DataContainer is not guaranteed to have the same id as the one passed in.

getContainer

public DataContainer getContainer(@NonNull
 @NonNull String field,
 @NonNull
 @NonNull Object value)

Returns:

A DataContainer's with a matching key value pair or null if one does not exist.

getContainer

public DataContainer getContainer(int id)

Returns:

A DataContainer or null if it is missing.

getContainers

public List<DataContainer> getContainers()

Returns:

A list of all the DataContainer's in this table.

getContainers

public List<DataContainer> getContainers(@NonNull
 @NonNull String field,
 @NonNull
 @NonNull Object value)

Returns:

A list of all the DataContainer's with a matching key value pair.

getModId

public String getModId()

getName

public String getName()

getDatabase

public Database getDatabase()