/**********************************************************************
 Copyright (c) 2006 Andy Jefferson and others. All rights reserved.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.

 Contributors:
 ...
 **********************************************************************/
package org.datanucleus.store.autostart;

/**
 * Abstract representation of an autostart mechanism.
 */
public abstract class AbstractAutoStartMechanism implements AutoStartMechanism
{
    /** AutoStart "mode" */
    protected Mode mode;

    /** Flag whether the starter is open. */
    protected boolean open = false;

    /**
     * Constructor.
     */
    public AbstractAutoStartMechanism()
    {
        super();
    }

    /**
     * Accessor for the mode of operation
     * @return The mode of operation
     */
    public Mode getMode()
    {
        return mode;
    }

    /**
     * Mutator for the mode of operation
     * @param mode The mode of operation
     */
    public void setMode(Mode mode)
    {
        this.mode = mode;
    }

    /**
     * Starts a transaction for writting (add/delete) classes to the auto start mechanism.
     * Simply sets the open flag to true.
     */
    public void open()
    {
        open = true;
    }

    /**
     * Whether it's open for writing (add/delete) classes to the auto start mechanism
     * @return whether this is open for writing 
     */
    public boolean isOpen()
    {
        return open;
    }

    /**
     * Closes a transaction for writing (add/delete) classes to the auto start mechanism.
     * Set the open flag to false.
     */
    public void close()
    {
        open = false;
    }
}