Skip to content

Commit c04ad9c

Browse files
jhl221123jhl221123
committed
Standardize on set methods and update related documentation
1 parent d4002a0 commit c04ad9c

25 files changed

+487
-155
lines changed

‎log4j-1.2-api/src/main/java/org/apache/log4j/builders/layout/HtmlLayoutBuilder.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ public Layout parse(final PropertiesConfiguration config) {
7373

7474
private Layout createLayout(final String title, final boolean locationInfo) {
7575
return LayoutWrapper.adapt(HtmlLayout.newBuilder()
76-
.withTitle(title)
77-
.withLocationInfo(locationInfo)
76+
.setTitle(title)
77+
.setLocationInfo(locationInfo)
7878
.build());
7979
}
8080
}

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/async/AsyncWaitStrategyFactoryConfigTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ void testInvalidBuilderConfiguration3159(final Configuration configuration) {
100100
@Test
101101
void testInvalidProgrammaticConfiguration3159WithNullFactoryClassName() {
102102
assertThrows(IllegalArgumentException.class, () -> AsyncWaitStrategyFactoryConfig.newBuilder()
103-
.withFactoryClassName(null));
103+
.setFactoryClassName(null));
104104
}
105105

106106
/**
@@ -110,7 +110,7 @@ void testInvalidProgrammaticConfiguration3159WithNullFactoryClassName() {
110110
@Test
111111
void testInvalidProgrammaticConfiguration3159WithEmptyFactoryClassName() {
112112
assertThrows(IllegalArgumentException.class, () -> AsyncWaitStrategyFactoryConfig.newBuilder()
113-
.withFactoryClassName(""));
113+
.setFactoryClassName(""));
114114
}
115115

116116
@Test

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/config/plugins/validation/AbstractPluginWithGenericBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public String getThing() {
3939
return thing;
4040
}
4141

42-
public B withThing(final String name) {
42+
public B setThing(final String name) {
4343
this.thing = name;
4444
return asBuilder();
4545
}

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/config/plugins/validation/PluginWithGenericSubclassFoo1Builder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public String getFoo1() {
4545
return foo1;
4646
}
4747

48-
public B withFoo1(final String foo1) {
48+
public B setFoo1(final String foo1) {
4949
this.foo1 = foo1;
5050
return asBuilder();
5151
}

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/config/plugins/validation/ValidatingPlugin.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public static class Builder implements org.apache.logging.log4j.core.util.Builde
5656
@Required(message = "The name given by the builder is null")
5757
private String name;
5858

59-
public Builder withName(final String name) {
59+
public Builder setName(final String name) {
6060
this.name = name;
6161
return this;
6262
}

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/config/plugins/validation/ValidatingPluginWithGenericBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public static class Builder<B extends Builder<B>>
5757
@Required(message = "The name given by the builder is null")
5858
private String name;
5959

60-
public B withName(final String name) {
60+
public B setName(final String name) {
6161
this.name = name;
6262
return asBuilder();
6363
}

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/config/plugins/validation/ValidatingPluginWithTypedBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public static class Builder<T>
5757
@Required(message = "The name given by the builder is null")
5858
private String name;
5959

60-
public Builder<T> withName(final String name) {
60+
public Builder<T> setName(final String name) {
6161
this.name = name;
6262
return this;
6363
}

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/layout/HtmlLayoutTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ void testDefaultContentType() {
112112
@Test
113113
void testContentType() {
114114
final HtmlLayout layout = HtmlLayout.newBuilder()
115-
.withContentType("text/html; charset=UTF-16")
115+
.setContentType("text/html; charset=UTF-16")
116116
.build();
117117
assertEquals("text/html; charset=UTF-16", layout.getContentType());
118118
// TODO: make sure this following bit works as well
@@ -145,7 +145,7 @@ private void testLayout(final boolean includeLocation) {
145145
}
146146
// set up appender
147147
final HtmlLayout layout =
148-
HtmlLayout.newBuilder().withLocationInfo(includeLocation).build();
148+
HtmlLayout.newBuilder().setLocationInfo(includeLocation).build();
149149
final ListAppender appender = new ListAppender("List", null, layout, true, false);
150150
appender.start();
151151

‎log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractFileAppender.java‎

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -104,53 +104,80 @@ public String getFileGroup() {
104104
return fileGroup;
105105
}
106106

107+
/**
108+
* @since 2.26.0
109+
*/
107110
public B setAdvertise(final boolean advertise) {
108111
this.advertise = advertise;
109112
return asBuilder();
110113
}
111114

115+
/**
116+
* @since 2.26.0
117+
*/
112118
public B setAdvertiseUri(final String advertiseUri) {
113119
this.advertiseUri = advertiseUri;
114120
return asBuilder();
115121
}
116122

123+
/**
124+
* @since 2.26.0
125+
*/
117126
public B setAppend(final boolean append) {
118127
this.append = append;
119128
return asBuilder();
120129
}
121130

131+
/**
132+
* @since 2.26.0
133+
*/
122134
public B setFileName(final String fileName) {
123135
this.fileName = fileName;
124136
return asBuilder();
125137
}
126138

139+
/**
140+
* @since 2.26.0
141+
*/
127142
public B setCreateOnDemand(final boolean createOnDemand) {
128143
this.createOnDemand = createOnDemand;
129144
return asBuilder();
130145
}
131146

147+
/**
148+
* @since 2.26.0
149+
*/
132150
public B setLocking(final boolean locking) {
133151
this.locking = locking;
134152
return asBuilder();
135153
}
136154

155+
/**
156+
* @since 2.26.0
157+
*/
137158
public B setFilePermissions(final String filePermissions) {
138159
this.filePermissions = filePermissions;
139160
return asBuilder();
140161
}
141162

163+
/**
164+
* @since 2.26.0
165+
*/
142166
public B setFileOwner(final String fileOwner) {
143167
this.fileOwner = fileOwner;
144168
return asBuilder();
145169
}
146170

171+
/**
172+
* @since 2.26.0
173+
*/
147174
public B setFileGroup(final String fileGroup) {
148175
this.fileGroup = fileGroup;
149176
return asBuilder();
150177
}
151178

152179
/**
153-
* @deprecated use {@link #setAdvertise(boolean)}.
180+
* @deprecated since 2.26.0 use {@link #setAdvertise(boolean)}.
154181
*/
155182
@Deprecated
156183
public B withAdvertise(final boolean advertise) {
@@ -159,7 +186,7 @@ public B withAdvertise(final boolean advertise) {
159186
}
160187

161188
/**
162-
* @deprecated use {@link #setAdvertiseUri(String)}.
189+
* @deprecated since 2.26.0 use {@link #setAdvertiseUri(String)}.
163190
*/
164191
@Deprecated
165192
public B withAdvertiseUri(final String advertiseUri) {
@@ -168,7 +195,7 @@ public B withAdvertiseUri(final String advertiseUri) {
168195
}
169196

170197
/**
171-
* @deprecated use {@link #setAppend(boolean)}.
198+
* @deprecated since 2.26.0 use {@link #setAppend(boolean)}.
172199
*/
173200
@Deprecated
174201
public B withAppend(final boolean append) {
@@ -177,7 +204,7 @@ public B withAppend(final boolean append) {
177204
}
178205

179206
/**
180-
* @deprecated use {@link #setFileName(String)}.
207+
* @deprecated since 2.26.0 use {@link #setFileName(String)}.
181208
*/
182209
@Deprecated
183210
public B withFileName(final String fileName) {
@@ -186,7 +213,7 @@ public B withFileName(final String fileName) {
186213
}
187214

188215
/**
189-
* @deprecated use {@link #setCreateOnDemand(boolean)}.
216+
* @deprecated since 2.26.0 use {@link #setCreateOnDemand(boolean)}.
190217
*/
191218
@Deprecated
192219
public B withCreateOnDemand(final boolean createOnDemand) {
@@ -195,7 +222,7 @@ public B withCreateOnDemand(final boolean createOnDemand) {
195222
}
196223

197224
/**
198-
* @deprecated use {@link #setLocking(boolean)}.
225+
* @deprecated since 2.26.0 use {@link #setLocking(boolean)}.
199226
*/
200227
@Deprecated
201228
public B withLocking(final boolean locking) {
@@ -204,7 +231,7 @@ public B withLocking(final boolean locking) {
204231
}
205232

206233
/**
207-
* @deprecated use {@link #setFilePermissions(String)}.
234+
* @deprecated since 2.26.0 use {@link #setFilePermissions(String)}.
208235
*/
209236
@Deprecated
210237
public B withFilePermissions(final String filePermissions) {
@@ -213,7 +240,7 @@ public B withFilePermissions(final String filePermissions) {
213240
}
214241

215242
/**
216-
* @deprecated use {@link #setFileOwner(String)}.
243+
* @deprecated since 2.26.0 use {@link #setFileOwner(String)}.
217244
*/
218245
@Deprecated
219246
public B withFileOwner(final String fileOwner) {
@@ -222,7 +249,7 @@ public B withFileOwner(final String fileOwner) {
222249
}
223250

224251
/**
225-
* @deprecated use {@link #setFileGroup(String)}.
252+
* @deprecated since 2.26.0 use {@link #setFileGroup(String)}.
226253
*/
227254
@Deprecated
228255
public B withFileGroup(final String fileGroup) {

‎log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AppenderSet.java‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,30 +81,36 @@ public Configuration getConfiguration() {
8181
return configuration;
8282
}
8383

84-
public Builder setNode(@SuppressWarnings("hiding") final Node node) {
84+
/**
85+
* @since 2.26.0
86+
*/
87+
public Builder setNode(final Node node) {
8588
this.node = node;
8689
return this;
8790
}
8891

89-
public Builder setConfiguration(@SuppressWarnings("hiding") final Configuration configuration) {
92+
/**
93+
* @since 2.26.0
94+
*/
95+
public Builder setConfiguration(final Configuration configuration) {
9096
this.configuration = configuration;
9197
return this;
9298
}
9399

94100
/**
95-
* @deprecated use {@link #setNode(Node)}.
101+
* @deprecated since 2.26.0 use {@link #setNode(Node)}.
96102
*/
97103
@Deprecated
98-
public Builder withNode(@SuppressWarnings("hiding") final Node node) {
104+
public Builder withNode(final Node node) {
99105
this.node = node;
100106
return this;
101107
}
102108

103109
/**
104-
* @deprecated use {@link #setConfiguration(Configuration)}.
110+
* @deprecated since 2.26.0 use {@link #setConfiguration(Configuration)}.
105111
*/
106112
@Deprecated
107-
public Builder withConfiguration(@SuppressWarnings("hiding") final Configuration configuration) {
113+
public Builder withConfiguration(final Configuration configuration) {
108114
this.configuration = configuration;
109115
return this;
110116
}

0 commit comments

Comments
 (0)