Skip to content

Commit 17389cc

Browse files
committed
Document log4j-api changes in version 2.24.0
1 parent 42b1b1d commit 17389cc

File tree

5 files changed

+41
-2
lines changed

5 files changed

+41
-2
lines changed

log4j-api/src/main/java/org/apache/logging/log4j/EventLogger.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
/**
2323
* Convenience to log {@link StructuredDataMessage}s.
2424
*
25-
* @deprecated {@link Logger} accepts {@link StructuredDataMessage}s, users should use to that instead.
25+
* @deprecated Deprecated since 2.24.0.
26+
* {@link Logger} accepts {@link StructuredDataMessage}s, users should use to that instead.
2627
*/
2728
@Deprecated
2829
public final class EventLogger {

log4j-api/src/main/java/org/apache/logging/log4j/message/DefaultFlowMessageFactory.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ public class DefaultFlowMessageFactory implements FlowMessageFactory, Serializab
3232
private static final String ENTRY_DEFAULT_PREFIX = "Enter";
3333
private static final long serialVersionUID = 8578655591131397576L;
3434

35+
/**
36+
* @since 2.24.0
37+
*/
3538
public static final FlowMessageFactory INSTANCE = new DefaultFlowMessageFactory();
3639

3740
private final String entryText;

log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableParameterizedMessage.java

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,25 +135,37 @@ private static Throwable determineThrowable(final Object[] args, final int argCo
135135
return null;
136136
}
137137

138+
/**
139+
* @since 2.24.0
140+
*/
138141
public ReusableParameterizedMessage set(final String messagePattern, final Object... arguments) {
139142
init(messagePattern, arguments == null ? 0 : arguments.length, arguments);
140143
varargs = arguments;
141144
return this;
142145
}
143146

147+
/**
148+
* @since 2.24.0
149+
*/
144150
public ReusableParameterizedMessage set(final String messagePattern, final Object p0) {
145151
params[0] = p0;
146152
init(messagePattern, 1, params);
147153
return this;
148154
}
149155

156+
/**
157+
* @since 2.24.0
158+
*/
150159
public ReusableParameterizedMessage set(final String messagePattern, final Object p0, final Object p1) {
151160
params[0] = p0;
152161
params[1] = p1;
153162
init(messagePattern, 2, params);
154163
return this;
155164
}
156165

166+
/**
167+
* @since 2.24.0
168+
*/
157169
public ReusableParameterizedMessage set(
158170
final String messagePattern, final Object p0, final Object p1, final Object p2) {
159171
params[0] = p0;
@@ -163,6 +175,9 @@ public ReusableParameterizedMessage set(
163175
return this;
164176
}
165177

178+
/**
179+
* @since 2.24.0
180+
*/
166181
public ReusableParameterizedMessage set(
167182
final String messagePattern, final Object p0, final Object p1, final Object p2, final Object p3) {
168183
params[0] = p0;
@@ -173,6 +188,9 @@ public ReusableParameterizedMessage set(
173188
return this;
174189
}
175190

191+
/**
192+
* @since 2.24.0
193+
*/
176194
public ReusableParameterizedMessage set(
177195
final String messagePattern,
178196
final Object p0,
@@ -189,6 +207,9 @@ public ReusableParameterizedMessage set(
189207
return this;
190208
}
191209

210+
/**
211+
* @since 2.24.0
212+
*/
192213
public ReusableParameterizedMessage set(
193214
final String messagePattern,
194215
final Object p0,
@@ -207,6 +228,9 @@ public ReusableParameterizedMessage set(
207228
return this;
208229
}
209230

231+
/**
232+
* @since 2.24.0
233+
*/
210234
public ReusableParameterizedMessage set(
211235
final String messagePattern,
212236
final Object p0,
@@ -227,6 +251,9 @@ public ReusableParameterizedMessage set(
227251
return this;
228252
}
229253

254+
/**
255+
* @since 2.24.0
256+
*/
230257
public ReusableParameterizedMessage set(
231258
final String messagePattern,
232259
final Object p0,
@@ -249,6 +276,9 @@ public ReusableParameterizedMessage set(
249276
return this;
250277
}
251278

279+
/**
280+
* @since 2.24.0
281+
*/
252282
public ReusableParameterizedMessage set(
253283
final String messagePattern,
254284
final Object p0,
@@ -273,6 +303,9 @@ public ReusableParameterizedMessage set(
273303
return this;
274304
}
275305

306+
/**
307+
* @since 2.24.0
308+
*/
276309
public ReusableParameterizedMessage set(
277310
final String messagePattern,
278311
final Object p0,

log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ public AbstractLogger(final String name, final MessageFactory messageFactory) {
138138
* @param name the logger name (if null, will be derived from this class)
139139
* @param messageFactory the {@link Message} factory (if null, {@link ParameterizedMessageFactory} will be used)
140140
* @param flowMessageFactory the {@link org.apache.logging.log4j.message.FlowMessage} factory (if null, {@link DefaultFlowMessageFactory} will be used)
141+
* @since 2.24.0
141142
*/
142143
protected AbstractLogger(
143144
final String name, final MessageFactory messageFactory, final FlowMessageFactory flowMessageFactory) {

log4j-api/src/main/java/org/apache/logging/log4j/spi/Provider.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
public class Provider {
4444
/**
4545
* Constant inlined by the compiler
46+
* @since 2.24.0
4647
*/
4748
protected static final String CURRENT_VERSION = "2.6.0";
4849

@@ -317,7 +318,7 @@ public ThreadContextMap getThreadContextMapInstance() {
317318
*
318319
* @return the URL corresponding to the Provider {@code META-INF/log4j-provider.properties} file or {@code null}
319320
* for a provider class.
320-
* @deprecated since 2.24.0, without replacement.
321+
* @deprecated since 2.24.0, without a replacement.
321322
*/
322323
@Deprecated
323324
public @Nullable URL getUrl() {

0 commit comments

Comments
 (0)