be more lenient in parse message terminator
[jFCPlib.git] / 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 <bombe@freenetproject.org>
26  */
27 public abstract class HighLevelResult {
28
29         /** The identifier of the request. */
30         private final String identifier;
31
32         /** Whether the operation failed. */
33         private boolean failed;
34
35         /**
36          * Package-private constructor.
37          * 
38          * @param identifier
39          *            The identifier of the request
40          */
41         HighLevelResult(String identifier) {
42                 this.identifier = identifier;
43         }
44
45         /**
46          * Returns the identifier of the underlying request.
47          * 
48          * @return The identifier of the request
49          */
50         public String getIdentifier() {
51                 return identifier;
52         }
53
54         /**
55          * Returns whether the operation failed.
56          * 
57          * @return <code>true</code> if the operation failed, <code>false</code>
58          *         otherwise
59          */
60         public boolean isFailed() {
61                 return failed;
62         }
63
64         /**
65          * Sets whether the operation failed.
66          * 
67          * @param failed
68          *            <code>true</code> if the operation failed,
69          *            <code>false</code> otherwise
70          */
71         void setFailed(boolean failed) {
72                 this.failed = failed;
73         }
74
75 }