zdm/event-bus
zdm/event-bus
3
Fork 0
Code Issues 2 Pull Requests Releases 8 Wiki Activity

Compare commits

base: zdm:4a5b94a9b747968ef6608bdfa105c5eda6921813
Branches Tags
zdm:develop
zdm:1.2.0
zdm:1.1.0
zdm:1.0.0
zdm:0.1.0
zdm:0.0.4
zdm:0.0.3
zdm:0.0.2
zdm:0.0.1
...
compare: zdm:9379e6bb947909b2422898f65e13444ecd85c21b
Branches Tags
zdm:develop
zdm:1.2.0
zdm:1.1.0
zdm:1.0.0
zdm:0.1.0
zdm:0.0.4
zdm:0.0.3
zdm:0.0.2
zdm:0.0.1

3 Commits
4a5b94a9b7 ... 9379e6bb94

Author SHA1 Message Date
kske
9379e6bb94
Merge pull request 'Additional Warnings in Event Bus Proc' (#8) from f/additional-warnings into develop 
Reviewed-on: https://git.kske.dev/kske/event-bus/pulls/8
Reviewed-by: delvh <leon@kske.dev>
 2021-02-20 21:46:08 +01:00
kske
8a30493c52
Warn about unused event handler return values 
If an event handler has a non-void return type, a warning is issued as
the event bus cannot use the returned value.

In rare cases this might be justified as the event handler could be
invoked directly.
 2021-02-19 11:34:58 +01:00
kske
b56f08e441
Warn about unnecessarily polymorphic event handlers 
When Event Bus Proc detects a handler for a final type that uses the
@Polymorphic annotation, it issues a warning.
 2021-02-19 11:30:09 +01:00
1 changed files with 15 additions and 5 deletions
Show Stats Expand all files Collapse all files

20
event-bus-proc/src/main/java/dev/kske/eventbus/proc/EventProcessor.java
View File

@ -63,6 +63,10 @@ public class EventProcessor extends AbstractProcessor {
else else
pass = true; pass = true;
// Warn the user about unused return values
if (useParameter && eventHandler.getReturnType().getKind() != TypeKind.VOID)
warning(eventHandler, "Unused return value");
// Abort checking if the handler signature is incorrect // Abort checking if the handler signature is incorrect
if (!pass) if (!pass)
continue; continue;
@ -80,14 +84,20 @@ public class EventProcessor extends AbstractProcessor {
} }
} }
// Check for handlers for abstract types that aren't polymorphic // Detect missing or useless @Polymorphic
boolean polymorphic = eventHandler.getAnnotation(Polymorphic.class) != null;
Element eventElement = ((DeclaredType) eventType).asElement(); Element eventElement = ((DeclaredType) eventType).asElement();
if (eventHandler.getAnnotation(Polymorphic.class) == null
&& (eventElement.getKind() == ElementKind.INTERFACE // Check for handlers for abstract types that aren't polymorphic
|| eventElement.getModifiers().contains(Modifier.ABSTRACT))) { if (!polymorphic && (eventElement.getKind() == ElementKind.INTERFACE
|| eventElement.getModifiers().contains(Modifier.ABSTRACT)))
warning(eventHandler, warning(eventHandler,
"Parameter should be instantiable or handler should use @Polymorphic"); "Parameter should be instantiable or handler should use @Polymorphic");
}
// Check for handlers for final types that are polymorphic
else if (polymorphic && eventElement.getModifiers().contains(Modifier.FINAL))
warning(eventHandler,
"@Polymorphic should be removed as parameter cannot be subclassed");
} }
} }