Skip to content

Commit 9b455b2

Browse files
committed
Adapt ReusableMessage to be used in 3.x
1 parent b2c0a85 commit 9b455b2

File tree

3 files changed

+21
-12
lines changed

3 files changed

+21
-12
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
import org.apache.logging.log4j.util.PerformanceSensitive;
2020
import org.apache.logging.log4j.util.StringBuilderFormattable;
21+
import org.osgi.annotation.versioning.ProviderType;
2122

2223
/**
2324
* Messages implementing this interface are reused between logging calls.
@@ -29,6 +30,7 @@
2930
* @since 2.6
3031
*/
3132
@PerformanceSensitive("allocation")
33+
@ProviderType
3234
public interface ReusableMessage extends Message, StringBuilderFormattable {
3335

3436
/**
@@ -69,4 +71,10 @@ public interface ReusableMessage extends Message, StringBuilderFormattable {
6971
* @return an immutable snapshot of this message
7072
*/
7173
Message memento();
74+
75+
/**
76+
* Resets the object to a clean state.
77+
* @since 2.24.0
78+
*/
79+
void clear();
7280
}

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

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

138-
ReusableParameterizedMessage set(final String messagePattern, final Object... arguments) {
138+
public ReusableParameterizedMessage set(final String messagePattern, final Object... arguments) {
139139
init(messagePattern, arguments == null ? 0 : arguments.length, arguments);
140140
varargs = arguments;
141141
return this;
142142
}
143143

144-
ReusableParameterizedMessage set(final String messagePattern, final Object p0) {
144+
public ReusableParameterizedMessage set(final String messagePattern, final Object p0) {
145145
params[0] = p0;
146146
init(messagePattern, 1, params);
147147
return this;
148148
}
149149

150-
ReusableParameterizedMessage set(final String messagePattern, final Object p0, final Object p1) {
150+
public ReusableParameterizedMessage set(final String messagePattern, final Object p0, final Object p1) {
151151
params[0] = p0;
152152
params[1] = p1;
153153
init(messagePattern, 2, params);
154154
return this;
155155
}
156156

157-
ReusableParameterizedMessage set(final String messagePattern, final Object p0, final Object p1, final Object p2) {
157+
public ReusableParameterizedMessage set(
158+
final String messagePattern, final Object p0, final Object p1, final Object p2) {
158159
params[0] = p0;
159160
params[1] = p1;
160161
params[2] = p2;
161162
init(messagePattern, 3, params);
162163
return this;
163164
}
164165

165-
ReusableParameterizedMessage set(
166+
public ReusableParameterizedMessage set(
166167
final String messagePattern, final Object p0, final Object p1, final Object p2, final Object p3) {
167168
params[0] = p0;
168169
params[1] = p1;
@@ -172,7 +173,7 @@ ReusableParameterizedMessage set(
172173
return this;
173174
}
174175

175-
ReusableParameterizedMessage set(
176+
public ReusableParameterizedMessage set(
176177
final String messagePattern,
177178
final Object p0,
178179
final Object p1,
@@ -188,7 +189,7 @@ ReusableParameterizedMessage set(
188189
return this;
189190
}
190191

191-
ReusableParameterizedMessage set(
192+
public ReusableParameterizedMessage set(
192193
final String messagePattern,
193194
final Object p0,
194195
final Object p1,
@@ -206,7 +207,7 @@ ReusableParameterizedMessage set(
206207
return this;
207208
}
208209

209-
ReusableParameterizedMessage set(
210+
public ReusableParameterizedMessage set(
210211
final String messagePattern,
211212
final Object p0,
212213
final Object p1,
@@ -226,7 +227,7 @@ ReusableParameterizedMessage set(
226227
return this;
227228
}
228229

229-
ReusableParameterizedMessage set(
230+
public ReusableParameterizedMessage set(
230231
final String messagePattern,
231232
final Object p0,
232233
final Object p1,
@@ -248,7 +249,7 @@ ReusableParameterizedMessage set(
248249
return this;
249250
}
250251

251-
ReusableParameterizedMessage set(
252+
public ReusableParameterizedMessage set(
252253
final String messagePattern,
253254
final Object p0,
254255
final Object p1,
@@ -272,7 +273,7 @@ ReusableParameterizedMessage set(
272273
return this;
273274
}
274275

275-
ReusableParameterizedMessage set(
276+
public ReusableParameterizedMessage set(
276277
final String messagePattern,
277278
final Object p0,
278279
final Object p1,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
/**
2323
* Bumped to 2.22.0, since FormattedMessage behavior changed.
2424
*/
25-
@Version("2.22.0")
25+
@Version("2.24.0")
2626
package org.apache.logging.log4j.message;
2727

2828
import org.osgi.annotation.bundle.Export;

0 commit comments

Comments
 (0)