Skip to content

Commit d6fe40d

Browse files
jhl221123jhl221123
authored
Deprecate withers in 2.x in favor of setters (#3756)
* Deprecate withers in 2.x in favor of setters * Standardize on set methods and update related documentation * Bump OSGi version for the core.async package
1 parent ff03364 commit d6fe40d

File tree

75 files changed

+1742
-442
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1742
-442
lines changed

‎log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/DailyRollingFileAppenderBuilder.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -180,25 +180,25 @@ private <T extends Log4j1Configuration> Appender createAppender(
180180
}
181181
final String filePattern = fileName + "%d{" + datePattern + "}";
182182
final TriggeringPolicy timePolicy =
183-
TimeBasedTriggeringPolicy.newBuilder().withModulate(true).build();
183+
TimeBasedTriggeringPolicy.newBuilder().setModulate(true).build();
184184
final TriggeringPolicy policy = CompositeTriggeringPolicy.createPolicy(timePolicy);
185185
final RolloverStrategy strategy = DefaultRolloverStrategy.newBuilder()
186-
.withConfig(configuration)
187-
.withMax(Integer.toString(Integer.MAX_VALUE))
186+
.setConfig(configuration)
187+
.setMax(Integer.toString(Integer.MAX_VALUE))
188188
.build();
189189
return AppenderWrapper.adapt(RollingFileAppender.newBuilder()
190190
.setName(name)
191191
.setConfiguration(configuration)
192192
.setLayout(fileLayout)
193193
.setFilter(fileFilter)
194-
.withFileName(fileName)
195-
.withAppend(append)
194+
.setFileName(fileName)
195+
.setAppend(append)
196196
.setBufferedIo(bufferedIo)
197197
.setBufferSize(bufferSize)
198198
.setImmediateFlush(immediateFlush)
199-
.withFilePattern(filePattern)
200-
.withPolicy(policy)
201-
.withStrategy(strategy)
199+
.setFilePattern(filePattern)
200+
.setPolicy(policy)
201+
.setStrategy(strategy)
202202
.build());
203203
}
204204
}

‎log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/EnhancedRollingFileAppenderBuilder.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ private Appender createAppender(
259259
final DefaultRolloverStrategy.Builder rolloverStrategyBuilder = DefaultRolloverStrategy.newBuilder();
260260
switch (rollingPolicyClassName) {
261261
case FIXED_WINDOW_ROLLING_POLICY:
262-
rolloverStrategyBuilder.withMin(Integer.toString(minIndex)).withMax(Integer.toString(maxIndex));
262+
rolloverStrategyBuilder.setMin(Integer.toString(minIndex)).setMax(Integer.toString(maxIndex));
263263
break;
264264
case TIME_BASED_ROLLING_POLICY:
265265
break;
@@ -276,18 +276,18 @@ private Appender createAppender(
276276
return null;
277277
}
278278
return AppenderWrapper.adapt(RollingFileAppender.newBuilder()
279-
.withAppend(append)
279+
.setAppend(append)
280280
.setBufferedIo(bufferedIo)
281281
.setBufferSize(bufferedIo ? bufferSize : 0)
282282
.setConfiguration(configuration)
283-
.withFileName(actualFileName)
284-
.withFilePattern(fileNamePattern)
283+
.setFileName(actualFileName)
284+
.setFilePattern(fileNamePattern)
285285
.setFilter(fileFilter)
286286
.setImmediateFlush(actualImmediateFlush)
287287
.setLayout(fileLayout)
288288
.setName(name)
289-
.withPolicy(actualTriggeringPolicy)
290-
.withStrategy(rolloverStrategyBuilder.build())
289+
.setPolicy(actualTriggeringPolicy)
290+
.setStrategy(rolloverStrategyBuilder.build())
291291
.build());
292292
}
293293
}

‎log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/FileAppenderBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,9 @@ private Appender createAppender(
158158
.setConfiguration(configuration)
159159
.setLayout(fileLayout)
160160
.setFilter(fileFilter)
161-
.withFileName(fileName)
161+
.setFileName(fileName)
162162
.setImmediateFlush(immediateFlush)
163-
.withAppend(append)
163+
.setAppend(append)
164164
.setBufferedIo(bufferedIo)
165165
.setBufferSize(bufferSize)
166166
.build());

‎log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/RollingFileAppenderBuilder.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,23 +188,23 @@ private Appender createAppender(
188188
final SizeBasedTriggeringPolicy sizePolicy = SizeBasedTriggeringPolicy.createPolicy(maxSize);
189189
final CompositeTriggeringPolicy policy = CompositeTriggeringPolicy.createPolicy(sizePolicy);
190190
final RolloverStrategy strategy = DefaultRolloverStrategy.newBuilder()
191-
.withConfig(config)
192-
.withMax(maxBackups)
193-
.withFileIndex("min")
191+
.setConfig(config)
192+
.setMax(maxBackups)
193+
.setFileIndex("min")
194194
.build();
195195
return AppenderWrapper.adapt(RollingFileAppender.newBuilder()
196196
.setName(name)
197197
.setConfiguration(config)
198198
.setLayout(fileLayout)
199199
.setFilter(fileFilter)
200-
.withAppend(append)
200+
.setAppend(append)
201201
.setBufferedIo(bufferedIo)
202202
.setBufferSize(bufferSize)
203203
.setImmediateFlush(immediateFlush)
204-
.withFileName(fileName)
205-
.withFilePattern(filePattern)
206-
.withPolicy(policy)
207-
.withStrategy(strategy)
204+
.setFileName(fileName)
205+
.setFilePattern(filePattern)
206+
.setPolicy(policy)
207+
.setStrategy(strategy)
208208
.build());
209209
}
210210
}

‎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-1.2-api/src/main/java/org/apache/log4j/builders/layout/PatternLayoutBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Layout createLayout(String pattern, final Log4j1Configuration config) {
8383
pattern = PatternLayout.DEFAULT_CONVERSION_PATTERN;
8484
}
8585
return LayoutWrapper.adapt(PatternLayout.newBuilder()
86-
.withPattern(pattern
86+
.setPattern(pattern
8787
// Log4j 2 and Log4j 1 level names differ for custom levels
8888
.replaceAll("%([-\\.\\d]*)p(?!\\w)", "%$1v1Level")
8989
// Log4j 2's %x (NDC) is not compatible with Log4j 1's
@@ -99,7 +99,7 @@ Layout createLayout(String pattern, final Log4j1Configuration config) {
9999
// Log4j 2: "{foo=bar,hoo=boo}"
100100
// Use %properties to get the Log4j 1 format
101101
.replaceAll("%([-\\.\\d]*)X(?!\\w)", "%$1properties"))
102-
.withConfiguration(config)
102+
.setConfiguration(config)
103103
.build());
104104
}
105105
}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,16 @@ public class SimpleLayoutBuilder implements LayoutBuilder {
3535
@Override
3636
public Layout parse(final Element layoutElement, final XmlConfiguration config) {
3737
return new LayoutWrapper(PatternLayout.newBuilder()
38-
.withPattern("%v1Level - %m%n")
39-
.withConfiguration(config)
38+
.setPattern("%v1Level - %m%n")
39+
.setConfiguration(config)
4040
.build());
4141
}
4242

4343
@Override
4444
public Layout parse(final PropertiesConfiguration config) {
4545
return new LayoutWrapper(PatternLayout.newBuilder()
46-
.withPattern("%v1Level - %m%n")
47-
.withConfiguration(config)
46+
.setPattern("%v1Level - %m%n")
47+
.setConfiguration(config)
4848
.build());
4949
}
5050
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ private Layout createLayout(
130130
}
131131
sb.append("- %m%n");
132132
return LayoutWrapper.adapt(PatternLayout.newBuilder()
133-
.withPattern(sb.toString())
134-
.withConfiguration(config)
133+
.setPattern(sb.toString())
134+
.setConfiguration(config)
135135
.build());
136136
}
137137
}

‎log4j-1.2-api/src/test/java/org/apache/log4j/CategoryTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ void testSetPriorityNull() {
239239
void testClassName() {
240240
final Category category = Category.getInstance("TestCategory");
241241
final Layout<String> layout =
242-
PatternLayout.newBuilder().withPattern("%d %p %C{1.} [%t] %m%n").build();
242+
PatternLayout.newBuilder().setPattern("%d %p %C{1.} [%t] %m%n").build();
243243
final ListAppender appender = new ListAppender("List2", null, layout, false, false);
244244
appender.start();
245245
category.setAdditivity(false);

‎log4j-1.2-api/src/test/java/org/apache/log4j/LoggerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ void testIsTraceEnabled() {
477477
@SuppressWarnings("deprecation")
478478
void testLog() {
479479
final PatternLayout layout =
480-
PatternLayout.newBuilder().withPattern("%d %C %L %m").build();
480+
PatternLayout.newBuilder().setPattern("%d %C %L %m").build();
481481
final ListAppender appender = new ListAppender("List", null, layout, false, false);
482482
appender.start();
483483
final Logger root = Logger.getRootLogger();

‎log4j-1.2-api/src/test/java/org/apache/log4j/layout/Log4j1SyslogLayoutTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ void testSimpleLayout(
7878
.build();
7979
assertEquals(expected, appenderLayout.toSerializable(logEvent));
8080
final StringLayout messageLayout =
81-
PatternLayout.newBuilder().withPattern("%m").build();
81+
PatternLayout.newBuilder().setPattern("%m").build();
8282
appenderLayout = Log4j1SyslogLayout.newBuilder()
8383
.setFacility(facility)
8484
.setHeader(header)

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/appender/ConsoleAppenderTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ private void testConsoleStreamManagerDoesNotClose(
9292
try {
9393
systemSetter.systemSet(psMock);
9494
final Layout<String> layout =
95-
PatternLayout.newBuilder().withAlwaysWriteExceptions(true).build();
95+
PatternLayout.newBuilder().setAlwaysWriteExceptions(true).build();
9696
final ConsoleAppender app = ConsoleAppender.newBuilder()
9797
.setLayout(layout)
9898
.setTarget(targetName)

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/appender/FileAppenderBuilderTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public Level getStatusLevel() {
6767
assertNull(appender);
6868
assertTrue(counter.getAndSet(0) > 0);
6969
appender = FileAppender.newBuilder()
70-
.withFileName("target/FileAppenderBuilderTest.log")
70+
.setFileName("target/FileAppenderBuilderTest.log")
7171
.build();
7272
assertNull(appender);
7373
assertTrue(counter.getAndSet(0) > 0);
@@ -76,7 +76,7 @@ public Level getStatusLevel() {
7676
assertTrue(counter.getAndSet(0) > 0);
7777
appender = FileAppender.newBuilder()
7878
.setName("FILE")
79-
.withFileName("target/FileAppenderBuilderTest.log")
79+
.setFileName("target/FileAppenderBuilderTest.log")
8080
.build();
8181
assertNotNull(appender);
8282
assertEquals(0, counter.get());

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/appender/FileAppenderPermissionsTest.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,19 @@ void testFilePermissionsAPI(final String filePermissions, final boolean createOn
7070
final File file = new File(DIR, "AppenderTest-" + fileIndex + ".log");
7171
final Path path = file.toPath();
7272
final Layout<String> layout = PatternLayout.newBuilder()
73-
.withPattern(PatternLayout.SIMPLE_CONVERSION_PATTERN)
73+
.setPattern(PatternLayout.SIMPLE_CONVERSION_PATTERN)
7474
.build();
7575
// @formatter:off
7676
final FileAppender appender = FileAppender.newBuilder()
77-
.withFileName(file.getAbsolutePath())
77+
.setFileName(file.getAbsolutePath())
7878
.setName("test")
79-
.withImmediateFlush(false)
79+
.setImmediateFlush(false)
8080
.setIgnoreExceptions(false)
81-
.withBufferedIo(false)
82-
.withBufferSize(1)
81+
.setBufferedIo(false)
82+
.setBufferSize(1)
8383
.setLayout(layout)
84-
.withCreateOnDemand(createOnDemand)
85-
.withFilePermissions(filePermissions)
84+
.setCreateOnDemand(createOnDemand)
85+
.setFilePermissions(filePermissions)
8686
.build();
8787
// @formatter:on
8888
try {
@@ -130,20 +130,20 @@ void testFileUserGroupAPI(final String filePermissions, final int fileIndex) thr
130130
assertNotNull(group);
131131

132132
final Layout<String> layout = PatternLayout.newBuilder()
133-
.withPattern(PatternLayout.SIMPLE_CONVERSION_PATTERN)
133+
.setPattern(PatternLayout.SIMPLE_CONVERSION_PATTERN)
134134
.build();
135135
// @formatter:off
136136
final FileAppender appender = FileAppender.newBuilder()
137-
.withFileName(file.getAbsolutePath())
137+
.setFileName(file.getAbsolutePath())
138138
.setName("test")
139-
.withImmediateFlush(true)
139+
.setImmediateFlush(true)
140140
.setIgnoreExceptions(false)
141-
.withBufferedIo(false)
142-
.withBufferSize(1)
141+
.setBufferedIo(false)
142+
.setBufferSize(1)
143143
.setLayout(layout)
144-
.withFilePermissions(filePermissions)
145-
.withFileOwner(user)
146-
.withFileGroup(group)
144+
.setFilePermissions(filePermissions)
145+
.setFileOwner(user)
146+
.setFileGroup(group)
147147
.build();
148148
// @formatter:on
149149
try {

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/appender/FileAppenderTest.java

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ void testLazyCreate(final boolean createOnDemand) {
7777
final Layout<String> layout = createPatternLayout();
7878
// @formatter:off
7979
final FileAppender appender = FileAppender.newBuilder()
80-
.withFileName(FILE_NAME)
80+
.setFileName(FILE_NAME)
8181
.setName("test")
82-
.withImmediateFlush(false)
82+
.setImmediateFlush(false)
8383
.setIgnoreExceptions(false)
84-
.withBufferedIo(false)
85-
.withBufferSize(1)
84+
.setBufferedIo(false)
85+
.setBufferSize(1)
8686
.setLayout(layout)
87-
.withCreateOnDemand(createOnDemand)
87+
.setCreateOnDemand(createOnDemand)
8888
.build();
8989
// @formatter:on
9090
assertEquals(createOnDemand, appender.getManager().isCreateOnDemand());
@@ -100,7 +100,7 @@ void testLazyCreate(final boolean createOnDemand) {
100100

101101
private static PatternLayout createPatternLayout() {
102102
return PatternLayout.newBuilder()
103-
.withPattern(PatternLayout.SIMPLE_CONVERSION_PATTERN)
103+
.setPattern(PatternLayout.SIMPLE_CONVERSION_PATTERN)
104104
.build();
105105
}
106106

@@ -110,14 +110,14 @@ void testSmallestBufferSize(final boolean createOnDemand) throws Exception {
110110
final Layout<String> layout = createPatternLayout();
111111
// @formatter:off
112112
final FileAppender appender = FileAppender.newBuilder()
113-
.withFileName(FILE_NAME)
113+
.setFileName(FILE_NAME)
114114
.setName("test")
115-
.withImmediateFlush(false)
115+
.setImmediateFlush(false)
116116
.setIgnoreExceptions(false)
117-
.withBufferedIo(false)
118-
.withBufferSize(1)
117+
.setBufferedIo(false)
118+
.setBufferSize(1)
119119
.setLayout(layout)
120-
.withCreateOnDemand(createOnDemand)
120+
.setCreateOnDemand(createOnDemand)
121121
.build();
122122
// @formatter:on
123123
try {
@@ -243,14 +243,14 @@ private static void writer(
243243
final Layout<String> layout = createPatternLayout();
244244
// @formatter:off
245245
final FileAppender appender = FileAppender.newBuilder()
246-
.withFileName(FILE_NAME)
246+
.setFileName(FILE_NAME)
247247
.setName("test")
248-
.withImmediateFlush(false)
248+
.setImmediateFlush(false)
249249
.setIgnoreExceptions(false)
250-
.withLocking(locking)
251-
.withBufferedIo(false)
250+
.setLocking(locking)
251+
.setBufferedIo(false)
252252
.setLayout(layout)
253-
.withCreateOnDemand(createOnDemand)
253+
.setCreateOnDemand(createOnDemand)
254254
.build();
255255
// @formatter:on
256256
assertEquals(createOnDemand, appender.getManager().isCreateOnDemand());

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/appender/InMemoryAppenderTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ void testAppender() {
4545
@Test
4646
void testHeaderRequested() {
4747
final PatternLayout layout =
48-
PatternLayout.newBuilder().withHeader("HEADERHEADER").build();
48+
PatternLayout.newBuilder().setHeader("HEADERHEADER").build();
4949
final boolean writeHeader = true;
5050
final InMemoryAppender app = new InMemoryAppender("test", layout, null, false, writeHeader);
5151
final String expectedHeader = "HEADERHEADER";
@@ -55,7 +55,7 @@ void testHeaderRequested() {
5555
@Test
5656
void testHeaderSuppressed() {
5757
final PatternLayout layout =
58-
PatternLayout.newBuilder().withHeader("HEADERHEADER").build();
58+
PatternLayout.newBuilder().setHeader("HEADERHEADER").build();
5959
final boolean writeHeader = false;
6060
final InMemoryAppender app = new InMemoryAppender("test", layout, null, false, writeHeader);
6161
final String expectedHeader = null;

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/appender/OutputStreamAppenderTest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,12 @@ void testUpdatePatternWithFileAppender() {
108108
final Configuration config = ctx.getConfiguration();
109109
// @formatter:off
110110
final Appender appender = FileAppender.newBuilder()
111-
.withFileName("target/" + getClass().getName() + ".log")
112-
.withAppend(false)
111+
.setFileName("target/" + getClass().getName() + ".log")
112+
.setAppend(false)
113113
.setName("File")
114114
.setIgnoreExceptions(false)
115-
.withBufferedIo(false)
116-
.withBufferSize(4000)
115+
.setBufferedIo(false)
116+
.setBufferSize(4000)
117117
.setConfiguration(config)
118118
.build();
119119
// @formatter:on

0 commit comments

Comments
 (0)