Package com.barden.library.database.mongo.structure

Class DatabaseStructure<P,F extends DatabaseField<P>>

java.lang.Object

com.barden.library.database.mongo.structure.DatabaseStructure<P,F>

Type Parameters:

P - Parent object.

F - Database field enum.

public abstract class DatabaseStructure<P,F extends DatabaseField<P>>
extends Object

Database structure class to handle database methods.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<F>	field
protected final P	parent

Constructor Summary

Constructors

Constructor	Description
DatabaseStructure(P parent, Class<F> field, DatabaseMongoProvider mongoProvider)	Creates a database structure with given parent and field.

Method Summary

Modifier and Type	Method	Description
final void	delete()	Deletes database structure from the database.
final void	deleteAsync()	Deletes database structure from the database.
final Class<F>	getField()	Gets field class.
DatabaseMongoProvider	getMongoProvider()	Gets mongo provider.
final P	getParent()	Gets parent.
void	save()	Saves database structure to the database with all fields.
void	save(F... fields)	Saves database structure to the database.
void	save(Collection<F> fields)	Saves database structure to the database.
final void	saveAsync()	Saves database structure to the database with all fields.
void	saveAsync(F... fields)	Saves database structure to the database async.
void	saveAsync(Collection<F> fields)	Saves database structure to the database.
final org.bson.BsonValue	toBsonValue(F field)	Gets bson value from field.
final org.bson.conversions.Bson	toQueryBson()	Gets query field.
final org.bson.conversions.Bson	toSaveBson()	Gets parent as a save bson.
final org.bson.conversions.Bson	toSaveBson(F... fields)	Gets save bson with target fields.

Methods inherited from class java.lang.Object

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

Field Details

parent

protected final P parent

field

protected final Class<F extends DatabaseField<P>> field

Constructor Details

DatabaseStructure

public DatabaseStructure(@NotNull
 P parent,
 @NotNull
 Class<F> field,
 @NotNull
 DatabaseMongoProvider mongoProvider)

Creates a database structure with given parent and field.

Parameters:

parent - DatabaseStructure

field - DatabaseStructure Database field enum.

mongoProvider - DatabaseMongoProvider

Throws:

NullPointerException - If or or is null.

Method Details

getParent

@NotNull
public final P getParent()

Gets parent.

Returns:

DatabaseStructure

getField

@NotNull
public final Class<F> getField()

Gets field class.

Returns:

Class of DatabaseStructure

getMongoProvider

@NotNull
public DatabaseMongoProvider getMongoProvider()

Gets mongo provider.

Returns:

DatabaseMongoProvider

save

public void save(@NotNull
 F... fields)

Saves database structure to the database.

Parameters:

fields - DatabaseStructure fields to save.

Throws:

NullPointerException - If is null.

save

public void save(@NotNull
 Collection<F> fields)

Saves database structure to the database.

Parameters:

fields - DatabaseStructure fields to save.

Throws:

NullPointerException - If is null.

save

public void save()

Saves database structure to the database with all fields.

saveAsync

public void saveAsync(@NotNull
 F... fields)

Saves database structure to the database async.

Parameters:

fields - DatabaseStructure fields to save.

saveAsync

public void saveAsync(@NotNull
 Collection<F> fields)

Saves database structure to the database. (ASYNC)

Parameters:

fields - DatabaseStructure fields to save.

saveAsync

public final void saveAsync()

Saves database structure to the database with all fields. (ASYNC)

delete

public final void delete()

Deletes database structure from the database.

deleteAsync

public final void deleteAsync()

Deletes database structure from the database. (ASYNC)

toQueryBson

@NotNull
public final org.bson.conversions.Bson toQueryBson()

Gets query field.

Returns:

Bson

toSaveBson

@NotNull
public final org.bson.conversions.Bson toSaveBson()

Gets parent as a save bson. With save bson, we can update mongo document.

Returns:

Bson

toSaveBson

@SafeVarargs
@NotNull
public final org.bson.conversions.Bson toSaveBson(@NotNull
 F... fields)

Gets save bson with target fields.

Parameters:

fields - DatabaseStructure fields to save.

Returns:

Bson

Throws:

NullPointerException - If is null.

toBsonValue

@NotNull
public final org.bson.BsonValue toBsonValue(@NotNull
 F field)

Gets bson value from field.

Parameters:

field - DatabaseStructure field to get value from.

Returns:

Bson