Skip to content

Commit 760142b

Browse files
committed
fix javadoc warnings
1 parent 18419d4 commit 760142b

55 files changed

Lines changed: 617 additions & 41 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

guicey-admin-rest/src/main/java/ru/vyarus/guicey/admin/log/LogbackAccessRequestLogAwareCustomHandler.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ public class LogbackAccessRequestLogAwareCustomHandler extends Handler.Wrapper {
2828

2929
private final boolean identifyAdminContext;
3030

31+
/**
32+
* Creates custom logback handler.
33+
*
34+
* @param identifyAdminContext true to identify admin context logs
35+
*/
3136
public LogbackAccessRequestLogAwareCustomHandler(final boolean identifyAdminContext) {
3237
this.identifyAdminContext = identifyAdminContext;
3338
}
@@ -44,7 +49,7 @@ public boolean handle(final Request request,
4449
// indicate admin context call in log
4550
servletContextRequest = (ServletContextRequest) servletContextRequest
4651
.wrap(request, HttpURI.build(request.getHttpURI())
47-
.uri(request.getHttpURI() + " (ADMIN REST)"));
52+
.uri(request.getHttpURI() + " (ADMIN REST)"));
4853
}
4954
if (servletContextRequest != null) {
5055
final Request unwrapped = Request.unWrap(request);

guicey-admin-rest/src/main/java/ru/vyarus/guicey/admin/rest/AdminRestServlet.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import jakarta.servlet.http.HttpServlet;
66
import jakarta.servlet.http.HttpServletRequest;
77
import jakarta.servlet.http.HttpServletResponse;
8+
89
import java.io.IOException;
910

1011
/**
@@ -23,6 +24,9 @@ public class AdminRestServlet extends HttpServlet {
2324
*/
2425
public static final String ADMIN_PROPERTY = AdminRestServlet.class.getName();
2526

27+
/**
28+
* Servlet context.
29+
*/
2630
private final Servlet restServlet;
2731

2832
/**

guicey-eventbus/src/main/java/com/google/common/eventbus/SubscriptionIntrospector.java

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,26 @@ public class SubscriptionIntrospector {
2222
private final EventBus eventbus;
2323
private Map<Class, Set<Subscriber>> subscribers;
2424

25+
/**
26+
* Create an introspector.
27+
*
28+
* @param eventbus event bus instance
29+
*/
2530
public SubscriptionIntrospector(final EventBus eventbus) {
2631
this.eventbus = eventbus;
2732
}
2833

34+
/**
35+
* @return event classes
36+
*/
2937
public Set<Class> getListenedEvents() {
3038
return extractSubscribers().keySet();
3139
}
3240

41+
/**
42+
* @param event event class
43+
* @return event subscribers
44+
*/
3345
public Set<Object> getSubscribers(final Class event) {
3446
final Set<Object> res = new HashSet<>();
3547
final Set<Subscriber> subscribers = extractSubscribers().get(event);
@@ -41,6 +53,11 @@ public Set<Object> getSubscribers(final Class event) {
4153
return res;
4254
}
4355

56+
/**
57+
* @param event event class
58+
* @return subscriber classes
59+
* @see #getSubscribers(Class) for instances
60+
*/
4461
public Set<Class> getSubscriberTypes(final Class event) {
4562
final Set<Class> res = new HashSet<>();
4663
for (Object obj : getSubscribers(event)) {

guicey-eventbus/src/main/java/ru/vyarus/guicey/eventbus/module/EventBusModule.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ public class EventBusModule extends AbstractModule {
2626
private final EventBus eventbus;
2727
private final Matcher<? super TypeLiteral<?>> typeMatcher;
2828

29+
/**
30+
* Create event bus module.
31+
*
32+
* @param eventbus event bus instance
33+
* @param typeMatcher matcher for classes to search listener methods in
34+
*/
2935
public EventBusModule(final EventBus eventbus,
3036
final Matcher<? super TypeLiteral<?>> typeMatcher) {
3137
this.eventbus = eventbus;

guicey-eventbus/src/main/java/ru/vyarus/guicey/eventbus/module/TypeLiteralAdapterMatcher.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@
1212
public class TypeLiteralAdapterMatcher implements Matcher<TypeLiteral<?>> {
1313
private final Matcher<? super Class<?>> classMatcher;
1414

15+
/**
16+
* Create a type literal matcher.
17+
*
18+
* @param classMatcher class matcher
19+
*/
1520
public TypeLiteralAdapterMatcher(final Matcher<? super Class<?>> classMatcher) {
1621
this.classMatcher = classMatcher;
1722
}

guicey-eventbus/src/main/java/ru/vyarus/guicey/eventbus/report/EventSubscribersReporter.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,18 @@ public class EventSubscribersReporter {
2525

2626
private final EventSubscribersInfo info;
2727

28+
/**
29+
* Create event bus subscribers reporter.
30+
*
31+
* @param info subscribers info
32+
*/
2833
public EventSubscribersReporter(final EventSubscribersInfo info) {
2934
this.info = info;
3035
}
3136

37+
/**
38+
* @return rendered events and subscribers report
39+
*/
3240
public String renderReport() {
3341
final Set<Class> events = info.getListenedEvents();
3442
if (events.isEmpty()) {

guicey-eventbus/src/main/java/ru/vyarus/guicey/eventbus/service/EventSubscribersInfo.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
import jakarta.inject.Inject;
77
import jakarta.inject.Singleton;
8+
89
import java.util.Set;
910

1011
/**
@@ -18,6 +19,11 @@
1819
public class EventSubscribersInfo {
1920
private final SubscriptionIntrospector introspector;
2021

22+
/**
23+
* Create event bus subscribers info.
24+
*
25+
* @param eventbus event bus instance
26+
*/
2127
@Inject
2228
public EventSubscribersInfo(final EventBus eventbus) {
2329
this.introspector = new SubscriptionIntrospector(eventbus);

guicey-jdbi3/src/main/java/org/jdbi/v3/core/TransactionalHandleSupplier.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ public class TransactionalHandleSupplier implements HandleSupplier {
2222
private final Jdbi jdbi;
2323
private final Provider<Handle> handleProvider;
2424

25+
/**
26+
* Create a transactional handle supplier.
27+
*
28+
* @param jdbi jdbi instance
29+
* @param handleProvider handle provider
30+
*/
2531
@Inject
2632
public TransactionalHandleSupplier(final Jdbi jdbi, final Provider<Handle> handleProvider) {
2733
this.jdbi = jdbi;

guicey-jdbi3/src/main/java/ru/vyarus/guicey/jdbi3/dbi/SimpleDbiProvider.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ public class SimpleDbiProvider<C extends Configuration> implements ConfigAwarePr
1717

1818
private final ConfigAwareProvider<PooledDataSourceFactory, C> database;
1919

20+
/**
21+
* Create configuration-aware jdbi provider.
22+
*
23+
* @param database configuration provider
24+
*/
2025
public SimpleDbiProvider(final ConfigAwareProvider<PooledDataSourceFactory, C> database) {
2126
this.database = database;
2227
}

guicey-jdbi3/src/main/java/ru/vyarus/guicey/jdbi3/installer/repository/RepositoryInstaller.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
import jakarta.inject.Provider;
2525
import jakarta.inject.Singleton;
26+
2627
import java.lang.reflect.InvocationTargetException;
2728
import java.util.Collections;
2829
import java.util.HashSet;
@@ -158,6 +159,11 @@ public static class JdbiProxyRedirect implements MethodInterceptor {
158159

159160
private final Provider<Object> jdbiProxy;
160161

162+
/**
163+
* Create jdbi proxy interceptor.
164+
*
165+
* @param jdbiProxy jdbi proxy provider
166+
*/
161167
public JdbiProxyRedirect(final Provider<Object> jdbiProxy) {
162168
this.jdbiProxy = jdbiProxy;
163169
}

0 commit comments

Comments
 (0)