src/net/pterodactylus/fcp/WatchGlobal.java

   1 /*
   2  * jSite2 - WatchGlobal.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp;
  21
  22 /**
  23  * The “WatchGlobal” messages enables clients to watch the global queue in
  24  * addition to the client-local queue.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  * @version $Id$
  28  */
  29 public class WatchGlobal extends FcpMessage {
  30
  31         /**
  32          * Enables or disables watching the global queue.
  33          *
  34          * @param enabled
  35          *            <code>true</code> to watch the global queue and the
  36          *            client-local queue, <code>false</code> to watch only the
  37          *            client-local queue
  38          */
  39         public WatchGlobal(boolean enabled) {
  40                 this(enabled, Verbosity.ALL);
  41         }
  42
  43         /**
  44          * Enables or disables watching the global queue, optionally masking out
  45          * certain events.
  46          *
  47          * @param enabled
  48          *            <code>true</code> to watch the global queue and the
  49          *            client-local queue, <code>false</code> to watch only the
  50          *            client-local queue
  51          * @param verbosityMask
  52          *            A verbosity mask that determines which events are received
  53          */
  54         public WatchGlobal(boolean enabled, Verbosity verbosityMask) {
  55                 super("WatchGlobal");
  56                 setField("Enabled", String.valueOf(enabled));
  57                 setField("VerbosityMask", String.valueOf(verbosityMask));
  58         }
  59
  60 }