Side of Software
Persistence Library 2.0
A C D E F G I L N O P R S T U V W

A

abortTransaction() - Method in class sos.db.AbstractDatabase
 
abortTransaction() - Method in interface sos.db.Database
Aborts all changes under the calling thread's current transaction.
AbstractDatabase - Class in sos.db
A partial implementation of a database.
AbstractDatabase() - Constructor for class sos.db.AbstractDatabase
Creates a new instance of AbstractDatabase.
AbstractSerializationDatabase - Class in sos.db
A partial implementation of a serialization-based database.
AbstractSerializationDatabase(String, TransactionPolicy) - Constructor for class sos.db.AbstractSerializationDatabase
Creates an AbstractSerializationDatabase with the specified database name and transaction policy.
AbstractTransactionPolicy - Class in sos.db
A partial implementation of TransactionPolicy.
AbstractTransactionPolicy() - Constructor for class sos.db.AbstractTransactionPolicy
 
acquireReadLock(TransactionSupport) - Method in class sos.db.DefaultReadWriteTransactionPolicy
Acquires a read lock for the key referenced by support.
acquireWriteLock(TransactionSupport) - Method in class sos.db.DefaultReadWriteTransactionPolicy
Acquires a write lock for the key referenced by support.
addAbortAction(Runnable) - Method in interface sos.db.TransactionSupport
Registers an action to be run when the transaction aborts.
addCommitAction(Runnable) - Method in interface sos.db.TransactionSupport
Registers an action to be run when the top-level transaction commits.
addObject(Object) - Method in class sos.db.AbstractDatabase
 
addObject(Object) - Method in interface sos.db.Database
Adds the specified object to this database and returns a proxy object that the client should use instead.

C

close() - Method in class sos.db.AbstractDatabase
 
close() - Method in interface sos.db.Database
Closes this database.
commitTransaction(Progress) - Method in class sos.db.AbstractDatabase
 
commitTransaction(Progress) - Method in interface sos.db.Database
Commits all changes under the calling thread's current transaction.
containsObject(Object) - Method in class sos.db.AbstractDatabase
 
containsObject(Object) - Method in interface sos.db.Database
Returns true if this database contains the specified object.
create(Object) - Method in class sos.db.AbstractDatabase
 
create(Object) - Method in interface sos.db.Database
Creates a new database if and only if it does not exist.
createDefaultTransactionPolicy() - Method in class sos.db.AbstractSerializationDatabase
Creates and returns a default transaction policy.

D

Database - Interface in sos.db
A database of objects.
DatabaseCorruptedException - Exception in sos.db
A checked exception indicating that a database is corrupted and cannot be repaired.
DatabaseCorruptedException() - Constructor for exception sos.db.DatabaseCorruptedException
Creates an instance of DatabaseCorruptedException with a null detail message.
DatabaseCorruptedException(String) - Constructor for exception sos.db.DatabaseCorruptedException
Creates an instance of DatabaseCorruptedException with the specified detail message.
DatabaseException - Exception in sos.db
A parent exception to a variety of database exceptions.
DatabaseException() - Constructor for exception sos.db.DatabaseException
Creates an instance of DatabaseException with a null detail message.
DatabaseException(String) - Constructor for exception sos.db.DatabaseException
Creates an instance of DatabaseException with the specified detail message.
DatabaseException(Throwable) - Constructor for exception sos.db.DatabaseException
Creates an instance of DatabaseException with a null detail message and the specified cause.
DatabaseException(String, Throwable) - Constructor for exception sos.db.DatabaseException
Creates an instance of DatabaseException with the specified detail message and cause.
DefaultReadWriteTransactionPolicy - Class in sos.db
A transaction policy that uses strict two phase locking (2PL) to ensure that transactions appear to execute sequentially and that uses lock timeouts to break potential deadlock.
DefaultReadWriteTransactionPolicy() - Constructor for class sos.db.DefaultReadWriteTransactionPolicy
Creates an instance of DefaultReadWriteTransactionPolicy with default timeout intervals of one minute each.
DefaultReadWriteTransactionPolicy(long, long) - Constructor for class sos.db.DefaultReadWriteTransactionPolicy
Creates an instance of DefaultReadWriteTransactionPolicy with the specified timeout intervals.
DefaultTransactionPolicy - Class in sos.db
A transaction policy that uses a single database lock to ensure that transactions appear to execute sequentially.
DefaultTransactionPolicy() - Constructor for class sos.db.DefaultTransactionPolicy
Creates an instance of DefaultTransactionPolicy with a default lock timeout of Long.MAX_VALUE milliseconds.
DefaultTransactionPolicy(long) - Constructor for class sos.db.DefaultTransactionPolicy
Creates an instance of DefaultTransactionPolicy with the specified lock timeout.
DEFERRED_WRITE - Static variable in class sos.db.ReadOnlyManager
A constant that indicates that a method does not modify its receiver except possibly through the returned object.
delete() - Method in class sos.db.AbstractDatabase
 
delete() - Method in interface sos.db.Database
Deletes this database.
doAbortTransaction() - Method in class sos.db.AbstractDatabase
Performs the action of abortTransaction.
doAbortTransaction() - Method in class sos.db.AbstractSerializationDatabase
 
doAddObject(Object) - Method in class sos.db.AbstractDatabase
Performs the action of addObject.
doAddObject(Object) - Method in class sos.db.AbstractSerializationDatabase
 
doClose() - Method in class sos.db.AbstractDatabase
Performs the action of close.
doClose() - Method in class sos.db.AbstractSerializationDatabase
 
doClose() - Method in class sos.db.FileDatabase
 
doCommitTransaction(Progress) - Method in class sos.db.AbstractDatabase
Performs the action of commitTransaction.
doCommitTransaction(Progress) - Method in class sos.db.AbstractSerializationDatabase
 
doContainsObject(Object) - Method in class sos.db.AbstractDatabase
Performs the action of containsObject.
doContainsObject(Object) - Method in class sos.db.AbstractSerializationDatabase
 
doCreate(Object) - Method in class sos.db.AbstractDatabase
Performs the action of create.
doCreate(Object) - Method in class sos.db.AbstractSerializationDatabase
 
doCreate(Object) - Method in class sos.db.FileDatabase
 
doDelete() - Method in class sos.db.AbstractDatabase
Performs the action of delete.
doDelete() - Method in class sos.db.AbstractSerializationDatabase
 
doDelete() - Method in class sos.db.FileDatabase
 
doDelete() - Method in class sos.db.InMemoryDatabase
 
doExists() - Method in class sos.db.AbstractDatabase
Performs the action of exists.
doExists() - Method in class sos.db.FileDatabase
 
doExists() - Method in class sos.db.InMemoryDatabase
 
doFetchObject(long) - Method in class sos.db.AbstractSerializationDatabase
Returns the serialized object associated with id.
doFetchObject(long) - Method in class sos.db.FileDatabase
 
doFetchObject(long) - Method in class sos.db.InMemoryDatabase
 
doFlush(LongMap<byte[]>, LongMap<byte[]>, Progress) - Method in class sos.db.AbstractSerializationDatabase
Adds new objects, re-saves modified objects, and removes old objects from this database in a single, atomic step.
doFlush(LongMap<byte[]>, LongMap<byte[]>, Progress) - Method in class sos.db.FileDatabase
 
doFlush(LongMap<byte[]>, LongMap<byte[]>, Progress) - Method in class sos.db.InMemoryDatabase
 
doGetRoot() - Method in class sos.db.AbstractDatabase
Performs the action of getRoot.
doGetRoot() - Method in class sos.db.AbstractSerializationDatabase
 
doNextKey(long) - Method in class sos.db.AbstractSerializationDatabase
Returns the next key greater than or equal to fromKey that corresponds to an object in this database.
doNextKey(long) - Method in class sos.db.FileDatabase
 
doNextKey(long) - Method in class sos.db.InMemoryDatabase
 
doOpen(boolean) - Method in class sos.db.AbstractDatabase
Performs the action of open.
doOpen(boolean) - Method in class sos.db.AbstractSerializationDatabase
 
doOpen(boolean) - Method in class sos.db.FileDatabase
 
doRemoveObject(long) - Method in class sos.db.AbstractSerializationDatabase
Removes the specified object from this database.
doRemoveObject(long) - Method in class sos.db.FileDatabase
 
doRemoveObject(long) - Method in class sos.db.InMemoryDatabase
 
doStartTransaction() - Method in class sos.db.AbstractDatabase
Performs the action of startTransaction.
doStartTransaction() - Method in class sos.db.AbstractSerializationDatabase
 
doTransactionDepth() - Method in class sos.db.AbstractDatabase
Performs the action of transactionDepth.
doTransactionDepth() - Method in class sos.db.AbstractSerializationDatabase
 

E

enableReplaceObject(boolean) - Method in class sos.db.AbstractSerializationDatabase
Enables the substitution of objects during serialization.
entryIterator() - Method in class sos.db.LongMap
Returns a read-only iterator that iterates through this map's entries.
exists() - Method in class sos.db.AbstractDatabase
 
exists() - Method in interface sos.db.Database
Returns true if this database exists.

F

FileDatabase - Class in sos.db
A persistent database that stores objects in a random-access file.
FileDatabase(String, String) - Constructor for class sos.db.FileDatabase
Creates a FileDatabase with the specified database name.
FileDatabase(String, String, TransactionPolicy) - Constructor for class sos.db.FileDatabase
Creates a FileDatabase with the specified database name and transaction policy.

G

get(long) - Method in class sos.db.LongMap
Returns the object mapped to key, or null if no such mapping exists.
getDatabase() - Method in interface sos.db.TransactionSupport
Returns the database for which this transaction is occurring.
getKey() - Method in class sos.db.LongMap.Entry
Returns the mapping's key.
getKey() - Method in interface sos.db.TransactionSupport
Returns a key that uniquely identifies the object.
getMethodStatus(Method) - Method in class sos.db.AbstractTransactionPolicy
Returns the specified method's read-only status.
getMethodStatus(Method) - Static method in class sos.db.ReadOnlyManager
Returns the registered read-only status of the specified method.
getMethodStatus(String) - Static method in class sos.db.ReadOnlyManager
Returns the registered read-only status of the method with the specified descriptor.
getName() - Method in class sos.db.AbstractSerializationDatabase
 
getName() - Method in interface sos.db.Database
Returns the name of this database.
getObjectForRead() - Method in interface sos.db.TransactionSupport
Prepares and returns the object for reading.
getObjectForWrite() - Method in interface sos.db.TransactionSupport
Prepares and returns the object for writing.
getProxy() - Method in interface sos.db.TransactionSupport
Returns the database proxy object overseeing the object.
getRoot() - Method in class sos.db.AbstractDatabase
 
getRoot() - Method in interface sos.db.Database
Returns the root object of this database.
getTransactionPolicy() - Method in class sos.db.AbstractSerializationDatabase
 
getTransactionPolicy() - Method in interface sos.db.Database
Returns the transaction policy governing the transactions.
getValue() - Method in class sos.db.LongMap.Entry
Returns the mapping's value.

I

InMemoryDatabase - Class in sos.db
A non-persistent database that stores objects in memory.
InMemoryDatabase(String) - Constructor for class sos.db.InMemoryDatabase
Creates an instance of InMemoryDatabase with the specified database name.
InMemoryDatabase(String, TransactionPolicy) - Constructor for class sos.db.InMemoryDatabase
Creates a InMemoryDatabase with the specified database name and transaction policy.
invoke(TransactionSupport, Method, Object[]) - Method in class sos.db.AbstractTransactionPolicy
 
invoke(TransactionSupport, Method, Object[]) - Method in interface sos.db.TransactionPolicy
Invokes the specified method on the object referred to by support.
isCanceled() - Method in interface sos.db.Progress
Checks if this task has been aborted.
isEmpty() - Method in class sos.db.LongMap
Returns true if this map contains no mappings.
isOpen() - Method in class sos.db.AbstractDatabase
 
isOpen() - Method in interface sos.db.Database
Returns true if this database is open and ready to accept requests.

L

logDatabaseClosed() - Method in class sos.db.AbstractSerializationDatabase
Records that this database has been closed.
logDatabaseCreated() - Method in class sos.db.AbstractSerializationDatabase
Records that this database has been created.
logDatabaseDeleted() - Method in class sos.db.AbstractSerializationDatabase
Records that this database has been deleted.
logDatabaseOpened() - Method in class sos.db.AbstractSerializationDatabase
Records that this database has been opened.
logger - Static variable in interface sos.db.Database
The object that should be used to log database activity.
logLockAcquired(String) - Method in class sos.db.DefaultTransactionPolicy
Records that the database lock has been acquired.
logLockReleased(String) - Method in class sos.db.DefaultTransactionPolicy
Records that the database lock has been released.
logMethodInvocation(String, Object, Class, Method) - Method in class sos.db.AbstractTransactionPolicy
Records that the specified method is about to be executed on the object of type receiverClass that is associated with key.
logObjectAdded(long, Class) - Method in class sos.db.AbstractSerializationDatabase
Records that this database added an object with the specified id.
logObjectRemoved(long) - Method in class sos.db.AbstractSerializationDatabase
Records that this database has removed the object with the specified id.
logObjectResaved(long) - Method in class sos.db.AbstractSerializationDatabase
Records that this database has resaved the object with the specified id.
logReadLockAcquired(String, Object) - Method in class sos.db.DefaultReadWriteTransactionPolicy
Records that the read lock associated with key has been acquired.
logReadLockReleased(String, Object) - Method in class sos.db.DefaultReadWriteTransactionPolicy
Records that the read lock associated with key has been released.
logTransactionAborted() - Method in class sos.db.AbstractSerializationDatabase
Records that the transaction for the current thread has aborted.
logTransactionCommitted() - Method in class sos.db.AbstractSerializationDatabase
Records that the transaction for the current thread has committed.
logTransactionStarted() - Method in class sos.db.AbstractSerializationDatabase
Records that a transaction for the current thread has started.
logWriteLockAcquired(String, Object) - Method in class sos.db.DefaultReadWriteTransactionPolicy
Records that the write lock associated with key has been acquired.
logWriteLockReleased(String, Object) - Method in class sos.db.DefaultReadWriteTransactionPolicy
Records that the write lock associated with key has been released.
LongMap<V> - Class in sos.db
A utility class that maps long keys to Object values.
LongMap.Entry<V> - Class in sos.db
A utility class used by LongMap that captures a mapping between a long key and an Object value.

N

notifyChanged(Object, boolean) - Method in interface sos.db.TransactionSupport
Informs the transaction that the object's state has changed and the object needs to be resaved in the database.
NoTransactionException - Exception in sos.db
An unchecked exception indicating that the programmer is performing a transactional operation when no transaction exists.
NoTransactionException() - Constructor for exception sos.db.NoTransactionException
Creates an instance of NoTransactionException with null as the detail message.
NoTransactionException(String) - Constructor for exception sos.db.NoTransactionException
Creates an instance of NoTransactionException with the specified detail message.

O

open(boolean) - Method in class sos.db.AbstractDatabase
 
open(boolean) - Method in interface sos.db.Database
Opens this database.

P

prepareForReadOnlyInvocation(TransactionSupport) - Method in class sos.db.AbstractTransactionPolicy
Prepares for the invocation of a read-only method on the object referenced by support.
prepareForReadOnlyInvocation(TransactionSupport) - Method in class sos.db.DefaultReadWriteTransactionPolicy
 
prepareForWriteInvocation(TransactionSupport) - Method in class sos.db.AbstractTransactionPolicy
Prepares for the invocation of a non-read-only method on the object referenced by support.
prepareForWriteInvocation(TransactionSupport) - Method in class sos.db.DefaultReadWriteTransactionPolicy
 
Progress - Interface in sos.db
A mechanism to allow an operation to report its progress and to check if it should be aborted.

R

READ_ONLY - Static variable in class sos.db.ReadOnlyManager
A constant that indicates that a method does not modify its receiver.
ReadOnlyManager - Class in sos.db
A class that keeps track of whether or not a method is read-only.
readResolve() - Method in class sos.db.AbstractSerializationDatabase
Returns a deserialized version of this database.
registerObject(TransactionSupport, Object) - Method in class sos.db.AbstractTransactionPolicy
 
registerObject(TransactionSupport, Object) - Method in class sos.db.DefaultReadWriteTransactionPolicy
 
registerObject(TransactionSupport, Object) - Method in interface sos.db.TransactionPolicy
Notifies this policy that there is a new database object.
replaceObject(Object) - Method in class sos.db.AbstractSerializationDatabase
Allows subclasses to substitute one object for another during serialization.
resolveObject(Object) - Method in class sos.db.AbstractSerializationDatabase
Allows subclasses to substitute one object for another during deserialization.

S

setAutoCreateTransactions(boolean) - Method in class sos.db.AbstractSerializationDatabase
Sets whether or not this database allows a method invocation on a database object when there is no current transaction.
setCancelable(boolean) - Method in interface sos.db.Progress
Sets whether or not this task can be aborted.
setMethodStatus(Method, int) - Static method in class sos.db.ReadOnlyManager
Sets the read-only status of the specified method.
setMethodStatus(Class, String, Class[], int) - Static method in class sos.db.ReadOnlyManager
Sets the read-only status of the method with the given declaring class, name, and parameter types.
setMethodStatus(String, int) - Static method in class sos.db.ReadOnlyManager
Sets the read-only status of the method with the given descriptor.
setProgress(double) - Method in interface sos.db.Progress
Updates the progress of this task.
size() - Method in class sos.db.LongMap
Returns the number of key-value mappings in this map.
sos.db - package sos.db

Provides transparent persistence to an in-memory or file-based object-oriented database.

startTransaction() - Method in class sos.db.AbstractDatabase
 
startTransaction(TransactionSupport) - Method in class sos.db.AbstractTransactionPolicy
 
startTransaction() - Method in interface sos.db.Database
Starts a new (potentially nested) transaction for the calling thread.
startTransaction(TransactionSupport) - Method in class sos.db.DefaultTransactionPolicy
 
startTransaction(TransactionSupport) - Method in interface sos.db.TransactionPolicy
Notifies this policy that a top-level transaction is starting for the executing thread.

T

TransactionAbortedException - Exception in sos.db
A run-time exception (intended to be checked) that indicates a transaction has unexpectedly aborted and rolled back.
TransactionAbortedException(Throwable) - Constructor for exception sos.db.TransactionAbortedException
Creates an instance of TransactionAbortedException with the specified underlying cause.
TransactionConflictException - Exception in sos.db
A checked exception indicating that a transaction cannot successfully complete because an operation conflicts with that of another transaction.
TransactionConflictException() - Constructor for exception sos.db.TransactionConflictException
Creates an instance of TransactionConflictException with a null detail message.
TransactionConflictException(String) - Constructor for exception sos.db.TransactionConflictException
Creates an instance of TransactionConflictException with the specified detail message.
TransactionConflictException(Throwable) - Constructor for exception sos.db.TransactionConflictException
Creates an instance of TransactionConflictException with a null detail message and the specified cause.
TransactionConflictException(String, Throwable) - Constructor for exception sos.db.TransactionConflictException
Creates an instance of TransactionConflictException with the specified detail message and cause.
transactionDepth() - Method in class sos.db.AbstractDatabase
 
transactionDepth() - Method in interface sos.db.Database
Returns the nesting depth of the transaction associated with the current thread.
TransactionPolicy - Interface in sos.db
A policy that determines the behavior of database transactions.
TransactionSupport - Interface in sos.db
An auxiliary class that allows a TransactionPolicy to register commit and abort actions and to signal that an object's state has changed.

U

Unique - Interface in sos.db
A marker interface that indicates that a class does not implement a custom equals or hashCode.
UNKNOWN - Static variable in class sos.db.ReadOnlyManager
A constant that indicates that a method's read-only status is unknown.
unregisterObjects(Database, Set<Object>) - Method in class sos.db.AbstractTransactionPolicy
 
unregisterObjects(Database, Set<Object>) - Method in interface sos.db.TransactionPolicy
Notifies this policy that objects have been removed from the database.

V

valueIterator() - Method in class sos.db.LongMap
Returns a read-only iterator of the values in this map.

W

WRITE - Static variable in class sos.db.ReadOnlyManager
A constant that indicates that a method may modify its receiver.
WRITE_NO_GARBAGE - Static variable in class sos.db.ReadOnlyManager
A constant that indicates a method may modify its receiver in such a way that no reachable object becomes unreachable.

A C D E F G I L N O P R S T U V W
Side of Software
Persistence Library 2.0

Copyright 2004-08 Side of Software (SOS). All rights reserved.