2 * jFCPlib - GetConfig.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 * The “GetConfig” command tells the node to send its configuration to the
25 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
27 public class GetConfig extends FcpMessage {
30 * Creates a new “GetConfig” command.
37 * Sets whether the {@link ConfigData} result message shall include the
41 * <code>true</code> to include current values in the result,
42 * <code>false</code> otherwise
44 public void setWithCurrent(boolean withCurrent) {
45 setField("WithCurrent", String.valueOf(withCurrent));
49 * Sets whether the {@link ConfigData} result message shall include the
52 * @param withShortDescription
53 * <code>true</code> to include the short descriptions in the
54 * result, <code>false</code> otherwise
56 public void setWithShortDescription(boolean withShortDescription) {
57 setField("WithShortDescription", String.valueOf(withShortDescription));
61 * Sets whether the {@link ConfigData} result message shall include the
64 * @param withLongDescription
65 * <code>true</code> to include the long descriptions in the
66 * result, <code>false</code> otherwise
68 public void setWithLongDescription(boolean withLongDescription) {
69 setField("WithLongDescription", String.valueOf(withLongDescription));
73 * Sets whether the {@link ConfigData} result message shall include the
76 * @param withDataTypes
77 * <code>true</code> to include the data types in the result,
78 * <code>false</code> otherwise
80 public void setWithDataTypes(boolean withDataTypes) {
81 setField("WithDataTypes", String.valueOf(withDataTypes));
85 * Sets whether the {@link ConfigData} result message shall include the
88 * @param setWithDefaults
89 * <code>true</code> to include the defaults in the result,
90 * <code>false</code> otherwise
92 public void setWithDefaults(boolean setWithDefaults) {
93 setField("WithDefaults", String.valueOf(setWithDefaults));
97 * Sets whether the {@link ConfigData} result message shall include the
100 * @param withSortOrder
101 * <code>true</code> to include the sort order in the result,
102 * <code>false</code> otherwise
104 public void setWithSortOrder(boolean withSortOrder) {
105 setField("WithSortOrder", String.valueOf(withSortOrder));
109 * Sets whether the {@link ConfigData} result message shall include the
112 * @param withExpertFlag
113 * <code>true</code> to include the expert flag in the result,
114 * <code>false</code> otherwise
116 public void setWithExpertFlag(boolean withExpertFlag) {
117 setField("WithExpertFlag", String.valueOf(withExpertFlag));
121 * Sets whether the {@link ConfigData} result message shall include the
124 * @param withForceWriteFlag
125 * <code>true</code> to include the force-write flag in the
126 * result, <code>false</code> otherwise
128 public void setWithForceWriteFlag(boolean withForceWriteFlag) {
129 setField("WithForceWriteFlag", String.valueOf(withForceWriteFlag));