DMDirc-Client/src/uk/org/ownage/dmdirc/actions/CoreActionType.java

/*
 * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package uk.org.ownage.dmdirc.actions;

/**
 * An enumeration of actions that are raised by the core.
 * @author chris
 */
public enum CoreActionType implements ActionType {
    
    CHANNEL_MESSAGE(ActionMetaType.CHANNEL_EVENT_WITH_ARG),
    CHANNEL_ACTION(ActionMetaType.CHANNEL_EVENT_WITH_ARG),
    CHANNEL_JOIN(ActionMetaType.CHANNEL_EVENT);
    
    /** The type of this action. */
    private final ActionMetaType type;
    
    /**
     * Constructs a new core action.
     * @param type The type of this action
     */
    CoreActionType(ActionMetaType type) {
        this.type = type;
    }
    
    /**
     * Retrieves the type of this action.
     * @return This action's type
     */
    public ActionMetaType getType() {
        return type;
    }
    
}