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

Author: jhl221123

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

@@ -180,25 +180,25 @@ private <T extends Log4j1Configuration> Appender createAppender(
         }
         final String filePattern = fileName + "%d{" + datePattern + "}";
         final TriggeringPolicy timePolicy =
-                TimeBasedTriggeringPolicy.newBuilder().withModulate(true).build();
+                TimeBasedTriggeringPolicy.newBuilder().setModulate(true).build();
         final TriggeringPolicy policy = CompositeTriggeringPolicy.createPolicy(timePolicy);
         final RolloverStrategy strategy = DefaultRolloverStrategy.newBuilder()
-                .withConfig(configuration)
-                .withMax(Integer.toString(Integer.MAX_VALUE))
+                .setConfig(configuration)
+                .setMax(Integer.toString(Integer.MAX_VALUE))
                 .build();
         return AppenderWrapper.adapt(RollingFileAppender.newBuilder()
                 .setName(name)
                 .setConfiguration(configuration)
                 .setLayout(fileLayout)
                 .setFilter(fileFilter)
-                .withFileName(fileName)
-                .withAppend(append)
+                .setFileName(fileName)
+                .setAppend(append)
                 .setBufferedIo(bufferedIo)
                 .setBufferSize(bufferSize)
                 .setImmediateFlush(immediateFlush)
-                .withFilePattern(filePattern)
-                .withPolicy(policy)
-                .withStrategy(strategy)
+                .setFilePattern(filePattern)
+                .setPolicy(policy)
+                .setStrategy(strategy)
                 .build());
     }
 }

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

@@ -259,7 +259,7 @@ private Appender createAppender(
         final DefaultRolloverStrategy.Builder rolloverStrategyBuilder = DefaultRolloverStrategy.newBuilder();
         switch (rollingPolicyClassName) {
             case FIXED_WINDOW_ROLLING_POLICY:
-                rolloverStrategyBuilder.withMin(Integer.toString(minIndex)).withMax(Integer.toString(maxIndex));
+                rolloverStrategyBuilder.setMin(Integer.toString(minIndex)).setMax(Integer.toString(maxIndex));
                 break;
             case TIME_BASED_ROLLING_POLICY:
                 break;
@@ -276,18 +276,18 @@ private Appender createAppender(
             return null;
         }
         return AppenderWrapper.adapt(RollingFileAppender.newBuilder()
-                .withAppend(append)
+                .setAppend(append)
                 .setBufferedIo(bufferedIo)
                 .setBufferSize(bufferedIo ? bufferSize : 0)
                 .setConfiguration(configuration)
-                .withFileName(actualFileName)
-                .withFilePattern(fileNamePattern)
+                .setFileName(actualFileName)
+                .setFilePattern(fileNamePattern)
                 .setFilter(fileFilter)
                 .setImmediateFlush(actualImmediateFlush)
                 .setLayout(fileLayout)
                 .setName(name)
-                .withPolicy(actualTriggeringPolicy)
-                .withStrategy(rolloverStrategyBuilder.build())
+                .setPolicy(actualTriggeringPolicy)
+                .setStrategy(rolloverStrategyBuilder.build())
                 .build());
     }
 }

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

@@ -158,9 +158,9 @@ private Appender createAppender(
                 .setConfiguration(configuration)
                 .setLayout(fileLayout)
                 .setFilter(fileFilter)
-                .withFileName(fileName)
+                .setFileName(fileName)
                 .setImmediateFlush(immediateFlush)
-                .withAppend(append)
+                .setAppend(append)
                 .setBufferedIo(bufferedIo)
                 .setBufferSize(bufferSize)
                 .build());

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

@@ -188,23 +188,23 @@ private Appender createAppender(
         final SizeBasedTriggeringPolicy sizePolicy = SizeBasedTriggeringPolicy.createPolicy(maxSize);
         final CompositeTriggeringPolicy policy = CompositeTriggeringPolicy.createPolicy(sizePolicy);
         final RolloverStrategy strategy = DefaultRolloverStrategy.newBuilder()
-                .withConfig(config)
-                .withMax(maxBackups)
-                .withFileIndex("min")
+                .setConfig(config)
+                .setMax(maxBackups)
+                .setFileIndex("min")
                 .build();
         return AppenderWrapper.adapt(RollingFileAppender.newBuilder()
                 .setName(name)
                 .setConfiguration(config)
                 .setLayout(fileLayout)
                 .setFilter(fileFilter)
-                .withAppend(append)
+                .setAppend(append)
                 .setBufferedIo(bufferedIo)
                 .setBufferSize(bufferSize)
                 .setImmediateFlush(immediateFlush)
-                .withFileName(fileName)
-                .withFilePattern(filePattern)
-                .withPolicy(policy)
-                .withStrategy(strategy)
+                .setFileName(fileName)
+                .setFilePattern(filePattern)
+                .setPolicy(policy)
+                .setStrategy(strategy)
                 .build());
     }
 }

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

@@ -73,8 +73,8 @@ public Layout parse(final PropertiesConfiguration config) {
 
     private Layout createLayout(final String title, final boolean locationInfo) {
         return LayoutWrapper.adapt(HtmlLayout.newBuilder()
-                .withTitle(title)
-                .withLocationInfo(locationInfo)
+                .setTitle(title)
+                .setLocationInfo(locationInfo)
                 .build());
     }
 }

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

@@ -83,7 +83,7 @@ Layout createLayout(String pattern, final Log4j1Configuration config) {
             pattern = PatternLayout.DEFAULT_CONVERSION_PATTERN;
         }
         return LayoutWrapper.adapt(PatternLayout.newBuilder()
-                .withPattern(pattern
+                .setPattern(pattern
                         // Log4j 2 and Log4j 1 level names differ for custom levels
                         .replaceAll("%([-\\.\\d]*)p(?!\\w)", "%$1v1Level")
                         // Log4j 2's %x (NDC) is not compatible with Log4j 1's
@@ -99,7 +99,7 @@ Layout createLayout(String pattern, final Log4j1Configuration config) {
                         // Log4j 2: "{foo=bar,hoo=boo}"
                         // Use %properties to get the Log4j 1 format
                         .replaceAll("%([-\\.\\d]*)X(?!\\w)", "%$1properties"))
-                .withConfiguration(config)
+                .setConfiguration(config)
                 .build());
     }
 }

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

@@ -35,16 +35,16 @@ public class SimpleLayoutBuilder implements LayoutBuilder {
     @Override
     public Layout parse(final Element layoutElement, final XmlConfiguration config) {
         return new LayoutWrapper(PatternLayout.newBuilder()
-                .withPattern("%v1Level - %m%n")
-                .withConfiguration(config)
+                .setPattern("%v1Level - %m%n")
+                .setConfiguration(config)
                 .build());
     }
 
     @Override
     public Layout parse(final PropertiesConfiguration config) {
         return new LayoutWrapper(PatternLayout.newBuilder()
-                .withPattern("%v1Level - %m%n")
-                .withConfiguration(config)
+                .setPattern("%v1Level - %m%n")
+                .setConfiguration(config)
                 .build());
     }
 }

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

@@ -130,8 +130,8 @@ private Layout createLayout(
         }
         sb.append("- %m%n");
         return LayoutWrapper.adapt(PatternLayout.newBuilder()
-                .withPattern(sb.toString())
-                .withConfiguration(config)
+                .setPattern(sb.toString())
+                .setConfiguration(config)
                 .build());
     }
 }

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

@@ -239,7 +239,7 @@ void testSetPriorityNull() {
     void testClassName() {
         final Category category = Category.getInstance("TestCategory");
         final Layout<String> layout =
-                PatternLayout.newBuilder().withPattern("%d %p %C{1.} [%t] %m%n").build();
+                PatternLayout.newBuilder().setPattern("%d %p %C{1.} [%t] %m%n").build();
         final ListAppender appender = new ListAppender("List2", null, layout, false, false);
         appender.start();
         category.setAdditivity(false);

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

@@ -477,7 +477,7 @@ void testIsTraceEnabled() {
     @SuppressWarnings("deprecation")
     void testLog() {
         final PatternLayout layout =
-                PatternLayout.newBuilder().withPattern("%d %C %L %m").build();
+                PatternLayout.newBuilder().setPattern("%d %C %L %m").build();
         final ListAppender appender = new ListAppender("List", null, layout, false, false);
         appender.start();
         final Logger root = Logger.getRootLogger();