/
LoggingEventBuilder.java
executable file
·169 lines (148 loc) · 5.52 KB
/
LoggingEventBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/**
* Copyright (c) 2004-2021 QOS.ch
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
package org.slf4j.spi;
import java.util.function.Supplier;
import org.slf4j.Marker;
import org.slf4j.helpers.CheckReturnValue;
/**
* This is the main interface in slf4j's fluent API for creating
* {@link org.slf4j.event.LoggingEvent logging events}.
*
* @author Ceki Gülcü
* @since 2.0.0
*/
public interface LoggingEventBuilder {
/**
* Set the cause for the logging event being built.
* @param cause a throwable
* @return a LoggingEventBuilder, usually <b>this</b>.
*/
@CheckReturnValue
LoggingEventBuilder setCause(Throwable cause);
/**
* A {@link Marker marker} to the event being built.
*
* @param marker a Marker instance to add.
* @return a LoggingEventBuilder, usually <b>this</b>.
*/
@CheckReturnValue
LoggingEventBuilder addMarker(Marker marker);
/**
* Add an argument to the event being built.
*
* @param p an Object to add.
* @return a LoggingEventBuilder, usually <b>this</b>.
*/
@CheckReturnValue
LoggingEventBuilder addArgument(Object p);
/**
* Add an argument supplier to the event being built.
*
* @param objectSupplier an Object supplier to add.
* @return a LoggingEventBuilder, usually <b>this</b>.
*/
@CheckReturnValue
LoggingEventBuilder addArgument(Supplier<?> objectSupplier);
/**
* Add a {@link org.slf4j.event.KeyValuePair key value pair} to the event being built.
*
* @param key the key of the key value pair.
* @param value the value of the key value pair.
* @return a LoggingEventBuilder, usually <b>this</b>.
*/
@CheckReturnValue
LoggingEventBuilder addKeyValue(String key, Object value);
/**
* Add a {@link org.slf4j.event.KeyValuePair key value pair} to the event being built.
*
* @param key the key of the key value pair.
* @param valueSupplier a supplier of a value for the key value pair.
* @return a LoggingEventBuilder, usually <b>this</b>.
*/
@CheckReturnValue
LoggingEventBuilder addKeyValue(String key, Supplier<Object> valueSupplier);
/**
* Sets the message of the logging event.
*
* @since 2.0.0-beta0
*/
@CheckReturnValue
LoggingEventBuilder setMessage(String message);
/**
* Sets the message of the event via a message supplier.
*
* @param messageSupplier supplies a String to be used as the message for the event
* @since 2.0.0-beta0
*/
@CheckReturnValue
LoggingEventBuilder setMessage(Supplier<String> messageSupplier);
/**
* After the logging event is built, performs actual logging. This method must be called
* for logging to occur.
*
* If the call to {@link #log()} is omitted, a {@link org.slf4j.event.LoggingEvent LoggingEvent}
* will be built but no logging will occur.
*
* @since 2.0.0-beta0
*/
void log();
/**
* Equivalent to calling {@link #setMessage(String)} followed by {@link #log()};
*
* @param message the message to log
*/
void log(String message);
/**
* Equivalent to calling {@link #setMessage(String)} followed by {@link #addArgument(Object)}}
* and then {@link #log()}
*
* @param message the message to log
* @param arg an argument to be used with the message to log
*/
void log(String message, Object arg);
/**
* Equivalent to calling {@link #setMessage(String)} followed by two calls to
* {@link #addArgument(Object)} and then {@link #log()}
*
* @param message the message to log
* @param arg0 first argument to be used with the message to log
* @param arg1 second argument to be used with the message to log
*/
void log(String message, Object arg0, Object arg1);
/**
* Equivalent to calling {@link #setMessage(String)} followed by zero or more calls to
* {@link #addArgument(Object)} (depending on the size of args array) and then {@link #log()}
*
* @param message the message to log
* @param args a list (actually an array) of arguments to be used with the message to log
*/
void log(String message, Object... args);
/**
* Equivalent to calling {@link #setMessage(Supplier)} followed by {@link #log()}
*
* @param messageSupplier a Supplier returning a message of type String
*/
void log(Supplier<String> messageSupplier);
}