2 * jSite2 - GetConfig.java -
3 * Copyright © 2008 David Roden
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.
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.
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.
20 package net.pterodactylus.fcp;
23 * The “GetConfig” command tells the node to send its configuration to the
26 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
28 public class GetConfig extends FcpMessage {
31 * Creates a new “GetConfig” command.
38 * Sets whether the {@link ConfigData} result message shall include the
42 * <code>true</code> to include current values in the result,
43 * <code>false</code> otherwise
45 public void setWithCurrent(boolean withCurrent) {
46 setField("WithCurrent", String.valueOf(withCurrent));
50 * Sets whether the {@link ConfigData} result message shall include the
53 * @param withShortDescription
54 * <code>true</code> to include the short descriptions in the
55 * result, <code>false</code> otherwise
57 public void setWithShortDescription(boolean withShortDescription) {
58 setField("WithShortDescription", String.valueOf(withShortDescription));
62 * Sets whether the {@link ConfigData} result message shall include the long
65 * @param withLongDescription
66 * <code>true</code> to include the long descriptions in the
67 * result, <code>false</code> otherwise
69 public void setWithLongDescription(boolean withLongDescription) {
70 setField("WithLongDescription", String.valueOf(withLongDescription));
74 * Sets whether the {@link ConfigData} result message shall include the data
77 * @param withDataTypes
78 * <code>true</code> to include the data types in the result,
79 * <code>false</code> otherwise
81 public void setWithDataTypes(boolean withDataTypes) {
82 setField("WithDataTypes", String.valueOf(withDataTypes));
86 * Sets whether the {@link ConfigData} result message shall include the
89 * @param setWithDefaults
90 * <code>true</code> to include the defaults in the result,
91 * <code>false</code> otherwise
93 public void setWithDefaults(boolean setWithDefaults) {
94 setField("WithDefaults", String.valueOf(setWithDefaults));
98 * Sets whether the {@link ConfigData} result message shall include the sort
101 * @param withSortOrder
102 * <code>true</code> to include the sort order in the result,
103 * <code>false</code> otherwise
105 public void setWithSortOrder(boolean withSortOrder) {
106 setField("WithSortOrder", String.valueOf(withSortOrder));
110 * Sets whether the {@link ConfigData} result message shall include the
113 * @param withExpertFlag
114 * <code>true</code> to include the expert flag in the result,
115 * <code>false</code> otherwise
117 public void setWithExpertFlag(boolean withExpertFlag) {
118 setField("WithExpertFlag", String.valueOf(withExpertFlag));
122 * Sets whether the {@link ConfigData} result message shall include the
125 * @param withForceWriteFlag
126 * <code>true</code> to include the force-write flag in the
127 * result, <code>false</code> otherwise
129 public void setWithForceWriteFlag(boolean withForceWriteFlag) {
130 setField("WithForceWriteFlag", String.valueOf(withForceWriteFlag));