2d6d2a4ecf7aba37b1b32227a78987e716d5e2af
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / TestDDAResponse.java
1 /*
2  * jFCPlib - TestDDAResponse.java - Copyright © 2008 David Roden
3  *
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.
8  *
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.
13  *
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.
17  */
18
19 package net.pterodactylus.fcp;
20
21 /**
22  * A “TestDDAResponse” is sent to let the node know that either created a file
23  * with the content from {@link TestDDAReply#getContentToWrite()} or that you
24  * read the content of the file given by {@link TestDDAReply#getReadFilename()}
25  * .
26  *
27  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
28  */
29 public class TestDDAResponse extends FcpMessage {
30
31         /**
32          * Creates a new “TestDDAResponse” message that signals that you created
33          * the file given by {@link TestDDAReply#getWriteFilename()} and wrote the
34          * contents given by {@link TestDDAReply#getContentToWrite()} to it.
35          *
36          * @param directory
37          *            The directory from the {@link TestDDARequest} command
38          */
39         public TestDDAResponse(String directory) {
40                 this(directory, null);
41         }
42
43         /**
44          * Creates a new “TestDDAResponse” message that signals that you created
45          * the file given by {@link TestDDAReply#getWriteFilename()} with the
46          * contents given by {@link TestDDAReply#getContentToWrite()} to it (when
47          * you specified that you want to write to the directory) and/or that you
48          * read the file given by {@link TestDDAReply#getReadFilename()} (when you
49          * specified you wanted to read the directory).
50          *
51          * @param directory
52          *            The directory from the {@link TestDDARequest} command
53          * @param readContent
54          *            The read content, or <code>null</code> if you did not request
55          *            read access
56          */
57         public TestDDAResponse(String directory, String readContent) {
58                 super("TestDDAResponse");
59                 if (readContent != null) {
60                         setField("ReadContent", readContent);
61                 }
62         }
63
64 }