src/net/pterodactylus/fcp/highlevel/HighLevelResult.java

   1 /*
   2  * fcplib - HighLevelResult.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.highlevel;
  21
  22 /**
  23  * Base class for results of {@link HighLevelClient} operations.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  * @version $Id$
  27  */
  28 public abstract class HighLevelResult {
  29
  30         /** The identifier of the request. */
  31         private final String identifier;
  32
  33         /** Whether the operation failed. */
  34         private boolean failed;
  35
  36         /**
  37          * Package-private constructor.
  38          *
  39          * @param identifier
  40          *            The identifier of the request
  41          */
  42         HighLevelResult(String identifier) {
  43                 this.identifier = identifier;
  44         }
  45
  46         /**
  47          * Returns the identifier of the underlying request.
  48          *
  49          * @return The identifier of the request
  50          */
  51         public String getIdentifier() {
  52                 return identifier;
  53         }
  54
  55         /**
  56          * Returns whether the operation failed.
  57          *
  58          * @return <code>true</code> if the operation failed, <code>false</code>
  59          *         otherwise
  60          */
  61         public boolean isFailed() {
  62                 return failed;
  63         }
  64
  65         /**
  66          * Sets whether the operation failed.
  67          *
  68          * @param failed
  69          *            <code>true</code> if the operation failed,
  70          *            <code>false</code> otherwise
  71          */
  72         void setFailed(boolean failed) {
  73                 this.failed = failed;
  74         }
  75
  76 }