jdbm.RecordManagerOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apacheds-jdbm1 Show documentation
Original JDBM Implementation
The newest version!
/**
 * JDBM LICENSE v1.00
 *
 * Redistribution and use of this software and associated documentation
 * ("Software"), with or without modification, are permitted provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain copyright
 *    statements and notices.  Redistributions must also contain a
 *    copy of this document.
 *
 * 2. Redistributions in binary form must reproduce the
 *    above copyright notice, this list of conditions and the
 *    following disclaimer in the documentation and/or other
 *    materials provided with the distribution.
 *
 * 3. The name "JDBM" must not be used to endorse or promote
 *    products derived from this Software without prior written
 *    permission of Cees de Groot.  For written permission,
 *    please contact [email protected].
 *
 * 4. Products derived from this Software may not be called "JDBM"
 *    nor may "JDBM" appear in their names without prior written
 *    permission of Cees de Groot.
 *
 * 5. Due credit should be given to the JDBM Project
 *    (http://jdbm.sourceforge.net/).
 *
 * THIS SOFTWARE IS PROVIDED BY THE JDBM PROJECT AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
 * CEES DE GROOT OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Copyright 2000 (C) Cees de Groot. All Rights Reserved.
 * Copyright 2000-2001 (C) Alex Boisvert. All Rights Reserved.
 * Contributions are Copyright (C) 2000 by their associated contributors.
 *
 * $Id: RecordManagerOptions.java,v 1.1 2002/05/31 06:33:20 boisvert Exp $
 */
package jdbm;


/**
 * Standard options for RecordManager.
 * Final reference -> class shouldn't be extended
 *
 * @author Alex Boisvert
 * @author Cees de Groot
 */
public final class RecordManagerOptions
{
    /**
     *  Ensures no construction of this class, also ensures there is no need for final keyword above
     *  (Implicit super constructor is not visible for default constructor),
     *  but is still self documenting.
     */
    private RecordManagerOptions()
    {
    }

    /** Option to create a thread-safe record manager. */
    public final static String PROVIDER_FACTORY = "jdbm.provider";


    /** Option to create a thread-safe record manager. */
    public final static String THREAD_SAFE = "jdbm.threadSafe";


    /** Option to automatically commit data after each operation. */
    public final static String AUTO_COMMIT = "jdbm.autoCommit";


    /**
     * Option to disable transaction (to increase performance at the cost of
     * potential data loss).
     */
    public final static String DISABLE_TRANSACTIONS = "jdbm.disableTransactions";


    /** Cache type. */
    public final static String CACHE_TYPE = "jdbm.cache.type";


    /** Cache size (when applicable) */
    public final static String CACHE_SIZE = "jdbm.cache.size";


    /** Use normal (strong) object references for the record cache. */
    public final static String NORMAL_CACHE = "normal";


    /**
     * Use soft references {$link java.lang.ref.SoftReference} for the record
     * cache instead of the default normal object references.
     * 
     * Soft references are cleared at the discretion of the garbage collector
     * in response to memory demand.
     */
    public final static String SOFT_REF_CACHE = "soft";


    /**
     * Use weak references {$link java.lang.ref.WeakReference} for the record
     * cache instead of the default normal object references.
     * 
     * Weak references do not prevent their referents from being made
     * finalizable, finalized, and then reclaimed.
     */
    public final static String WEAK_REF_CACHE = "weak";
}