2 * jFCPlib - Verbosity.java - Copyright © 2008 David Roden
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 package net.pterodactylus.fcp;
22 * Convenicence class for verbosity handling. This might come in handy with the
23 * {@link ClientPut} and {@link ClientGet} requests. The verbosity is a
24 * bit-mask that can be composed of several bits. {@link #PROGRESS} and
25 * {@link #COMPRESSION} are single bits in that mask and can be combined into a
26 * new verbosity using {@link #add(Verbosity)}.
28 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
30 public class Verbosity {
32 /** Constant for no verbosity at all. */
33 public static final Verbosity NONE = new Verbosity(0);
35 /** Constant for progress message verbosity. */
36 public static final Verbosity PROGRESS = new Verbosity(1);
38 /** Constant for compression message verbosity. */
39 public static final Verbosity COMPRESSION = new Verbosity(512);
41 /** Constant for all events. */
42 public static final Verbosity ALL = new Verbosity(-1);
44 /** The verbosity level. */
45 private final int level;
48 * Creates a new verbosity with the given level.
53 private Verbosity(int level) {
58 * Adds the given verbosity to this verbosity and returns a verbosity with
59 * the new value. The value of this verbosity is not changed.
62 * The verbosity to add to this verbosity
63 * @return The verbosity with the new level.
65 public Verbosity add(Verbosity verbosity) {
66 return new Verbosity(level | verbosity.level);
70 * Checks whether this Verbosity contains all bits of the given Verbosity.
73 * The verbosity to check for in this Verbosity
74 * @return <code>true</code> if and only if all set bits in the given
75 * Verbosity are also set in this Verbosity
77 public boolean contains(Verbosity verbosity) {
78 return (level & verbosity.level) == verbosity.level;
82 * @see java.lang.Object#toString()
85 public String toString() {
86 return String.valueOf(level);
90 * Parses the given string and creates a Verbosity with the given level.
94 * @return The parsed verbosity, or {@link #NONE} if the string could not
97 public static Verbosity valueOf(String s) {
99 return new Verbosity(Integer.valueOf(s));
100 } catch (NumberFormatException nfe1) {