Package com.atlassian.bamboo.persister.xstream.journal

Interface XStreamJournal<K extends Key,V extends XStreamJournalEntry>

All Known Implementing Classes:

XStreamJournalImpl

@Internal
public interface XStreamJournal<K extends Key,V extends XStreamJournalEntry>

A utility to journal changes to an entity as list of XStream-ed objects.

Since:

9.5

Method Summary

Modifier and Type	Method	Description
boolean	appendToJournal(K key, V journalEntry)	Append an entry to the journal provided the journal is open.
void	closeJournal(K key)	Closes the journal.
@NotNull List<V>	loadJournal(K key)	Opens and loads entire journal for a key.
void	openJournal(K key)	Opens a journal for new item.

Method Detail

loadJournal

@NotNull
@NotNull List<V> loadJournal(@NotNull
                             K key)

Opens and loads entire journal for a key.

openJournal

void openJournal(@NotNull
                 K key)

Opens a journal for new item.

closeJournal

void closeJournal(@NotNull
                  K key)

Closes the journal. After this call no more entries are added to the journal and the journal file is deleted.

appendToJournal

boolean appendToJournal(@NotNull
                        K key,
                        @NotNull
                        V journalEntry)

Append an entry to the journal provided the journal is open.

Returns:

true if journal write actually happened.