Summary: Methods | [Expand All]
public interface

ConfluenceBandanaRecordDao

com.atlassian.confluence.setup.bandana.persistence.dao.ConfluenceBandanaRecordDao
Known Indirect Subclasses

Class Overview

Interface for DAOs which handle persistence of ConfluenceBandanaRecord instances.

Summary

Public Methods
Iterable<ConfluenceBandanaRecord> findAllWithKey(String key)
Returns all records that have a certain key, regardless of context.
Collection findForContext(String context)
Return all the records for the given context.
Iterable<String> findKeysForContext(String context)
Returns all keys for the given context.
ConfluenceBandanaRecord getRecord(String context, String key)
Retrieve a record for the given key, return null if no record exists
void remove(ConfluenceBandanaRecord record)
Remove a record by matching its key (context, key)
void removeAllInContext(String context)
Remove all the records belonging to the given context
void saveOrUpdate(ConfluenceBandanaRecord record)
Save the record, updating it if it already exists.

Public Methods

public Iterable<ConfluenceBandanaRecord> findAllWithKey (String key)

Returns all records that have a certain key, regardless of context. Calling this method is likely to be inefficient, and shouldn't be used unnecessarily.

Parameters
key the bandana key to look up

public Collection findForContext (String context)

Return all the records for the given context. Returns an empty collection if no records are found.

public Iterable<String> findKeysForContext (String context)

Returns all keys for the given context.

public ConfluenceBandanaRecord getRecord (String context, String key)

Retrieve a record for the given key, return null if no record exists

Returns
  • the matching record, or null

public void remove (ConfluenceBandanaRecord record)

Remove a record by matching its key (context, key)

public void removeAllInContext (String context)

Remove all the records belonging to the given context

public void saveOrUpdate (ConfluenceBandanaRecord record)

Save the record, updating it if it already exists.

Parameters
record the ConfluenceBandanaRecord to update