Skip to content

Commit fdc7361

Browse files
committed
revert Configurator interface to match that in version 1.4.8
Signed-off-by: Ceki Gulcu <[email protected]>
1 parent f023eb5 commit fdc7361

File tree

6 files changed

+17
-14
lines changed

6 files changed

+17
-14
lines changed

logback-classic/src/main/java/ch/qos/logback/classic/BasicConfigurator.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,9 @@ public class BasicConfigurator extends ContextAwareBase implements Configurator
3535
public BasicConfigurator() {
3636
}
3737

38-
public ExecutionStatus configure(Context context) {
38+
public ExecutionStatus configure(LoggerContext loggerContext) {
3939
addInfo("Setting up default configuration.");
4040

41-
LoggerContext loggerContext = (LoggerContext) context;
42-
4341
ConsoleAppender<ILoggingEvent> ca = new ConsoleAppender<ILoggingEvent>();
4442
ca.setContext(context);
4543
ca.setName("console");

logback-classic/src/main/java/ch/qos/logback/classic/joran/SerializedModelConfigurator.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
package ch.qos.logback.classic.joran;
1616

1717
import ch.qos.logback.classic.ClassicConstants;
18+
import ch.qos.logback.classic.LoggerContext;
1819
import ch.qos.logback.classic.joran.serializedModel.HardenedModelInputStream;
1920
import ch.qos.logback.classic.model.processor.LogbackClassicDefaultNestedComponentRules;
2021
import ch.qos.logback.classic.spi.ConfiguratorRank;
@@ -53,7 +54,7 @@ public class SerializedModelConfigurator extends ContextAwareBase implements Con
5354
protected ModelInterpretationContext modelInterpretationContext;
5455

5556
@Override
56-
public ExecutionStatus configure(Context context) {
57+
public ExecutionStatus configure(LoggerContext loggerContext) {
5758

5859
URL url = performMultiStepModelFileSearch(true);
5960
if (url != null) {

logback-classic/src/main/java/ch/qos/logback/classic/spi/Configurator.java

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
*/
1414
package ch.qos.logback.classic.spi;
1515

16+
import ch.qos.logback.classic.LoggerContext;
1617
import ch.qos.logback.core.Context;
1718
import ch.qos.logback.core.spi.ContextAware;
1819

@@ -24,24 +25,25 @@
2425
/**
2526
* Allows programmatic initialization and configuration of Logback. The
2627
* ServiceLoader is typically used to instantiate implementations and thus
27-
* implementations will need to follow the guidelines of the ServiceLoader
28-
* specifically a no-arg constructor is required.
28+
* implementations will need to follow the guidelines of the ServiceLoader,
29+
* in particular the no-arg constructor requirement.
2930
*
30-
* The return type of {@link #configure(Context) configure} was changed from 'void' to
31+
* The return type of {@link #configure(LoggerContext) configure} was changed from 'void' to
3132
* {@link ExecutionStatus) in logback version 1.3.0.
3233
*/
3334
public interface Configurator extends ContextAware {
3435

3536
enum ExecutionStatus {
3637
NEUTRAL, // let the caller decide
3738
INVOKE_NEXT_IF_ANY, // invoke other
38-
DO_NOT_INVOKE_NEXT_IF_ANY
39+
DO_NOT_INVOKE_NEXT_IF_ANY // the caller should not invoke further configurators even some are available
3940
}
4041

4142
/**
42-
* The context will also be set before this method is called via
43-
* {@link ContextAware#setContext(ch.qos.logback.core.Context)}.
43+
* Implementations of this method may expect that the {@link LoggerContext} is set with
44+
* {@link ContextAware#setContext} before this method is invoked.
45+
*
4446
*/
45-
ExecutionStatus configure(Context context);
47+
ExecutionStatus configure(LoggerContext context);
4648

4749
}

logback-classic/src/main/java/ch/qos/logback/classic/util/ContextInitializer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ private Configurator instantiateConfiguratorByClassName(String configuratorClass
112112
/**
113113
*
114114
* @param configurator
115-
* @return true if enclosing loop should break, false otherwise
115+
* @return ExecutionStatus
116116
*/
117117
private Configurator.ExecutionStatus invokeConfigure(Configurator configurator) {
118118
try {

logback-classic/src/main/java/ch/qos/logback/classic/util/DefaultJoranConfigurator.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package ch.qos.logback.classic.util;
22

33
import ch.qos.logback.classic.ClassicConstants;
4+
import ch.qos.logback.classic.LoggerContext;
45
import ch.qos.logback.classic.joran.JoranConfigurator;
56
import ch.qos.logback.classic.spi.ConfiguratorRank;
67
import ch.qos.logback.core.Context;
@@ -27,7 +28,7 @@
2728
public class DefaultJoranConfigurator extends ContextAwareBase implements Configurator {
2829

2930
@Override
30-
public ExecutionStatus configure(Context context) {
31+
public ExecutionStatus configure(LoggerContext context) {
3132
URL url = performMultiStepConfigurationFileSearch(true);
3233
if (url != null) {
3334
try {

logback-classic/src/test/java/ch/qos/logback/classic/util/MockConfigurator.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
*/
1414
package ch.qos.logback.classic.util;
1515

16+
import ch.qos.logback.classic.LoggerContext;
1617
import ch.qos.logback.classic.spi.Configurator;
1718
import ch.qos.logback.classic.spi.ConfiguratorRank;
1819
import ch.qos.logback.core.Context;
@@ -23,7 +24,7 @@ public class MockConfigurator extends ContextAwareBase implements Configurator {
2324

2425
static Context context = null;
2526

26-
public ExecutionStatus configure(Context aContext) {
27+
public ExecutionStatus configure(LoggerContext aContext) {
2728
context = aContext;
2829
return ExecutionStatus.NEUTRAL;
2930
}

0 commit comments

Comments
 (0)