/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * Contributor(s):
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 */
package org.netbeans.lib.cvsclient.command.watch;

import org.netbeans.lib.cvsclient.request.*;

/**
 * @author  Thomas Singer
 * @version Dec 29, 2001
 */
public class WatchMode {
    /**
     * This is the WatchMode that enables watching.
     */
    public static final WatchMode ON = new WatchMode("on", // NOI18N
                                                     CommandRequest.WATCH_ON,
                                                     false);

    /**
     * This is the WatchMode that disables watching.
     */
    public static final WatchMode OFF = new WatchMode("off", // NOI18N
                                                      CommandRequest.WATCH_OFF,
                                                      false);

    /**
     * This is the WatchMode that adds watching for the specified Watch.
     */
    public static final WatchMode ADD = new WatchMode("add", // NOI18N
                                                      CommandRequest.WATCH_ADD,
                                                      true);

    /**
     * This is the WatchMode that removes watching for the specified Watch.
     */
    public static final WatchMode REMOVE = new WatchMode("remove", // NOI18N
                                                         CommandRequest.WATCH_REMOVE,
                                                         true);

    private final String name;
    private final CommandRequest command;
    private final boolean watchOptionAllowed;

    private WatchMode(String name, CommandRequest command, boolean watchOptionAllowed) {
        this.name = name;
        this.command = command;
        this.watchOptionAllowed = watchOptionAllowed;
    }

    /**
     * Returns the CommandRequest that is used when executing the WatchCommand
     * with this WatchMode.
     */
    public CommandRequest getCommand() {
        return command;
    }

    /**
     * Indicated, whether a non-null watch-option is allowed in the WatchCommand.
     */
    public boolean isWatchOptionAllowed() {
        return watchOptionAllowed;
    }

    /**
     * Returns the name of this WatchMode ("on", "off", "add", "remove").
     */
    public String toString() {
        return name;
    }
}
