jetbrains.exodus.tree

Interface ITreeMutable

All Superinterfaces:

ITree

All Known Implementing Classes:

BTreeMutable

public interface ITreeMutable
extends ITree

Method Summary

Modifier and Type	Method and Description
boolean	add(@NotNull jetbrains.exodus.ByteIterable key, @NotNull jetbrains.exodus.ByteIterable value) If tree supports duplicates and key already exists, then return false.
boolean	add(@NotNull INode ln) If tree support duplicates and key already exists, then return false.
void	cursorClosed(@NotNull ITreeCursorMutable cursor)
boolean	delete(@NotNull jetbrains.exodus.ByteIterable key) Delete key/value pairs for given key.
boolean	delete(@NotNull jetbrains.exodus.ByteIterable key, @Nullable jetbrains.exodus.ByteIterable value, @Nullable ITreeCursorMutable cursorToSkip) Delete key/value pair, should be supported only by tree which allows duplicates if value is not null.
@NotNull jetbrains.exodus.tree.ExpiredLoggableCollection	getExpiredLoggables()
@Nullable java.lang.Iterable<ITreeCursorMutable>	getOpenCursors()
MutableTreeRoot	getRoot()
boolean	isAllowingDuplicates()
boolean	put(@NotNull jetbrains.exodus.ByteIterable key, @NotNull jetbrains.exodus.ByteIterable value) If tree supports duplicates, then add key/value pair.
void	put(@NotNull INode ln) If tree supports duplicates, then add key/value pair.
void	putRight(@NotNull jetbrains.exodus.ByteIterable key, @NotNull jetbrains.exodus.ByteIterable value) Add key/value pair with greatest (rightmost) key.
void	putRight(@NotNull INode ln) Add key/value pair with greatest (rightmost) key.
boolean	reclaim(@NotNull RandomAccessLoggable loggable, @NotNull java.util.Iterator<RandomAccessLoggable> loggables) Same as reclaim with expirationChecker, but takes all loggables into account
long	save() Save changes to log.

Methods inherited from interface jetbrains.exodus.tree.ITree

addressIterator, dump, dump, get, getDataIterator, getLog, getMutableCopy, getRootAddress, getSize, getStructureId, hasKey, hasPair, isEmpty, openCursor

Method Detail

getRoot

MutableTreeRoot getRoot()

isAllowingDuplicates

boolean isAllowingDuplicates()

getOpenCursors

@Nullable
@Nullable java.lang.Iterable<ITreeCursorMutable> getOpenCursors()

cursorClosed

void cursorClosed(@NotNull
                  @NotNull ITreeCursorMutable cursor)

put

boolean put(@NotNull
            @NotNull jetbrains.exodus.ByteIterable key,
            @NotNull
            @NotNull jetbrains.exodus.ByteIterable value)

If tree supports duplicates, then add key/value pair. If tree doesn't support duplicates and key already exists, then overwrite value. If tree doesn't support duplicates and key doesn't exists, then add key/value pair.

Parameters:

key - key.

value - value.

putRight

void putRight(@NotNull
              @NotNull jetbrains.exodus.ByteIterable key,
              @NotNull
              @NotNull jetbrains.exodus.ByteIterable value)

Add key/value pair with greatest (rightmost) key. In duplicates tree, value must be greatest too.

Parameters:

key - key.

value - value.

add

boolean add(@NotNull
            @NotNull jetbrains.exodus.ByteIterable key,
            @NotNull
            @NotNull jetbrains.exodus.ByteIterable value)

If tree supports duplicates and key already exists, then return false. If tree supports duplicates and key doesn't exists, then add key/value pair, return true. If tree doesn't support duplicates and key already exists, then return false. If tree doesn't support duplicates and key doesn't exists, then add key/value pair, return true.

Parameters:

key - key.

value - value.

Returns:

false if key exists and tree is not supports duplicates

put

void put(@NotNull
         @NotNull INode ln)

If tree supports duplicates, then add key/value pair. If tree doesn't support duplicates and key already exists, then overwrite value. If tree doesn't support duplicates and key doesn't exists, then add key/value pair.

Parameters:

ln - leaf node

putRight

void putRight(@NotNull
              @NotNull INode ln)

Add key/value pair with greatest (rightmost) key. In duplicates tree, value must be greatest too.

Parameters:

ln - leaf node, its key and values should be subtypes of ArrayByteIterable

add

boolean add(@NotNull
            @NotNull INode ln)

If tree support duplicates and key already exists, then return false. If tree support duplicates and key doesn't exists, then add key/value pair, return true. If tree doesn't support duplicates and key already exists, then return false. If tree doesn't support duplicates and key doesn't exists, then add key/value pair, return true.

Parameters:

ln - leaf node

Returns:

true if succeed

delete

boolean delete(@NotNull
               @NotNull jetbrains.exodus.ByteIterable key)

Delete key/value pairs for given key. If duplicate values exist for given key, all they will be removed.

Parameters:

key - key.

Returns:

false if key wasn't found

delete

boolean delete(@NotNull
               @NotNull jetbrains.exodus.ByteIterable key,
               @Nullable
               @Nullable jetbrains.exodus.ByteIterable value,
               @Nullable
               @Nullable ITreeCursorMutable cursorToSkip)

Delete key/value pair, should be supported only by tree which allows duplicates if value is not null.

Parameters:

key - key.

value - value.

cursorToSkip - mutable cursor to skip.

Returns:

false if key/value pair wasn't found

save

long save()

Save changes to log.

Returns:

address of new root page

getExpiredLoggables

@NotNull
@NotNull jetbrains.exodus.tree.ExpiredLoggableCollection getExpiredLoggables()

Returns:

set of expired loggables that were changed by put or delete methods.

reclaim

boolean reclaim(@NotNull
                @NotNull RandomAccessLoggable loggable,
                @NotNull
                @NotNull java.util.Iterator<RandomAccessLoggable> loggables)

Same as reclaim with expirationChecker, but takes all loggables into account

Parameters:

loggable - a candidate to reclaim.

loggables - loggables following the candidate.

Returns:

true if any loggable (the candidate or any among loggables) was reclaimed.