Skip to content

Commit 7f15659

Browse files
committed
fix javadoc warnings
(cherry picked from commit 760142b)
1 parent 17c2804 commit 7f15659

54 files changed

Lines changed: 604 additions & 44 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/rest/AdminRestServlet.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ public class AdminRestServlet extends HttpServlet {
2323
*/
2424
public static final String ADMIN_PROPERTY = AdminRestServlet.class.getName();
2525

26+
/**
27+
* Servlet context.
28+
*/
2629
private final Servlet restServlet;
2730

2831
/**

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: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
public class EventSubscribersInfo {
1919
private final SubscriptionIntrospector introspector;
2020

21+
/**
22+
* Create event bus subscribers info.
23+
*
24+
* @param eventbus event bus instance
25+
*/
2126
@Inject
2227
public EventSubscribersInfo(final EventBus eventbus) {
2328
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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public List<String> getRecognizableSigns() {
103103
return Collections.singletonList("@" + JdbiRepository.class + " on class");
104104
}
105105

106-
@SuppressWarnings({"unchecked", "checkstyle:Indentation"})
106+
@SuppressWarnings({"unchecked", "checkstyle:Indentation", "PMD.UseDiamondOperator"})
107107
private void generateRepository(final Binder binder, final Class<?> type) {
108108
// avoid duplicate bindings from classpath scan and binding
109109
if (bound.contains(type)) {
@@ -158,6 +158,11 @@ public static class JdbiProxyRedirect implements MethodInterceptor {
158158

159159
private final Provider<Object> jdbiProxy;
160160

161+
/**
162+
* Create jdbi proxy interceptor.
163+
*
164+
* @param jdbiProxy jdbi proxy provider
165+
*/
161166
public JdbiProxyRedirect(final Provider<Object> jdbiProxy) {
162167
this.jdbiProxy = jdbiProxy;
163168
}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ public class SqlObjectProvider<T> implements Provider<T> {
3333
@SuppressWarnings("PMD.AvoidUsingVolatile")
3434
private volatile T res;
3535

36+
/**
37+
* Dao proxy provider.
38+
*
39+
* @param extensionType dao class
40+
*/
3641
public SqlObjectProvider(final Class<T> extensionType) {
3742
this.extensionType = extensionType;
3843
}

0 commit comments

Comments
 (0)