/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2001 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
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;
    }
}