AbstractDatabaseCollection (PretronicDatabaseQuery 1.1.0.24 API)

java.lang.Object
- net.pretronic.databasequery.common.collection.AbstractDatabaseCollection<T>

All Implemented Interfaces:: DatabaseCollection

Direct Known Subclasses:: MongoDBDatabaseCollection, SQLDatabaseCollection

public abstract class AbstractDatabaseCollection<T extends Database>
extends Object
implements DatabaseCollection

Field Summary

Fields
Modifier and Type Field Description

private T database

private String name

private DatabaseCollectionType type

Fields
Modifier and Type	Field	Description
`private T`	`database`
`private String`	`name`
`private DatabaseCollectionType`	`type`

Constructor Summary

Constructors
Constructor Description

AbstractDatabaseCollection(String name, T database, DatabaseCollectionType type)

Constructors
Constructor	Description
`AbstractDatabaseCollection(String name, T database, DatabaseCollectionType type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CompletableFuture<Void>`	`clearAsync()`	Clear all data in this `DatabaseCollection` async.
`CompletableFuture<Void>`	`dropAsync()`	Drops this `DatabaseCollection` async.
`T`	`getDatabase()`	Returns the `Database` on which this `DatabaseCollection` is hold.
`CompletableFuture<CollectionField>`	`getFieldAsync(String name)`	Returns `DatabaseCollection.getField(String)` async.
`CompletableFuture<Collection<CollectionField>>`	`getFieldsAsync()`	Returns `DatabaseCollection.getFields()` async.
`String`	`getName()`	Returns the name of this database collection.
`CompletableFuture<Long>`	`getSizeAsync()`	Returns the size of the `DatabaseCollection` async.
`DatabaseCollectionType`	`getType()`	Returns the `DatabaseCollectionType` of this database collection type.
`CompletableFuture<Boolean>`	`hasFieldAsync(String name)`	Returns `DatabaseCollection.hasField(String)` async.

Methods inherited from interface net.pretronic.databasequery.api.collection.DatabaseCollection
addField, as, clear, delete, drop, find, getField, getFields, getSize, group, hasField, insert, replace, transact, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
private final String name
```
  - database
```
private final T extends Database database
```
  - type
```
private final DatabaseCollectionType type
```
- Constructor Detail
  - AbstractDatabaseCollection
```
public AbstractDatabaseCollection(String name,
                                  T database,
                                  DatabaseCollectionType type)
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: DatabaseCollection
    
    Returns the name of this database collection.
    
    Specified by:
    
    getName in interface DatabaseCollection
    
    Returns:
    
    name
  - getDatabase
```
public T getDatabase()
```
    Description copied from interface: DatabaseCollection
    
    Returns the Database on which this DatabaseCollection is hold.
    
    Specified by:
    
    getDatabase in interface DatabaseCollection
    
    Returns:
    
    database
  - getType
```
public DatabaseCollectionType getType()
```
    Description copied from interface: DatabaseCollection
    
    Returns the DatabaseCollectionType of this database collection type. The type may be incorrect when retrieving and not creating this DatabaseCollection and then it's DatabaseCollectionType.NORMAL.
    
    Specified by:
    
    getType in interface DatabaseCollection
    
    Returns:
    
    type of collection
  - getSizeAsync
```
public CompletableFuture<Long> getSizeAsync()
```
    Description copied from interface: DatabaseCollection
    
    Returns the size of the DatabaseCollection async.
    
    Specified by:
    
    getSizeAsync in interface DatabaseCollection
    
    Returns:
    
    completable future of size
  - dropAsync
```
public CompletableFuture<Void> dropAsync()
```
    Description copied from interface: DatabaseCollection
    
    Drops this DatabaseCollection async.
    
    Specified by:
    
    dropAsync in interface DatabaseCollection
    
    Returns:
    
    completable future if dropped
  - clearAsync
```
public CompletableFuture<Void> clearAsync()
```
    Description copied from interface: DatabaseCollection
    
    Clear all data in this DatabaseCollection async.
    
    Specified by:
    
    clearAsync in interface DatabaseCollection
    
    Returns:
    
    completable future if cleared
  - getFieldsAsync
```
public CompletableFuture<Collection<CollectionField>> getFieldsAsync()
```
    Description copied from interface: DatabaseCollection
    
    Returns DatabaseCollection.getFields() async.
    
    Specified by:
    
    getFieldsAsync in interface DatabaseCollection
    
    Returns:
    
    future of fields
  - getFieldAsync
```
public CompletableFuture<CollectionField> getFieldAsync(String name)
```
    Description copied from interface: DatabaseCollection
    
    Returns DatabaseCollection.getField(String) async.
    
    Specified by:
    
    getFieldAsync in interface DatabaseCollection
    
    Parameters:
    
    name - of field
    
    Returns:
    
    the field in the database collection async
  - hasFieldAsync
```
public CompletableFuture<Boolean> hasFieldAsync(String name)
```
    Description copied from interface: DatabaseCollection
    
    Returns DatabaseCollection.hasField(String) async.
    
    Specified by:
    
    hasFieldAsync in interface DatabaseCollection
    
    Parameters:
    
    name - of field
    
    Returns:
    
    if field exist or not

Class AbstractDatabaseCollection<T extends Database>

Field Summary

Constructor Summary

Method Summary

Methods inherited from interface net.pretronic.databasequery.api.collection.DatabaseCollection

Methods inherited from class java.lang.Object

Field Detail

name

database

type

Constructor Detail

AbstractDatabaseCollection

Method Detail

getName

getDatabase

getType

getSizeAsync

dropAsync

clearAsync

getFieldsAsync

getFieldAsync

hasFieldAsync