io.ebean

Class BeanFinder<I,T>

java.lang.Object

io.ebean.BeanFinder<I,T>

Type Parameters:

I - The ID type

T - The Bean type

Direct Known Subclasses:

BeanRepository

public abstract class BeanFinder<I,T>
extends Object

Provides finder functionality for use with "Dependency Injection style" use of Ebean.

Note that typically users would extend BeanRepository rather than BeanFinder.

public class CustomerFinder extends BeanFinder<Long,Customer> {

  @Inject
  public CustomerFinder(EbeanServer server) {
    super(Customer.class, server);
  }

  // ... add customer specific finders
}

Method Summary

Modifier and Type	Method and Description
Transaction	currentTransaction() Return the current transaction.
EbeanServer	db() Return the EbeanServer to use.
EbeanServer	db(String server) Return typically a different EbeanServer to the default.
void	deleteById(I id) Delete a bean by Id.
List<T>	findAll() Retrieves all entities of the given type.
T	findById(I id) Retrieves an entity by ID.
Optional<T>	findByIdOrEmpty(I id) Find an entity by ID returning an Optional.
void	flush() Flush the JDBC batch on the current transaction.
T	ref(I id) Creates an entity reference for this ID.

Methods inherited from class java.lang.Object

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

Method Detail

db

public EbeanServer db()

Return the EbeanServer to use.

currentTransaction

public Transaction currentTransaction()

Return the current transaction.

flush

public void flush()

Flush the JDBC batch on the current transaction.

db

public EbeanServer db(String server)

Return typically a different EbeanServer to the default.

This is equivalent to Ebean.getServer(String)

Parameters:

server - The name of the EbeanServer. If this is null then the default EbeanServer is returned.

ref

@Nonnull
public T ref(I id)

Creates an entity reference for this ID.

Equivalent to Database.getReference(Class, Object)

findById

@Nullable
public T findById(I id)

Retrieves an entity by ID.

Equivalent to Database.find(Class, Object)

findByIdOrEmpty

@Nullable
public Optional<T> findByIdOrEmpty(I id)

Find an entity by ID returning an Optional.

deleteById

public void deleteById(I id)

Delete a bean by Id.

Equivalent to Database.delete(Class, Object)

findAll

@Nonnull
public List<T> findAll()

Retrieves all entities of the given type.