src/net/pterodactylus/fcp/Verbosity.java

   1 /*
   2  * jSite2 - Verbosity.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  * Convenicence class for verbosity handling. This might come in handy with the
  24  * {@link ClientPut} and {@link ClientGet} requests. The verbosity is a bit-mask
  25  * that can be composed of several bits. {@link #PROGRESS} and
  26  * {@link #COMPRESSION} are single bits in that mask and can be combined into a
  27  * new verbosity using {@link #add(Verbosity)}.
  28  *
  29  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  30  */
  31 public class Verbosity {
  32
  33         /** Constant for no verbosity at all. */
  34         public static final Verbosity NONE = new Verbosity(0);
  35
  36         /** Constant for progress message verbosity. */
  37         public static final Verbosity PROGRESS = new Verbosity(1);
  38
  39         /** Constant for compression message verbosity. */
  40         public static final Verbosity COMPRESSION = new Verbosity(512);
  41
  42         /** Constant for all events. */
  43         public static final Verbosity ALL = new Verbosity(-1);
  44
  45         /** The verbosity level. */
  46         private final int level;
  47
  48         /**
  49          * Creates a new verbosity with the given level.
  50          *
  51          * @param level
  52          *            The verbosity level
  53          */
  54         private Verbosity(int level) {
  55                 this.level = level;
  56         }
  57
  58         /**
  59          * Adds the given verbosity to this verbosity and returns a verbosity with
  60          * the new value. The value of this verbosity is not changed.
  61          *
  62          * @param verbosity
  63          *            The verbosity to add to this verbosity
  64          * @return The verbosity with the new level.
  65          */
  66         public Verbosity add(Verbosity verbosity) {
  67                 return new Verbosity(level | verbosity.level);
  68         }
  69
  70         /**
  71          * Checks whether this Verbosity contains all bits of the given Verbosity.
  72          *
  73          * @param verbosity
  74          *            The verbosity to check for in this Verbosity
  75          * @return <code>true</code> if and only if all set bits in the given
  76          *         Verbosity are also set in this Verbosity
  77          */
  78         public boolean contains(Verbosity verbosity) {
  79                 return (level & verbosity.level) == verbosity.level;
  80         }
  81
  82         /**
  83          * @see java.lang.Object#toString()
  84          */
  85         @Override
  86         public String toString() {
  87                 return String.valueOf(level);
  88         }
  89
  90         /**
  91          * Parses the given string and creates a Verbosity with the given level.
  92          *
  93          * @param s
  94          *            The string to parse
  95          * @return The parsed verbosity, or {@link #NONE} if the string could not be
  96          *         parsed
  97          */
  98         public static Verbosity valueOf(String s) {
  99                 try {
 100                         return new Verbosity(Integer.valueOf(s));
 101                 } catch (NumberFormatException nfe1) {
 102                         return NONE;
 103                 }
 104         }
 105
 106 }