Skip to content

Commit f2a43c1

Browse files
mercyblitzmercyblitz
authored
Merge pull request #30 from microsphere-projects/copilot/add-javadoc-to-classes-methods
docs: add JavaDoc with example usage to all undocumented classes and non-private methods
2 parents d930d39 + f0497a2 commit f2a43c1

20 files changed

Lines changed: 1373 additions & 2 deletions

File tree

‎microsphere-java-logging/src/main/java/io/microsphere/logging/jdk/JavaLogging.java‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,41 +55,117 @@ public class JavaLogging implements Logging {
5555

5656
static final LoggingMXBean loggingMXBean = getLoggingMXBean();
5757

58+
/**
59+
* {@inheritDoc}
60+
*
61+
* <h3>Example Usage</h3>
62+
* <pre>{@code
63+
* JavaLogging logging = new JavaLogging();
64+
* String rootName = logging.getRootLoggerName();
65+
* // returns "" (empty string for the JDK root logger)
66+
* }</pre>
67+
*/
5868
@Override
5969
public String getRootLoggerName() {
6070
return ROOT_LOGGER_NAME;
6171
}
6272

73+
/**
74+
* {@inheritDoc}
75+
*
76+
* <h3>Example Usage</h3>
77+
* <pre>{@code
78+
* JavaLogging logging = new JavaLogging();
79+
* List<String> names = logging.getLoggerNames();
80+
* }</pre>
81+
*/
6382
@Override
6483
public List<String> getLoggerNames() {
6584
return loggingMXBean.getLoggerNames();
6685
}
6786

87+
/**
88+
* {@inheritDoc}
89+
*
90+
* <h3>Example Usage</h3>
91+
* <pre>{@code
92+
* JavaLogging logging = new JavaLogging();
93+
* Set<String> levels = logging.getSupportedLoggingLevels();
94+
* // e.g. ["OFF", "SEVERE", "WARNING", "INFO", "CONFIG", "FINE", "FINER", "FINEST", "ALL"]
95+
* }</pre>
96+
*/
6897
@Override
6998
public Set<String> getSupportedLoggingLevels() {
7099
return ALL_LEVELS;
71100
}
72101

102+
/**
103+
* {@inheritDoc}
104+
*
105+
* <h3>Example Usage</h3>
106+
* <pre>{@code
107+
* JavaLogging logging = new JavaLogging();
108+
* String level = logging.getLoggerLevel("io.microsphere"); // e.g. "INFO"
109+
* }</pre>
110+
*/
73111
@Override
74112
public String getLoggerLevel(String loggerName) {
75113
return loggingMXBean.getLoggerLevel(loggerName);
76114
}
77115

116+
/**
117+
* {@inheritDoc}
118+
*
119+
* <h3>Example Usage</h3>
120+
* <pre>{@code
121+
* JavaLogging logging = new JavaLogging();
122+
* logging.setLoggerLevel("io.microsphere", "FINE");
123+
* }</pre>
124+
*/
78125
@Override
79126
public void setLoggerLevel(String loggerName, String levelName) {
80127
loggingMXBean.setLoggerLevel(loggerName, levelName);
81128
}
82129

130+
/**
131+
* {@inheritDoc}
132+
*
133+
* <h3>Example Usage</h3>
134+
* <pre>{@code
135+
* JavaLogging logging = new JavaLogging();
136+
* String parentName = logging.getParentLoggerName("io.microsphere.logging");
137+
* // returns "io.microsphere"
138+
* }</pre>
139+
*/
83140
@Override
84141
public String getParentLoggerName(String loggerName) {
85142
return loggingMXBean.getParentLoggerName(loggerName);
86143
}
87144

145+
/**
146+
* {@inheritDoc}
147+
*
148+
* <h3>Example Usage</h3>
149+
* <pre>{@code
150+
* JavaLogging logging = new JavaLogging();
151+
* String name = logging.getName(); // "Java Logging"
152+
* }</pre>
153+
*/
88154
@Override
89155
public String getName() {
90156
return "Java Logging";
91157
}
92158

159+
/**
160+
* {@inheritDoc}
161+
*
162+
* <h3>Example Usage</h3>
163+
* <pre>{@code
164+
* JavaLogging logging = new JavaLogging();
165+
* int priority = logging.getPriority();
166+
* // returns JavaLogging.PRIORITY
167+
* }</pre>
168+
*/
93169
@Override
94170
public int getPriority() {
95171
return PRIORITY;

‎microsphere-log4j/src/main/java/io/microsphere/logging/log4j/Log4jLogger.java‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,87 +37,251 @@ class Log4jLogger extends AbstractLogger implements DelegatingWrapper {
3737

3838
private final Logger logger;
3939

40+
/**
41+
* Creates a new {@link Log4jLogger} for the given logger name.
42+
*
43+
* @param loggerName the name of the logger
44+
*
45+
* <h3>Example Usage</h3>
46+
* <pre>{@code
47+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
48+
* }</pre>
49+
*/
4050
public Log4jLogger(String loggerName) {
4151
super(loggerName);
4252
this.logger = getLogger(loggerName);
4353
}
4454

55+
/**
56+
* {@inheritDoc}
57+
*
58+
* <h3>Example Usage</h3>
59+
* <pre>{@code
60+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
61+
* if (logger.isTraceEnabled()) {
62+
* logger.trace("trace message");
63+
* }
64+
* }</pre>
65+
*/
4566
@Override
4667
public boolean isTraceEnabled() {
4768
return this.logger.isTraceEnabled();
4869
}
4970

71+
/**
72+
* {@inheritDoc}
73+
*
74+
* <h3>Example Usage</h3>
75+
* <pre>{@code
76+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
77+
* logger.trace("entering method foo");
78+
* }</pre>
79+
*/
5080
@Override
5181
public void trace(String message) {
5282
this.logger.trace(message);
5383
}
5484

85+
/**
86+
* {@inheritDoc}
87+
*
88+
* <h3>Example Usage</h3>
89+
* <pre>{@code
90+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
91+
* logger.trace("trace with exception", new RuntimeException("cause"));
92+
* }</pre>
93+
*/
5594
@Override
5695
public void trace(String message, Throwable t) {
5796
this.logger.trace(message, t);
5897
}
5998

99+
/**
100+
* {@inheritDoc}
101+
*
102+
* <h3>Example Usage</h3>
103+
* <pre>{@code
104+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
105+
* if (logger.isDebugEnabled()) {
106+
* logger.debug("debug message");
107+
* }
108+
* }</pre>
109+
*/
60110
@Override
61111
public boolean isDebugEnabled() {
62112
return this.logger.isDebugEnabled();
63113
}
64114

115+
/**
116+
* {@inheritDoc}
117+
*
118+
* <h3>Example Usage</h3>
119+
* <pre>{@code
120+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
121+
* logger.debug("processing item");
122+
* }</pre>
123+
*/
65124
@Override
66125
public void debug(String message) {
67126
this.logger.debug(message);
68127

69128
}
70129

130+
/**
131+
* {@inheritDoc}
132+
*
133+
* <h3>Example Usage</h3>
134+
* <pre>{@code
135+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
136+
* logger.debug("debug with exception", new RuntimeException("cause"));
137+
* }</pre>
138+
*/
71139
@Override
72140
public void debug(String message, Throwable t) {
73141
this.logger.debug(message, t);
74142
}
75143

144+
/**
145+
* {@inheritDoc}
146+
*
147+
* <h3>Example Usage</h3>
148+
* <pre>{@code
149+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
150+
* if (logger.isInfoEnabled()) {
151+
* logger.info("application started");
152+
* }
153+
* }</pre>
154+
*/
76155
@Override
77156
public boolean isInfoEnabled() {
78157
return this.logger.isInfoEnabled();
79158
}
80159

160+
/**
161+
* {@inheritDoc}
162+
*
163+
* <h3>Example Usage</h3>
164+
* <pre>{@code
165+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
166+
* logger.info("application started");
167+
* }</pre>
168+
*/
81169
@Override
82170
public void info(String message) {
83171
this.logger.info(message);
84172
}
85173

174+
/**
175+
* {@inheritDoc}
176+
*
177+
* <h3>Example Usage</h3>
178+
* <pre>{@code
179+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
180+
* logger.info("info with exception", new RuntimeException("cause"));
181+
* }</pre>
182+
*/
86183
@Override
87184
public void info(String message, Throwable t) {
88185
this.logger.info(message, t);
89186
}
90187

188+
/**
189+
* {@inheritDoc}
190+
*
191+
* <h3>Example Usage</h3>
192+
* <pre>{@code
193+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
194+
* if (logger.isWarnEnabled()) {
195+
* logger.warn("low memory");
196+
* }
197+
* }</pre>
198+
*/
91199
@Override
92200
public boolean isWarnEnabled() {
93201
return this.logger.isEnabledFor(WARN);
94202
}
95203

204+
/**
205+
* {@inheritDoc}
206+
*
207+
* <h3>Example Usage</h3>
208+
* <pre>{@code
209+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
210+
* logger.warn("unexpected configuration value");
211+
* }</pre>
212+
*/
96213
@Override
97214
public void warn(String message) {
98215
this.logger.warn(message);
99216
}
100217

218+
/**
219+
* {@inheritDoc}
220+
*
221+
* <h3>Example Usage</h3>
222+
* <pre>{@code
223+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
224+
* logger.warn("warn with exception", new RuntimeException("cause"));
225+
* }</pre>
226+
*/
101227
@Override
102228
public void warn(String message, Throwable t) {
103229
this.logger.warn(message, t);
104230
}
105231

232+
/**
233+
* {@inheritDoc}
234+
*
235+
* <h3>Example Usage</h3>
236+
* <pre>{@code
237+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
238+
* if (logger.isErrorEnabled()) {
239+
* logger.error("operation failed");
240+
* }
241+
* }</pre>
242+
*/
106243
@Override
107244
public boolean isErrorEnabled() {
108245
return this.logger.isEnabledFor(ERROR);
109246
}
110247

248+
/**
249+
* {@inheritDoc}
250+
*
251+
* <h3>Example Usage</h3>
252+
* <pre>{@code
253+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
254+
* logger.error("operation failed");
255+
* }</pre>
256+
*/
111257
@Override
112258
public void error(String message) {
113259
this.logger.error(message);
114260
}
115261

262+
/**
263+
* {@inheritDoc}
264+
*
265+
* <h3>Example Usage</h3>
266+
* <pre>{@code
267+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
268+
* logger.error("error with exception", new RuntimeException("cause"));
269+
* }</pre>
270+
*/
116271
@Override
117272
public void error(String message, Throwable t) {
118273
this.logger.error(message, t);
119274
}
120275

276+
/**
277+
* Returns the underlying Log4j {@link Logger} delegate.
278+
*
279+
* <h3>Example Usage</h3>
280+
* <pre>{@code
281+
* Log4jLogger logger = new Log4jLogger("io.microsphere");
282+
* org.apache.log4j.Logger delegate = (org.apache.log4j.Logger) logger.getDelegate();
283+
* }</pre>
284+
*/
121285
@Override
122286
public Object getDelegate() {
123287
return this.logger;

0 commit comments

Comments
 (0)