2 * jFCPlib - GetConfig.java - Copyright © 2008–2016 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 3 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, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.fcp;
21 * The “GetConfig” command tells the node to send its configuration to the
24 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
26 public class GetConfig extends FcpMessage {
29 * Creates a new “GetConfig” command.
35 public GetConfig(String identifer) {
37 setField("Identifier", identifer);
41 * Sets whether the {@link ConfigData} result message shall include the
45 * <code>true</code> to include current values in the result,
46 * <code>false</code> otherwise
48 public void setWithCurrent(boolean withCurrent) {
49 setField("WithCurrent", String.valueOf(withCurrent));
53 * Sets whether the {@link ConfigData} result message shall include the
56 * @param withShortDescription
57 * <code>true</code> to include the short descriptions in the
58 * result, <code>false</code> otherwise
60 public void setWithShortDescription(boolean withShortDescription) {
61 setField("WithShortDescription", String.valueOf(withShortDescription));
65 * Sets whether the {@link ConfigData} result message shall include the
68 * @param withLongDescription
69 * <code>true</code> to include the long descriptions in the
70 * result, <code>false</code> otherwise
72 public void setWithLongDescription(boolean withLongDescription) {
73 setField("WithLongDescription", String.valueOf(withLongDescription));
77 * Sets whether the {@link ConfigData} result message shall include the
80 * @param withDataTypes
81 * <code>true</code> to include the data types in the result,
82 * <code>false</code> otherwise
84 public void setWithDataTypes(boolean withDataTypes) {
85 setField("WithDataTypes", String.valueOf(withDataTypes));
89 * Sets whether the {@link ConfigData} result message shall include the
92 * @param setWithDefaults
93 * <code>true</code> to include the defaults in the result,
94 * <code>false</code> otherwise
96 public void setWithDefaults(boolean setWithDefaults) {
97 setField("WithDefaults", String.valueOf(setWithDefaults));
101 * Sets whether the {@link ConfigData} result message shall include the
104 * @param withSortOrder
105 * <code>true</code> to include the sort order in the result,
106 * <code>false</code> otherwise
108 public void setWithSortOrder(boolean withSortOrder) {
109 setField("WithSortOrder", String.valueOf(withSortOrder));
113 * Sets whether the {@link ConfigData} result message shall include the
116 * @param withExpertFlag
117 * <code>true</code> to include the expert flag in the result,
118 * <code>false</code> otherwise
120 public void setWithExpertFlag(boolean withExpertFlag) {
121 setField("WithExpertFlag", String.valueOf(withExpertFlag));
125 * Sets whether the {@link ConfigData} result message shall include the
128 * @param withForceWriteFlag
129 * <code>true</code> to include the force-write flag in the
130 * result, <code>false</code> otherwise
132 public void setWithForceWriteFlag(boolean withForceWriteFlag) {
133 setField("WithForceWriteFlag", String.valueOf(withForceWriteFlag));