Compare commits
73 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
cc5c07079a
|
|||
8fae4f6d76
|
|||
|
2d276a1d74
|
|||
|
8609c6a90c
|
|||
|
ee9d08b2b8
|
|||
|
5468bddb35
|
|||
|
a8d858e8c7
|
|||
|
6ee4e11161
|
|||
|
8615a0e021
|
|||
|
3aef7d5bcb
|
|||
|
36ed55fd71
|
|||
|
999a172e72
|
|||
|
722bf2b999
|
|||
|
7fb633d69f
|
|||
|
c5607d12ae
|
|||
|
a8810c497f
|
|||
|
ebb2191f4a
|
|||
|
09d251a02a
|
|||
|
27d14a844d
|
|||
adbcc64e94
|
|||
|
84ae42b44f
|
|||
|
e53f356c54
|
|||
|
d649f377b7
|
|||
|
897f1a20f3
|
|||
|
856a2e8cbf
|
|||
|
11860d1469
|
|||
|
f620f06208
|
|||
|
5a6d8bcf35
|
|||
|
39ffb5c82a
|
|||
|
5ddef71c26
|
|||
|
85b2da391a
|
|||
|
46a358da97
|
|||
|
6bf9e1097a
|
|||
|
3fccb809c8
|
|||
|
d1c4bcc7eb
|
|||
|
ad29a93ccb
|
|||
|
e67b64678b
|
|||
|
c614beb063
|
|||
|
d3abb0aca3
|
|||
|
ee688929fd
|
|||
|
897d794b86
|
|||
|
40d48cb959
|
|||
|
b760c58298
|
|||
|
872b395374
|
|||
|
82c66c45ec
|
|||
|
866a547114
|
|||
|
33ebf0302b
|
|||
|
b915a5c490
|
|||
|
205a183db7
|
|||
|
74447dea59
|
|||
|
6eebd3c121
|
|||
|
b758f4cef1
|
|||
|
0dcad7d178
|
|||
|
c0cda7341b
|
|||
|
b804243f4e
|
|||
|
0aef1c299b
|
|||
|
51f10c4144
|
|||
|
f74b953db8
|
|||
|
52719d22d4
|
|||
|
122106bf39
|
|||
|
7357198d45
|
|||
|
32dfe64c0f
|
|||
|
2ec0a82a96
|
|||
|
6c74af608c
|
|||
|
d9ddc0e1a9
|
|||
|
7c3cd017de
|
|||
|
6a2cad4ae5
|
|||
|
0f9b64be48
|
|||
|
b2fe3a9d6c
|
|||
|
9379e6bb94
|
|||
|
0036dc4829
|
|||
|
8a30493c52
|
|||
|
b56f08e441
|
41
Jenkinsfile
vendored
Normal file
41
Jenkinsfile
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
pipeline {
|
||||
agent any
|
||||
|
||||
options {
|
||||
ansiColor('xterm')
|
||||
}
|
||||
|
||||
stages {
|
||||
stage('Build') {
|
||||
steps {
|
||||
sh 'mvn -DskipTests clean package'
|
||||
}
|
||||
}
|
||||
stage('Test') {
|
||||
steps {
|
||||
sh 'mvn test'
|
||||
}
|
||||
post {
|
||||
always {
|
||||
junit '*/target/surefire-reports/*.xml'
|
||||
publishCoverage adapters: [jacocoAdapter(mergeToOneReport: true, path: '*/target/site/jacoco/jacoco.xml')]
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('SonarQube Analysis') {
|
||||
when {
|
||||
branch 'develop'
|
||||
}
|
||||
steps {
|
||||
withSonarQubeEnv('KSKE SonarQube') {
|
||||
sh 'mvn sonar:sonar'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
post {
|
||||
success {
|
||||
archiveArtifacts artifacts: '*/target/event-bus-*.jar'
|
||||
}
|
||||
}
|
||||
}
|
||||
681
LICENSE
681
LICENSE
@ -1,674 +1,13 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
Copyright 2021 Kai S. K. Engelbart
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
Preamble
|
||||
https://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
131
README.md
131
README.md
@ -45,9 +45,6 @@ public class SimpleEventListener {
|
||||
}
|
||||
```
|
||||
|
||||
In this case, an event bus is created and used locally.
|
||||
In a more sophisticated example the class would acquire an external event bus that is used by multiple classes.
|
||||
|
||||
Note that creating static event handlers like this
|
||||
|
||||
```java
|
||||
@ -57,6 +54,33 @@ private static void onSimpleEvent(SimpleEvent event) { ... }
|
||||
|
||||
is technically possible, however you would still have to create an instance of the event listener to register it at an event bus.
|
||||
|
||||
## Installation
|
||||
|
||||
Event Bus is available in Maven Central.
|
||||
To include it inside your project, just add the following dependency to your `pom.xml`:
|
||||
|
||||
```xml
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus-core</artifactId>
|
||||
<version>1.2.0</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
|
||||
Then, require the Event Bus Core module in your `module-info.java`:
|
||||
|
||||
```java
|
||||
requires dev.kske.eventbus.core;
|
||||
```
|
||||
|
||||
If you intend to use event handlers that are inaccessible to Event Bus by means of Java language access control, make sure to allow reflective access to your package for Event Bus:
|
||||
|
||||
```java
|
||||
opens my.package to dev.kske.eventbus.core;
|
||||
```
|
||||
|
||||
## Polymorphic Event Handlers
|
||||
|
||||
On certain occasions it's practical for an event handler to accept both events of the specified type, as well as subclasses of that event.
|
||||
@ -97,6 +121,25 @@ private void onSimpleEvent() {
|
||||
|
||||
Make sure that you **do not** both declare a parameter and specify the event type in the annotation, as this would be ambiguous.
|
||||
|
||||
## Callback listeners
|
||||
|
||||
While defining event handlers as annotated methods is rather simple and readable, sometimes a more flexible approach is required.
|
||||
For this reason, there are callback event handlers that allow the registration of an "inline" event listener consisting of just one handler in the form of a consumer:
|
||||
|
||||
```java
|
||||
EventBus.getInstance().registerListener(SimpleEvent.class, e -> System.out.println("Received " + e));
|
||||
```
|
||||
|
||||
The event type has to be defined explicitly, with the priority and polymorphism parameters being optional.
|
||||
If you intend to remove the listener later, remember to keep a reference to it, as you would have to clear the entire event bus if you didn't.
|
||||
|
||||
## Listener-Level Properties
|
||||
|
||||
When defining a dedicated event listener that, for example, performs pre- or post-processing, all event handlers will probably have the same non-standard priority.
|
||||
Instead of defining that priority for each handler, it can be defined at the listener level by annotating the listener itself.
|
||||
|
||||
The same applies to polymorphism.
|
||||
|
||||
## Event Consumption
|
||||
|
||||
In some cases it might be useful to stop the propagation of an event.
|
||||
@ -123,32 +166,80 @@ This applies to all event handlers that would have been executed after the one c
|
||||
Avoid cancelling events while using multiple event handlers with the same priority.
|
||||
As event handlers are ordered by priority, it is not defined which of them will be executed after the event has been consumed.
|
||||
|
||||
## Installation
|
||||
## System Events
|
||||
|
||||
Event Bus is available in Maven Central.
|
||||
To include it inside your project, just add the following dependency to your `pom.xml`:
|
||||
To accommodate for special circumstances in an event distribution, system events have been introduced.
|
||||
At the moment, there are two system events, which are explained in this section.
|
||||
|
||||
```xml
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus-core</artifactId>
|
||||
<version>1.0.0</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
### Detecting Unhandled Events
|
||||
|
||||
Then, require the Event Bus Core module in your `module-info.java`:
|
||||
When an event is dispatched but not delivered to any handler, a dead event is dispatched that wraps the original event.
|
||||
You can declare a dead event handler to respond to this situation:
|
||||
|
||||
```java
|
||||
requires dev.kske.eventbus.core;
|
||||
private void onDeadEvent(DeadEvent deadEvent) { ... }
|
||||
```
|
||||
|
||||
If you intend to use event handlers that are inaccessible to Event Bus by means of Java language access control, make sure to allow reflective access from your module:
|
||||
### Detecting Exceptions Thrown by Event Handlers
|
||||
|
||||
When an event handler throws an exception, an exception event is dispatched that wraps the original event.
|
||||
An exception handler is declared as follows:
|
||||
|
||||
```java
|
||||
opens my.module to dev.kske.eventbus.core;
|
||||
private void onExceptionEvent(ExceptionEvent ExceptionEvent) { ... }
|
||||
```
|
||||
Both system events reference the event bus that caused them and a warning is logged if they are unhandled.
|
||||
|
||||
#### Yeeting Exceptions Out of an Event Handler
|
||||
|
||||
In some cases, a warning about an `Exception` that was thrown in an event handler is not enough, stays unnoticed, or an exception should be catched explicitly.
|
||||
Event Bus explicitly dispatches no `ExceptionEvent` when an `ExceptionWrapper` exception is thrown and instead simply rethrows it.
|
||||
`ExceptionWrapper` is an unchecked exception that (as the name says) simply wraps an exception that caused it.
|
||||
This means the following is possible and results in a normal program exit:
|
||||
```java
|
||||
@Event(String.class)
|
||||
void onString() {
|
||||
throw new ExceptionWrapper(new RuntimeException("I failed!"));
|
||||
}
|
||||
|
||||
void helloStackTrace() {
|
||||
EventBus.getInstance().registerListener(this);
|
||||
try {
|
||||
EventBus.getInstance().dispatch("A string!");
|
||||
System.exit(-1);
|
||||
} catch(ExceptionWrapper e) {
|
||||
e.getCause().printStackTrace();
|
||||
System.exit(0);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### What About Endless Recursion Caused By Dead Events and Exception Events?
|
||||
|
||||
As one might imagine, an unhandled dead event would theoretically lead to an endless recursion.
|
||||
The same applies when an exception event handler throws an exception.
|
||||
|
||||
To avoid this, system events never cause system events and instead just issue a warning to the logger.
|
||||
|
||||
## Inheritance
|
||||
|
||||
When a superclass or an interface of an event listener defines event handlers, they will be detected and registered by Event Bus, even if they are `private`.
|
||||
If an event handler is overridden by the listener, the `@Event` annotation of the overridden method is automatically considered present on the overriding method.
|
||||
If the overridden method already contains an implementation in the superclass, the superclass implementation is ignored as expected.
|
||||
|
||||
The `@Priority` and `@Polymorphic` annotations are inherited both on a class and on a method level.
|
||||
If the priority or polymorphism has to be redefined on an inherited handler, the `@Event` annotation has to be added explicitly.
|
||||
|
||||
## Debugging
|
||||
|
||||
In more complex setups, taking a look at the event handler execution order can be helpful for debugging.
|
||||
Event Bus offers a method for this purpose which can be used as follows:
|
||||
|
||||
```java
|
||||
System.out.println(EventBus.getInstance().debugExecutionOrder(SimpleEvent.class));
|
||||
```
|
||||
|
||||
Then, the execution order can be inspected in the console.
|
||||
|
||||
## Compile-Time Error Checking with Event Bus Proc
|
||||
|
||||
@ -169,7 +260,7 @@ When using Maven, it can be registered using the Maven Compiler Plugin:
|
||||
<annotationProcessorPath>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus-proc</artifactId>
|
||||
<version>1.0.0</version>
|
||||
<version>1.2.0</version>
|
||||
</annotationProcessorPath>
|
||||
</annotationProcessorPaths>
|
||||
</configuration>
|
||||
|
||||
66
core/pom.xml
Normal file
66
core/pom.xml
Normal file
@ -0,0 +1,66 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<artifactId>event-bus-core</artifactId>
|
||||
<name>Event Bus Core</name>
|
||||
|
||||
<parent>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus</artifactId>
|
||||
<version>1.2.0</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter-api</artifactId>
|
||||
<version>5.8.1</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
|
||||
<!-- Disable resource folder -->
|
||||
<resources />
|
||||
|
||||
<plugins>
|
||||
|
||||
<!-- Run unit tests -->
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-surefire-plugin</artifactId>
|
||||
<version>3.0.0-M5</version>
|
||||
<configuration>
|
||||
<argLine>
|
||||
${argLine}
|
||||
--add-opens dev.kske.eventbus.core/dev.kske.eventbus.core=ALL-UNNAMED
|
||||
--add-opens dev.kske.eventbus.core/dev.kske.eventbus.core.handler=ALL-UNNAMED
|
||||
</argLine>
|
||||
</configuration>
|
||||
</plugin>
|
||||
|
||||
<!-- Generate coverage report -->
|
||||
<plugin>
|
||||
<groupId>org.jacoco</groupId>
|
||||
<artifactId>jacoco-maven-plugin</artifactId>
|
||||
<version>0.8.7</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<goals>
|
||||
<goal>prepare-agent</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>report</id>
|
||||
<phase>test</phase>
|
||||
<goals>
|
||||
<goal>report</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
37
core/src/main/java/dev/kske/eventbus/core/DeadEvent.java
Normal file
37
core/src/main/java/dev/kske/eventbus/core/DeadEvent.java
Normal file
@ -0,0 +1,37 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* Wraps an event that was dispatched but for which no handler has been bound.
|
||||
* <p>
|
||||
* Handling dead events is useful as it can identify a poorly configured event distribution.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public final class DeadEvent {
|
||||
|
||||
private final EventBus eventBus;
|
||||
private final Object event;
|
||||
|
||||
DeadEvent(EventBus eventBus, Object event) {
|
||||
this.eventBus = eventBus;
|
||||
this.event = event;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return String.format("DeadEvent[eventBus=%s, event=%s]", eventBus, event);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return the event bus that dispatched this event
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public EventBus getEventBus() { return eventBus; }
|
||||
|
||||
/**
|
||||
* @return the event that could not be delivered
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public Object getEvent() { return event; }
|
||||
}
|
||||
@ -22,7 +22,7 @@ import java.lang.annotation.*;
|
||||
public @interface Event {
|
||||
|
||||
/**
|
||||
* Defines the event type the handler listens to. If this value is set, the handler is not
|
||||
* Defines the event type the handler listens for. If this value is set, the handler is not
|
||||
* allowed to declare parameters.
|
||||
* <p>
|
||||
* This is useful when the event handler does not utilize the event instance.
|
||||
@ -30,13 +30,5 @@ public @interface Event {
|
||||
* @return the event type accepted by the handler
|
||||
* @since 1.0.0
|
||||
*/
|
||||
Class<?> value() default USE_PARAMETER.class;
|
||||
|
||||
/**
|
||||
* Signifies that the event type the handler listens to is determined by the type of its only
|
||||
* parameter.
|
||||
*
|
||||
* @since 0.0.3
|
||||
*/
|
||||
static final class USE_PARAMETER {}
|
||||
Class<?> value() default void.class;
|
||||
}
|
||||
503
core/src/main/java/dev/kske/eventbus/core/EventBus.java
Normal file
503
core/src/main/java/dev/kske/eventbus/core/EventBus.java
Normal file
@ -0,0 +1,503 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import java.lang.System.Logger;
|
||||
import java.lang.System.Logger.Level;
|
||||
import java.lang.annotation.Annotation;
|
||||
import java.lang.reflect.*;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
import dev.kske.eventbus.core.handler.*;
|
||||
|
||||
/**
|
||||
* Event listeners can be registered at an event bus to be notified when an event is dispatched.
|
||||
* <p>
|
||||
* A singleton instance of this class can be lazily created and acquired using the
|
||||
* {@link EventBus#getInstance()} method.
|
||||
*
|
||||
* @implNote This is a thread-safe implementation.
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
* @see Event
|
||||
*/
|
||||
public final class EventBus {
|
||||
|
||||
/**
|
||||
* Holds the state of the dispatching process on one thread.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
private static final class DispatchState {
|
||||
|
||||
/**
|
||||
* Indicates that the last event handler invoked has called {@link EventBus#cancel}. In that
|
||||
* case, the event is not dispatched further.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
boolean isCancelled;
|
||||
|
||||
/**
|
||||
* Is incremented when {@link EventBus#dispatch(Object)} is invoked and decremented when it
|
||||
* finishes. This allows keeping track of nested dispatches.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
int nestingCount;
|
||||
}
|
||||
|
||||
/**
|
||||
* The priority assigned to every event handler without an explicitly defined priority.
|
||||
*
|
||||
* @since 1.1.0
|
||||
* @see Priority
|
||||
*/
|
||||
public static final int DEFAULT_PRIORITY = 100;
|
||||
|
||||
private static final EventBus singletonInstance = new EventBus();
|
||||
|
||||
private static final Logger logger = System.getLogger(EventBus.class.getName());
|
||||
|
||||
/**
|
||||
* Compares event handlers based on priority, but uses hash codes for equal priorities.
|
||||
*
|
||||
* @implNote As the priority comparator by itself is not consistent with equals (two handlers
|
||||
* with the same priority are not necessarily equal, but would have a comparison
|
||||
* result of 0), the hash code is used for the fallback comparison. This way,
|
||||
* consistency with equals is restored.
|
||||
* @since 1.2.0
|
||||
*/
|
||||
private static final Comparator<EventHandler> byPriority =
|
||||
Comparator.comparingInt(EventHandler::getPriority).reversed()
|
||||
.thenComparingInt(EventHandler::hashCode);
|
||||
|
||||
/**
|
||||
* Returns the default event bus, which is a statically initialized singleton instance.
|
||||
*
|
||||
* @return the default event bus
|
||||
* @since 0.0.2
|
||||
*/
|
||||
public static EventBus getInstance() {
|
||||
return singletonInstance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Event handler bindings (target class to handlers registered for that class), does not contain
|
||||
* other (polymorphic) handlers.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
private final Map<Class<?>, TreeSet<EventHandler>> bindings = new ConcurrentHashMap<>();
|
||||
|
||||
/**
|
||||
* A cache mapping an event class to all handlers the event should be dispatched to. This
|
||||
* includes polymorphic handlers that don't reference the event class explicitly. If an event
|
||||
* class is not contained inside this cache, the {@link #bindings} have to be traversed manually
|
||||
* in search of applicable handlers.
|
||||
*
|
||||
* @since 1.3.0
|
||||
*/
|
||||
private final Map<Class<?>, TreeSet<EventHandler>> bindingCache = new ConcurrentHashMap<>();
|
||||
|
||||
/**
|
||||
* Stores all registered event listeners (which declare event handlers) and prevents them from
|
||||
* being garbage collected.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
private final Set<Object> registeredListeners = ConcurrentHashMap.newKeySet();
|
||||
|
||||
/**
|
||||
* The current event dispatching state, local to each thread.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
private final ThreadLocal<DispatchState> dispatchState =
|
||||
ThreadLocal.withInitial(DispatchState::new);
|
||||
|
||||
/**
|
||||
* Dispatches an event to all event handlers registered for it in descending order of their
|
||||
* priority.
|
||||
*
|
||||
* @param event the event to dispatch
|
||||
* @throws EventBusException if an event handler isn't accessible or has an invalid signature
|
||||
* @throws ExceptionWrapper if it is thrown by an event handler
|
||||
* @throws NullPointerException if the specified event is {@code null}
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public void dispatch(Object event) {
|
||||
Objects.requireNonNull(event);
|
||||
logger.log(Level.INFO, "Dispatching event {0}", event);
|
||||
|
||||
// Look up dispatch state
|
||||
var state = dispatchState.get();
|
||||
|
||||
// Increment nesting count (becomes > 1 during nested dispatches)
|
||||
++state.nestingCount;
|
||||
|
||||
Iterator<EventHandler> handlers = getHandlersFor(event.getClass()).iterator();
|
||||
if (handlers.hasNext()) {
|
||||
while (handlers.hasNext())
|
||||
if (state.isCancelled) {
|
||||
logger.log(Level.INFO, "Cancelled dispatching event {0}", event);
|
||||
state.isCancelled = false;
|
||||
break;
|
||||
} else {
|
||||
try {
|
||||
handlers.next().execute(event);
|
||||
} catch (InvocationTargetException e) {
|
||||
if (e.getCause() instanceof Error)
|
||||
|
||||
// Transparently pass error to the caller
|
||||
throw (Error) e.getCause();
|
||||
else if (e.getCause() instanceof ExceptionWrapper)
|
||||
|
||||
// Transparently pass exception wrapper to the caller
|
||||
throw (ExceptionWrapper) e.getCause();
|
||||
else if (event instanceof DeadEvent || event instanceof ExceptionEvent)
|
||||
|
||||
// Warn about system event not being handled
|
||||
logger.log(Level.WARNING, event + " not handled due to exception", e);
|
||||
else
|
||||
|
||||
// Dispatch exception event
|
||||
dispatch(new ExceptionEvent(this, event, e.getCause()));
|
||||
}
|
||||
}
|
||||
} else if (event instanceof DeadEvent || event instanceof ExceptionEvent) {
|
||||
|
||||
// Warn about the dead event not being handled
|
||||
logger.log(Level.WARNING, "{0} not handled", event);
|
||||
} else {
|
||||
|
||||
// Dispatch dead event
|
||||
dispatch(new DeadEvent(this, event));
|
||||
}
|
||||
|
||||
// Decrement nesting count (becomes 0 when all dispatches on the thread are finished)
|
||||
--state.nestingCount;
|
||||
|
||||
logger.log(Level.DEBUG, "Finished dispatching event {0}", event);
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches for the event handlers bound to an event class. This includes polymorphic handlers
|
||||
* that are bound to a supertype of the event class.
|
||||
*
|
||||
* @implNote If the given event type was requested in the past, the handlers are retrieved from
|
||||
* the {@link #bindingCache}. If not, the entire {@link #bindings} are traversed in
|
||||
* search of polymorphic handlers compatible with the event type.
|
||||
* @param eventType the event type to use for the search
|
||||
* @return a navigable set containing the applicable handlers in descending order of priority
|
||||
* @since 1.2.0
|
||||
*/
|
||||
private NavigableSet<EventHandler> getHandlersFor(Class<?> eventType) {
|
||||
return bindingCache.computeIfAbsent(eventType, k -> {
|
||||
|
||||
// Get handlers defined for the event class
|
||||
TreeSet<EventHandler> handlers =
|
||||
bindings.getOrDefault(eventType, new TreeSet<>(byPriority));
|
||||
|
||||
// Get polymorphic handlers
|
||||
for (var binding : bindings.entrySet())
|
||||
if (binding.getKey().isAssignableFrom(eventType))
|
||||
for (var handler : binding.getValue())
|
||||
if (handler.isPolymorphic())
|
||||
handlers.add(handler);
|
||||
|
||||
return handlers;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancels an event that is currently dispatched from inside an event handler.
|
||||
*
|
||||
* @throws EventBusException if the calling thread is not an active dispatching thread
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public void cancel() {
|
||||
var state = dispatchState.get();
|
||||
if (state.nestingCount > 0 && !state.isCancelled)
|
||||
state.isCancelled = true;
|
||||
else
|
||||
throw new EventBusException("Calling thread not an active dispatching thread!");
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers an event listener at this event bus.
|
||||
*
|
||||
* @param listener the listener to register
|
||||
* @throws EventBusException if the listener is already registered or a declared event
|
||||
* handler does not comply with the specification
|
||||
* @throws NullPointerException if the specified listener is {@code null}
|
||||
* @since 0.0.1
|
||||
* @see Event
|
||||
*/
|
||||
public void registerListener(Object listener) {
|
||||
Objects.requireNonNull(listener);
|
||||
if (registeredListeners.contains(listener))
|
||||
throw new EventBusException(listener + " already registered!");
|
||||
logger.log(Level.INFO, "Registering event listener {0}", listener.getClass().getName());
|
||||
boolean handlerBound = false;
|
||||
|
||||
// Predefined handler polymorphism
|
||||
boolean polymorphic = false;
|
||||
if (listener.getClass().isAnnotationPresent(Polymorphic.class))
|
||||
polymorphic = listener.getClass().getAnnotation(Polymorphic.class).value();
|
||||
|
||||
// Predefined handler priority
|
||||
int priority = DEFAULT_PRIORITY;
|
||||
if (listener.getClass().isAnnotationPresent(Priority.class))
|
||||
priority = listener.getClass().getAnnotation(Priority.class).value();
|
||||
|
||||
registeredListeners.add(listener);
|
||||
for (var method : getHandlerMethods(listener.getClass())) {
|
||||
Event annotation = method.getAnnotation(Event.class);
|
||||
|
||||
// Skip methods without annotations
|
||||
if (annotation == null)
|
||||
continue;
|
||||
|
||||
// Initialize and bind the handler
|
||||
bindHandler(
|
||||
new ReflectiveEventHandler(listener, method, annotation, polymorphic, priority));
|
||||
handlerBound = true;
|
||||
}
|
||||
|
||||
if (!handlerBound)
|
||||
logger.log(
|
||||
Level.WARNING,
|
||||
"No event handlers bound for event listener {0}",
|
||||
listener.getClass().getName());
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches for event handling methods declared inside the inheritance hierarchy of an event
|
||||
* listener.
|
||||
*
|
||||
* @param listenerClass the class to inspect
|
||||
* @return all event handling methods defined for the given listener
|
||||
* @since 1.3.0
|
||||
*/
|
||||
private Set<Method> getHandlerMethods(Class<?> listenerClass) {
|
||||
|
||||
// Get methods declared by the listener
|
||||
Set<Method> methods = getMethodsAnnotatedWith(listenerClass, Event.class);
|
||||
|
||||
// Recursively add superclass handlers
|
||||
Class<?> superClass = listenerClass.getSuperclass();
|
||||
if (superClass != null && superClass != Object.class)
|
||||
methods.addAll(getHandlerMethods(superClass));
|
||||
|
||||
// Recursively add interface handlers
|
||||
for (Class<?> iClass : listenerClass.getInterfaces())
|
||||
methods.addAll(getHandlerMethods(iClass));
|
||||
|
||||
return methods;
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches for declared methods with a specific annotation inside a class.
|
||||
*
|
||||
* @param enclosingClass the class to inspect
|
||||
* @param annotationClass the annotation to look for
|
||||
* @return all methods matching the search criteria
|
||||
* @since 1.3.0
|
||||
*/
|
||||
private Set<Method> getMethodsAnnotatedWith(Class<?> enclosingClass,
|
||||
Class<? extends Annotation> annotationClass) {
|
||||
var methods = new HashSet<Method>();
|
||||
for (var method : enclosingClass.getDeclaredMethods())
|
||||
if (method.isAnnotationPresent(annotationClass))
|
||||
methods.add(method);
|
||||
|
||||
return methods;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a callback listener, which is a consumer that is invoked when an event occurs. The
|
||||
* listener is not polymorphic and has the {@link #DEFAULT_PRIORITY}.
|
||||
*
|
||||
* @param <E> the event type the listener listens for
|
||||
* @param eventType the event type the listener listens for
|
||||
* @param eventListener the callback that is invoked when an event occurs
|
||||
* @since 1.2.0
|
||||
* @see #registerListener(Class, Consumer, boolean, int)
|
||||
*/
|
||||
public <E> void registerListener(Class<E> eventType, Consumer<E> eventListener) {
|
||||
registerListener(eventType, eventListener, false, DEFAULT_PRIORITY);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a callback listener, which is a consumer that is invoked when an event occurs. The
|
||||
* listener has the {@link #DEFAULT_PRIORITY}.
|
||||
*
|
||||
* @param <E> the event type the listener listens for
|
||||
* @param eventType the event type the listener listens for
|
||||
* @param eventListener the callback that is invoked when an event occurs
|
||||
* @param polymorphic whether the listener is also invoked for subtypes of the event type
|
||||
* @since 1.2.0
|
||||
* @see #registerListener(Class, Consumer, boolean, int)
|
||||
*/
|
||||
public <E> void registerListener(Class<E> eventType, Consumer<E> eventListener,
|
||||
boolean polymorphic) {
|
||||
registerListener(eventType, eventListener, polymorphic, DEFAULT_PRIORITY);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a callback listener, which is a consumer that is invoked when an event occurs. The
|
||||
* listener is not polymorphic.
|
||||
*
|
||||
* @param <E> the event type the listener listens for
|
||||
* @param eventType the event type the listener listens for
|
||||
* @param eventListener the callback that is invoked when an event occurs
|
||||
* @param priority the priority to assign to the listener
|
||||
* @since 1.2.0
|
||||
* @see #registerListener(Class, Consumer, boolean, int)
|
||||
*/
|
||||
public <E> void registerListener(Class<E> eventType, Consumer<E> eventListener, int priority) {
|
||||
registerListener(eventType, eventListener, false, priority);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a callback listener, which is a consumer that is invoked when an event occurs.
|
||||
*
|
||||
* @param <E> the event type the listener listens for
|
||||
* @param eventType the event type the listener listens for
|
||||
* @param eventListener the callback that is invoked when an event occurs
|
||||
* @param polymorphic whether the listener is also invoked for subtypes of the event type
|
||||
* @param priority the priority to assign to the listener
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public <E> void registerListener(Class<E> eventType, Consumer<E> eventListener,
|
||||
boolean polymorphic,
|
||||
int priority) {
|
||||
Objects.requireNonNull(eventListener);
|
||||
if (registeredListeners.contains(eventListener))
|
||||
throw new EventBusException(eventListener + " already registered!");
|
||||
logger.log(Level.INFO, "Registering callback event listener {0}",
|
||||
eventListener.getClass().getName());
|
||||
|
||||
registeredListeners.add(eventListener);
|
||||
bindHandler(new CallbackEventHandler(eventType, eventListener, polymorphic, priority));
|
||||
}
|
||||
|
||||
/**
|
||||
* Inserts a new handler into the {@link #bindings} map. Additionally, the handler is placed
|
||||
* inside the {@link #bindingCache} where applicable.
|
||||
*
|
||||
* @param handler the handler to bind
|
||||
* @since 1.2.0
|
||||
*/
|
||||
private void bindHandler(EventHandler handler) {
|
||||
|
||||
// Bind handler
|
||||
logger.log(Level.DEBUG, "Binding event handler {0}", handler);
|
||||
bindings.computeIfAbsent(handler.getEventType(), k -> new TreeSet<>(byPriority))
|
||||
.add(handler);
|
||||
|
||||
// Insert handler into cache
|
||||
bindingCache.computeIfAbsent(handler.getEventType(), k -> new TreeSet<>(byPriority))
|
||||
.add(handler);
|
||||
|
||||
// Handler is polymorphic => insert where applicable
|
||||
if (handler.isPolymorphic())
|
||||
for (var binding : bindingCache.entrySet())
|
||||
if (binding.getKey().isAssignableFrom(handler.getEventType()))
|
||||
binding.getValue().add(handler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a specific listener from this event bus.
|
||||
*
|
||||
* @param listener the listener to remove
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public void removeListener(Object listener) {
|
||||
Objects.requireNonNull(listener);
|
||||
logger.log(Level.INFO, "Removing event listener {0}", listener.getClass().getName());
|
||||
|
||||
// Remove bindings from binding map
|
||||
for (var binding : bindings.values()) {
|
||||
var it = binding.iterator();
|
||||
while (it.hasNext()) {
|
||||
var handler = it.next();
|
||||
if (handler.getListener().equals(listener)) {
|
||||
logger.log(Level.DEBUG, "Unbinding event handler {0}", handler);
|
||||
it.remove();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Remove bindings from cache
|
||||
for (var binding : bindingCache.values()) {
|
||||
var it = binding.iterator();
|
||||
while (it.hasNext()) {
|
||||
var handler = it.next();
|
||||
if (handler.getListener().equals(listener)) {
|
||||
logger.log(Level.TRACE, "Removing event handler {0} from cache", handler);
|
||||
it.remove();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Remove the listener itself
|
||||
registeredListeners.remove(listener);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all event listeners from this event bus.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public void clearListeners() {
|
||||
logger.log(Level.INFO, "Clearing event listeners");
|
||||
bindings.clear();
|
||||
bindingCache.clear();
|
||||
registeredListeners.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates a string describing the event handlers that would be executed for a specific event
|
||||
* type, in order and without actually executing them.
|
||||
*
|
||||
* @apiNote Using this method is only recommended for debugging purposes, as the output depends
|
||||
* on implementation internals which may be subject to change.
|
||||
* @implNote Nested dispatches are not accounted for, as this would require actually executing
|
||||
* the handlers.
|
||||
* @param eventType the event type to generate the execution order for
|
||||
* @return a human-readable event handler list suitable for debugging purposes
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public String debugExecutionOrder(Class<?> eventType) {
|
||||
var handlers = getHandlersFor(eventType);
|
||||
var sj = new StringJoiner("\n");
|
||||
|
||||
// Output header line
|
||||
sj.add(String.format("Event handler execution order for %s (%d handler(s)):", eventType,
|
||||
handlers.size()));
|
||||
sj.add(
|
||||
"==========================================================================================");
|
||||
|
||||
// Individual handlers
|
||||
for (var handler : handlers)
|
||||
sj.add(handler.toString());
|
||||
|
||||
// Bottom line
|
||||
sj.add(
|
||||
"==========================================================================================");
|
||||
|
||||
return sj.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides an unmodifiable view of the event listeners registered at this event bus.
|
||||
*
|
||||
* @return all registered event listeners
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public Set<Object> getRegisteredListeners() {
|
||||
return Collections.unmodifiableSet(registeredListeners);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,39 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* This unchecked exception is specific to the event bus and can be thrown under the following
|
||||
* circumstances:
|
||||
* <ul>
|
||||
* <li>An event handler throws an exception (which is stored as the cause)</li>
|
||||
* <li>An event listener with an invalid event handler is registered</li>
|
||||
* <li>{@link EventBus#cancel()} is invoked from outside an active dispatch thread</li>
|
||||
* </ul>
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public final class EventBusException extends RuntimeException {
|
||||
|
||||
private static final long serialVersionUID = 7254445250300604449L;
|
||||
|
||||
/**
|
||||
* Creates a new event bus exception.
|
||||
*
|
||||
* @param message the message to display
|
||||
* @param cause the cause of this exception
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public EventBusException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new event bus exception.
|
||||
*
|
||||
* @param message the message to display
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public EventBusException(String message) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,47 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* Wraps an event that was dispatched but caused an exception in one of its handlers.
|
||||
* <p>
|
||||
* Handling exception events is useful as it allows the creation of a centralized exception handling
|
||||
* mechanism for unexpected exceptions.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public final class ExceptionEvent {
|
||||
|
||||
private final EventBus eventBus;
|
||||
private final Object event;
|
||||
private final Throwable cause;
|
||||
|
||||
ExceptionEvent(EventBus eventBus, Object event, Throwable cause) {
|
||||
this.eventBus = eventBus;
|
||||
this.event = event;
|
||||
this.cause = cause;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return String.format("ExceptionEvent[eventBus=%s, event=%s, cause=%s]", eventBus, event,
|
||||
cause);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return the event bus that dispatched this event
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public EventBus getEventBus() { return eventBus; }
|
||||
|
||||
/**
|
||||
* @return the event that could not be handled because of an exception
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public Object getEvent() { return event; }
|
||||
|
||||
/**
|
||||
* @return the exception that was thrown while handling the event
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public Throwable getCause() { return cause; }
|
||||
}
|
||||
@ -0,0 +1,24 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* This unchecked exception acts as a wrapper for an arbitrary exception to prevent an
|
||||
* {@link ExceptionEvent} from being dispatched. Instead, the wrapped exception is rethrown by
|
||||
* {@link EventBus#dispatch(Object)}.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.2.1
|
||||
*/
|
||||
public final class ExceptionWrapper extends RuntimeException {
|
||||
|
||||
private static final long serialVersionUID = -2016681140617308788L;
|
||||
|
||||
/**
|
||||
* Creates a new exception wrapper.
|
||||
*
|
||||
* @param cause the exception to wrap
|
||||
* @since 1.2.1
|
||||
*/
|
||||
public ExceptionWrapper(Exception cause) {
|
||||
super(cause);
|
||||
}
|
||||
}
|
||||
@ -1,6 +1,6 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static java.lang.annotation.ElementType.METHOD;
|
||||
import static java.lang.annotation.ElementType.*;
|
||||
import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
||||
|
||||
import java.lang.annotation.*;
|
||||
@ -8,6 +8,9 @@ import java.lang.annotation.*;
|
||||
/**
|
||||
* Allows an event handler to receive events that are subtypes of the declared event type.
|
||||
* <p>
|
||||
* When used on a type, the value applies to all event handlers declared within that type that don't
|
||||
* define a value on their own.
|
||||
* <p>
|
||||
* This is useful when defining an event handler for an interface or an abstract class.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
@ -15,6 +18,14 @@ import java.lang.annotation.*;
|
||||
* @see Event
|
||||
*/
|
||||
@Documented
|
||||
@Inherited
|
||||
@Retention(RUNTIME)
|
||||
@Target(METHOD)
|
||||
public @interface Polymorphic {}
|
||||
@Target({ METHOD, TYPE })
|
||||
public @interface Polymorphic {
|
||||
|
||||
/**
|
||||
* @return whether the event handler is polymorphic
|
||||
* @since 1.1.0
|
||||
*/
|
||||
boolean value() default true;
|
||||
}
|
||||
@ -1,6 +1,6 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static java.lang.annotation.ElementType.METHOD;
|
||||
import static java.lang.annotation.ElementType.*;
|
||||
import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
||||
|
||||
import java.lang.annotation.*;
|
||||
@ -9,6 +9,9 @@ import java.lang.annotation.*;
|
||||
* Defines the priority of an event handler. Handlers are executed in descending order of their
|
||||
* priority.
|
||||
* <p>
|
||||
* When used on a type, the value applies to all event handlers declared within that type that don't
|
||||
* define a value on their own.
|
||||
* <p>
|
||||
* Handlers without this annotation have the default priority of 100.
|
||||
* <p>
|
||||
* The execution order of handlers with the same priority is undefined.
|
||||
@ -18,8 +21,9 @@ import java.lang.annotation.*;
|
||||
* @see Event
|
||||
*/
|
||||
@Documented
|
||||
@Inherited
|
||||
@Retention(RUNTIME)
|
||||
@Target(METHOD)
|
||||
@Target({ METHOD, TYPE })
|
||||
public @interface Priority {
|
||||
|
||||
/**
|
||||
@ -0,0 +1,73 @@
|
||||
package dev.kske.eventbus.core.handler;
|
||||
|
||||
import java.lang.reflect.InvocationTargetException;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
/**
|
||||
* An event handler wrapping a callback method.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public final class CallbackEventHandler implements EventHandler {
|
||||
|
||||
private final Class<?> eventType;
|
||||
private final Consumer<Object> callback;
|
||||
private final boolean polymorphic;
|
||||
private final int priority;
|
||||
|
||||
/**
|
||||
* Constructs a callback event handler.
|
||||
*
|
||||
* @param <E> the event type of the handler
|
||||
* @param eventType the event type of the handler
|
||||
* @param callback the callback method to execute when the handler is invoked
|
||||
* @param polymorphic whether the handler is polymorphic
|
||||
* @param priority the priority of the handler
|
||||
* @since 1.2.0
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public <E> CallbackEventHandler(Class<E> eventType, Consumer<E> callback, boolean polymorphic,
|
||||
int priority) {
|
||||
this.eventType = eventType;
|
||||
this.callback = (Consumer<Object>) callback;
|
||||
this.polymorphic = polymorphic;
|
||||
this.priority = priority;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void execute(Object event) throws InvocationTargetException {
|
||||
try {
|
||||
callback.accept(event);
|
||||
} catch (RuntimeException e) {
|
||||
throw new InvocationTargetException(e, "Callback event handler failed!");
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return String.format(
|
||||
"CallbackEventHandler[eventType=%s, polymorphic=%b, priority=%d]",
|
||||
eventType, polymorphic, priority);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Consumer<?> getListener() {
|
||||
return callback;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<?> getEventType() {
|
||||
return eventType;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getPriority() {
|
||||
return priority;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isPolymorphic() {
|
||||
return polymorphic;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,53 @@
|
||||
package dev.kske.eventbus.core.handler;
|
||||
|
||||
import java.lang.reflect.InvocationTargetException;
|
||||
|
||||
import dev.kske.eventbus.core.*;
|
||||
|
||||
/**
|
||||
* Internal representation of an event handling method.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.2.0
|
||||
* @see EventBus
|
||||
*/
|
||||
public interface EventHandler {
|
||||
|
||||
/**
|
||||
* Executes the event handler.
|
||||
*
|
||||
* @param event the event used as the method parameter
|
||||
* @throws EventBusException if the event handler isn't accessible or has an invalid
|
||||
* signature
|
||||
* @throws InvocationTargetException if the handler throws an exception
|
||||
* @throws EventBusException if the handler has the wrong signature or is inaccessible
|
||||
* @since 1.2.0
|
||||
*/
|
||||
void execute(Object event) throws EventBusException, InvocationTargetException;
|
||||
|
||||
/**
|
||||
* @return the listener containing this handler
|
||||
* @since 1.2.0
|
||||
*/
|
||||
Object getListener();
|
||||
|
||||
/**
|
||||
* @return the event type this handler listens for
|
||||
* @since 1.2.0
|
||||
*/
|
||||
Class<?> getEventType();
|
||||
|
||||
/**
|
||||
* @return the priority of this handler
|
||||
* @since 1.2.0
|
||||
* @see Priority
|
||||
*/
|
||||
int getPriority();
|
||||
|
||||
/**
|
||||
* @return whether this handler also accepts subtypes of the event type
|
||||
* @since 1.2.0
|
||||
* @see Polymorphic
|
||||
*/
|
||||
boolean isPolymorphic();
|
||||
}
|
||||
@ -0,0 +1,105 @@
|
||||
package dev.kske.eventbus.core.handler;
|
||||
|
||||
import java.lang.reflect.*;
|
||||
|
||||
import dev.kske.eventbus.core.*;
|
||||
|
||||
/**
|
||||
* An event handler wrapping a method annotated with {@link Event} and executing it using
|
||||
* reflection.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public final class ReflectiveEventHandler implements EventHandler {
|
||||
|
||||
private final Object listener;
|
||||
private final Method method;
|
||||
private final Class<?> eventType;
|
||||
private final boolean useParameter;
|
||||
private final boolean polymorphic;
|
||||
private final int priority;
|
||||
|
||||
/**
|
||||
* Constructs a reflective event handler.
|
||||
*
|
||||
* @param listener the listener containing the handler
|
||||
* @param method the handler method
|
||||
* @param annotation the event annotation
|
||||
* @param defPolymorphism the predefined polymorphism (default or listener-level)
|
||||
* @param defPriority the predefined priority (default or listener-level)
|
||||
* @throws EventBusException if the method or the annotation do not comply with the
|
||||
* specification
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public ReflectiveEventHandler(Object listener, Method method, Event annotation,
|
||||
boolean defPolymorphism, int defPriority) throws EventBusException {
|
||||
this.listener = listener;
|
||||
this.method = method;
|
||||
useParameter = annotation.value() == void.class;
|
||||
|
||||
// Check handler signature
|
||||
if (method.getParameterCount() == 0 && useParameter)
|
||||
throw new EventBusException(method + " does not define an event type!");
|
||||
|
||||
if (method.getParameterCount() == 1 && !useParameter)
|
||||
throw new EventBusException(method + " defines an ambiguous event type!");
|
||||
|
||||
if (method.getParameterCount() > 1)
|
||||
throw new EventBusException(method + " defines more than one parameter!");
|
||||
|
||||
// Determine handler properties
|
||||
eventType = useParameter ? method.getParameterTypes()[0] : annotation.value();
|
||||
polymorphic = method.isAnnotationPresent(Polymorphic.class)
|
||||
? method.getAnnotation(Polymorphic.class).value()
|
||||
: defPolymorphism;
|
||||
priority = method.isAnnotationPresent(Priority.class)
|
||||
? method.getAnnotation(Priority.class).value()
|
||||
: defPriority;
|
||||
|
||||
// Try to allow access if the method is not accessible
|
||||
if (!method.canAccess(Modifier.isStatic(method.getModifiers()) ? null : listener))
|
||||
method.setAccessible(true);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void execute(Object event) throws EventBusException, InvocationTargetException {
|
||||
try {
|
||||
if (useParameter)
|
||||
method.invoke(getListener(), event);
|
||||
else
|
||||
method.invoke(getListener());
|
||||
} catch (IllegalArgumentException e) {
|
||||
throw new EventBusException("Event handler rejected target / argument!", e);
|
||||
} catch (IllegalAccessException e) {
|
||||
throw new EventBusException("Event handler is not accessible!", e);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return String.format(
|
||||
"ReflectiveEventHandler[eventType=%s, polymorphic=%b, priority=%d, method=%s, useParameter=%b]",
|
||||
eventType, polymorphic, priority, method, useParameter);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Object getListener() {
|
||||
return listener;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<?> getEventType() {
|
||||
return eventType;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getPriority() {
|
||||
return priority;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isPolymorphic() {
|
||||
return polymorphic;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* Contains the internal representation of event handling methods.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.2.0
|
||||
* @see dev.kske.eventbus.core.handler.EventHandler
|
||||
*/
|
||||
package dev.kske.eventbus.core.handler;
|
||||
49
core/src/test/java/dev/kske/eventbus/core/DeadTest.java
Normal file
49
core/src/test/java/dev/kske/eventbus/core/DeadTest.java
Normal file
@ -0,0 +1,49 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* Tests the dispatching of a dead event if an event could not be delivered.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.1.0
|
||||
*/
|
||||
class DeadTest {
|
||||
|
||||
EventBus bus = new EventBus();
|
||||
String event = "This event has no handler";
|
||||
boolean deadEventHandled;
|
||||
|
||||
/**
|
||||
* Tests dead event delivery.
|
||||
*
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Test
|
||||
void testDeadEvent() {
|
||||
bus.registerListener(this);
|
||||
bus.dispatch(event);
|
||||
assertTrue(deadEventHandled);
|
||||
bus.removeListener(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests how the event bus reacts to an unhandled dead event. This should not lead to an
|
||||
* exception or an endless recursion and should be logged instead.
|
||||
*
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Test
|
||||
void testUnhandledDeadEvent() {
|
||||
bus.dispatch(event);
|
||||
}
|
||||
|
||||
@Event
|
||||
void onDeadEvent(DeadEvent deadEvent) {
|
||||
assertEquals(bus, deadEvent.getEventBus());
|
||||
assertEquals(event, deadEvent.getEvent());
|
||||
deadEventHandled = true;
|
||||
}
|
||||
}
|
||||
88
core/src/test/java/dev/kske/eventbus/core/DispatchTest.java
Normal file
88
core/src/test/java/dev/kske/eventbus/core/DispatchTest.java
Normal file
@ -0,0 +1,88 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import org.junit.jupiter.api.*;
|
||||
|
||||
/**
|
||||
* Tests the dispatching mechanism of the event bus.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
*/
|
||||
@Polymorphic
|
||||
@Priority(150)
|
||||
class DispatchTest {
|
||||
|
||||
EventBus bus;
|
||||
|
||||
/**
|
||||
* Constructs an event bus and registers this test instance as an event listener.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
@BeforeEach
|
||||
void registerListener() {
|
||||
bus = new EventBus();
|
||||
bus.registerListener(this);
|
||||
bus.registerListener(SimpleEvent.class, e -> {
|
||||
e.increment();
|
||||
assertEquals(3, e.getCounter());
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests {@link EventBus#dispatch(Object)} with multiple handler priorities, a polymorphic
|
||||
* handler and a static handler.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
@Test
|
||||
void testDispatch() {
|
||||
bus.dispatch(new SimpleEventSub());
|
||||
bus.dispatch(new SimpleEvent());
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests {@link EventBus#debugExecutionOrder(Class)} based on the currently registered handlers.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
@Test
|
||||
void testDebugExecutionOrder() {
|
||||
assertEquals(
|
||||
"Event handler execution order for class dev.kske.eventbus.core.SimpleEvent (3 handler(s)):\n"
|
||||
+ "==========================================================================================\n"
|
||||
+ "ReflectiveEventHandler[eventType=class dev.kske.eventbus.core.SimpleEvent, polymorphic=true, priority=200, method=void dev.kske.eventbus.core.DispatchTest.onSimpleEventFirst(dev.kske.eventbus.core.SimpleEvent), useParameter=true]\n"
|
||||
+ "ReflectiveEventHandler[eventType=class dev.kske.eventbus.core.SimpleEvent, polymorphic=false, priority=150, method=static void dev.kske.eventbus.core.DispatchTest.onSimpleEventSecond(dev.kske.eventbus.core.SimpleEvent), useParameter=true]\n"
|
||||
+ "CallbackEventHandler[eventType=class dev.kske.eventbus.core.SimpleEvent, polymorphic=false, priority=100]\n"
|
||||
+ "==========================================================================================",
|
||||
bus.debugExecutionOrder(SimpleEvent.class));
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests whether the handlers bound to an event type are correct when retrieved from the binding
|
||||
* cache. On the second call of {@link EventBus#debugExecutionOrder(Class)} the cache is used.
|
||||
*
|
||||
* @since 1.3.0
|
||||
*/
|
||||
@Test
|
||||
void testBindingCache() {
|
||||
assertEquals(bus.debugExecutionOrder(SimpleEventSub.class),
|
||||
bus.debugExecutionOrder(SimpleEventSub.class));
|
||||
}
|
||||
|
||||
@Event
|
||||
@Priority(200)
|
||||
void onSimpleEventFirst(SimpleEvent event) {
|
||||
event.increment();
|
||||
assertTrue(event.getCounter() == 1 || event.getCounter() == 2);
|
||||
}
|
||||
|
||||
@Event
|
||||
@Polymorphic(false)
|
||||
static void onSimpleEventSecond(SimpleEvent event) {
|
||||
event.increment();
|
||||
assertEquals(2, event.getCounter());
|
||||
}
|
||||
}
|
||||
62
core/src/test/java/dev/kske/eventbus/core/ExceptionTest.java
Normal file
62
core/src/test/java/dev/kske/eventbus/core/ExceptionTest.java
Normal file
@ -0,0 +1,62 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* Tests the dispatching of an exception event if an event handler threw an exception.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.1.0
|
||||
*/
|
||||
class ExceptionTest {
|
||||
|
||||
EventBus bus = new EventBus();
|
||||
String event = "This event will cause an exception";
|
||||
RuntimeException exception = new RuntimeException("I failed");
|
||||
boolean exceptionEventHandled;
|
||||
|
||||
/**
|
||||
* Tests exception event delivery.
|
||||
*
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Test
|
||||
void testExceptionEvent() {
|
||||
bus.registerListener(this);
|
||||
bus.registerListener(new ExceptionListener());
|
||||
bus.dispatch(event);
|
||||
assertTrue(exceptionEventHandled);
|
||||
bus.clearListeners();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests how the event bus reacts to an unhandled exception event. This should not lead to an
|
||||
* exception or an endless recursion and should be logged instead.
|
||||
*
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Test
|
||||
void testUnhandledExceptionEvent() {
|
||||
bus.registerListener(this);
|
||||
bus.dispatch(event);
|
||||
bus.removeListener(this);
|
||||
}
|
||||
|
||||
@Event(String.class)
|
||||
void onString() {
|
||||
throw exception;
|
||||
}
|
||||
|
||||
class ExceptionListener {
|
||||
|
||||
@Event
|
||||
void onExceptionEvent(ExceptionEvent exceptionEvent) {
|
||||
assertEquals(bus, exceptionEvent.getEventBus());
|
||||
assertEquals(event, exceptionEvent.getEvent());
|
||||
assertEquals(exception, exceptionEvent.getCause());
|
||||
exceptionEventHandled = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,33 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* Tests the behavior of the event bus when an {@link ExceptionWrapper} is thrown.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.2.1
|
||||
*/
|
||||
class ExceptionWrapperTest {
|
||||
|
||||
EventBus bus = new EventBus();
|
||||
String event = "This event will cause an exception";
|
||||
|
||||
/**
|
||||
* Tests transparent rethrowing of an exception wrapper by {@link EventBus#dispatch(Object)}.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*/
|
||||
@Test
|
||||
void testExceptionWrapper() {
|
||||
bus.registerListener(this);
|
||||
assertThrows(ExceptionWrapper.class, () -> bus.dispatch(event));
|
||||
}
|
||||
|
||||
@Event(String.class)
|
||||
void onString() {
|
||||
throw new ExceptionWrapper(new RuntimeException("I failed!"));
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,43 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertSame;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* Tests whether event handlers correctly work in the context of an inheritance hierarchy. The
|
||||
* effect of handler priorities is also accounted for.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.3.0
|
||||
*/
|
||||
class InheritanceTest extends SimpleEventListenerBase implements SimpleEventListenerInterface {
|
||||
|
||||
EventBus bus = new EventBus();
|
||||
|
||||
@Test
|
||||
void test() {
|
||||
bus.registerListener(this);
|
||||
var event = new SimpleEvent();
|
||||
|
||||
bus.dispatch(event);
|
||||
assertSame(3, event.getCounter());
|
||||
}
|
||||
|
||||
@Override
|
||||
void onSimpleEventAbstractHandler(SimpleEvent event) {
|
||||
assertSame(1, event.getCounter());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void onSimpleEventInterfaceHandler(SimpleEvent event) {
|
||||
event.increment();
|
||||
}
|
||||
|
||||
@Event
|
||||
@Priority(250)
|
||||
private void onSimpleEventPrivate(SimpleEvent event) {
|
||||
assertSame(0, event.getCounter());
|
||||
event.increment();
|
||||
}
|
||||
}
|
||||
73
core/src/test/java/dev/kske/eventbus/core/NestedTest.java
Normal file
73
core/src/test/java/dev/kske/eventbus/core/NestedTest.java
Normal file
@ -0,0 +1,73 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import org.junit.jupiter.api.*;
|
||||
|
||||
/**
|
||||
* Tests nested event dispatches.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.2.0
|
||||
*/
|
||||
class NestedTest {
|
||||
|
||||
EventBus bus;
|
||||
boolean nestedHit;
|
||||
|
||||
/**
|
||||
* Constructs an event bus and registers this test instance as an event listener.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
@BeforeEach
|
||||
void registerListener() {
|
||||
bus = new EventBus();
|
||||
bus.registerListener(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatches a simple event, which should in turn cause a string to be dispatched as a nested
|
||||
* event. If the corresponding handler sets {@link #nestedHit} to {@code true}, the test is
|
||||
* successful.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
@Test
|
||||
void testNestedDispatch() {
|
||||
bus.dispatch(new SimpleEvent());
|
||||
assertTrue(nestedHit);
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatches a string as a nested event and cancels the current dispatch afterwards.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
@Event(SimpleEvent.class)
|
||||
void onSimpleEvent() {
|
||||
bus.dispatch("Nested event");
|
||||
bus.cancel();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets {@link #nestedHit} to {@code true} indicating that nested dispatches work.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
@Event(String.class)
|
||||
void onString() {
|
||||
nestedHit = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fails the test if an exception is caused during the dispatch.
|
||||
*
|
||||
* @param e the event containing the exception
|
||||
* @since 1.2.0
|
||||
*/
|
||||
@Event
|
||||
void onException(ExceptionEvent e) {
|
||||
fail("Exception during dispatch", e.getCause());
|
||||
}
|
||||
}
|
||||
31
core/src/test/java/dev/kske/eventbus/core/SimpleEvent.java
Normal file
31
core/src/test/java/dev/kske/eventbus/core/SimpleEvent.java
Normal file
@ -0,0 +1,31 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* A simple event for testing purposes. The event contains a counter that is supposed to be
|
||||
* incremented when the event is processed by a handler. That way it is possible to test whether all
|
||||
* handlers that were supposed to be invoked were in fact invoked.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
*/
|
||||
class SimpleEvent {
|
||||
|
||||
private int counter;
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return String.format("%s[%d]", getClass().getSimpleName(), counter);
|
||||
}
|
||||
|
||||
void increment() {
|
||||
++counter;
|
||||
}
|
||||
|
||||
int getCounter() {
|
||||
return counter;
|
||||
}
|
||||
|
||||
void reset() {
|
||||
counter = 0;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,25 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
/**
|
||||
* An abstract class defining a package-private and a private handler for {@link SimpleEvent}.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.3.0
|
||||
*/
|
||||
@Priority(200)
|
||||
abstract class SimpleEventListenerBase {
|
||||
|
||||
@Event
|
||||
void onSimpleEventAbstractHandler(SimpleEvent event) {
|
||||
fail("This handler should not be invoked");
|
||||
}
|
||||
|
||||
@Event
|
||||
@Priority(150)
|
||||
private void onSimpleEventPrivate(SimpleEvent event) {
|
||||
assertSame(1, event.getCounter());
|
||||
event.increment();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* An interface defining a single handler for {@link SimpleEvent}.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.3.0
|
||||
*/
|
||||
interface SimpleEventListenerInterface {
|
||||
|
||||
@Priority(120)
|
||||
@Event
|
||||
void onSimpleEventInterfaceHandler(SimpleEvent event);
|
||||
}
|
||||
@ -6,4 +6,4 @@ package dev.kske.eventbus.core;
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.4
|
||||
*/
|
||||
public class SimpleEventSub extends SimpleEvent {}
|
||||
class SimpleEventSub extends SimpleEvent {}
|
||||
@ -1,30 +0,0 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<artifactId>event-bus-core</artifactId>
|
||||
<name>Event Bus Core</name>
|
||||
|
||||
<parent>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus</artifactId>
|
||||
<version>1.0.0</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter-api</artifactId>
|
||||
<version>5.6.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
|
||||
<!-- Disable resource folder -->
|
||||
<resources />
|
||||
|
||||
</build>
|
||||
</project>
|
||||
@ -1,210 +0,0 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import java.lang.System.Logger;
|
||||
import java.lang.System.Logger.Level;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
/**
|
||||
* Event listeners can be registered at an event bus to be notified when an event is dispatched.
|
||||
* <p>
|
||||
* A singleton instance of this class can be lazily created and acquired using the
|
||||
* {@link EventBus#getInstance()} method.
|
||||
* <p>
|
||||
* This is a thread-safe implementation.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
* @see Event
|
||||
*/
|
||||
public final class EventBus {
|
||||
|
||||
/**
|
||||
* Holds the state of the dispatching process on one thread.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
private static final class DispatchState {
|
||||
|
||||
boolean isDispatching, isCancelled;
|
||||
}
|
||||
|
||||
private static volatile EventBus singletonInstance;
|
||||
|
||||
private static final Logger logger = System.getLogger(EventBus.class.getName());
|
||||
|
||||
/**
|
||||
* Produces a singleton instance of the event bus. It is lazily initialized on the first call.
|
||||
*
|
||||
* @return a singleton instance of the event bus.
|
||||
* @since 0.0.2
|
||||
*/
|
||||
public static EventBus getInstance() {
|
||||
EventBus instance = singletonInstance;
|
||||
if (instance == null)
|
||||
synchronized (EventBus.class) {
|
||||
if ((instance = singletonInstance) == null) {
|
||||
logger.log(Level.DEBUG, "Initializing singleton event bus instance");
|
||||
instance = singletonInstance = new EventBus();
|
||||
}
|
||||
}
|
||||
return instance;
|
||||
}
|
||||
|
||||
private final Map<Class<?>, TreeSet<EventHandler>> bindings =
|
||||
new ConcurrentHashMap<>();
|
||||
private final Set<Object> registeredListeners =
|
||||
ConcurrentHashMap.newKeySet();
|
||||
private final ThreadLocal<DispatchState> dispatchState =
|
||||
ThreadLocal.withInitial(DispatchState::new);
|
||||
|
||||
/**
|
||||
* Dispatches an event to all event handlers registered for it in descending order of their
|
||||
* priority.
|
||||
*
|
||||
* @param event the event to dispatch
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public void dispatch(Object event) {
|
||||
Objects.requireNonNull(event);
|
||||
logger.log(Level.INFO, "Dispatching event {0}", event);
|
||||
|
||||
// Set dispatch state
|
||||
var state = dispatchState.get();
|
||||
state.isDispatching = true;
|
||||
|
||||
for (var handler : getHandlersFor(event.getClass()))
|
||||
if (state.isCancelled) {
|
||||
logger.log(Level.INFO, "Cancelled dispatching event {0}", event);
|
||||
state.isCancelled = false;
|
||||
break;
|
||||
} else {
|
||||
handler.execute(event);
|
||||
}
|
||||
|
||||
// Reset dispatch state
|
||||
state.isDispatching = false;
|
||||
|
||||
logger.log(Level.DEBUG, "Finished dispatching event {0}", event);
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches for the event handlers bound to an event class.
|
||||
*
|
||||
* @param eventClass the event class to use for the search
|
||||
* @return all event handlers registered for the event class
|
||||
* @since 0.0.1
|
||||
*/
|
||||
private List<EventHandler> getHandlersFor(Class<?> eventClass) {
|
||||
|
||||
// Get handlers defined for the event class
|
||||
Set<EventHandler> handlers = bindings.getOrDefault(eventClass, new TreeSet<>());
|
||||
|
||||
// Get subtype handlers
|
||||
for (var binding : bindings.entrySet())
|
||||
if (binding.getKey().isAssignableFrom(eventClass))
|
||||
for (var handler : binding.getValue())
|
||||
if (handler.isPolymorphic())
|
||||
handlers.add(handler);
|
||||
|
||||
return new ArrayList<>(handlers);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancels an event that is currently dispatched from inside an event handler.
|
||||
*
|
||||
* @throws EventBusException if the calling thread is not an active dispatching thread
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public void cancel() {
|
||||
var state = dispatchState.get();
|
||||
if (state.isDispatching && !state.isCancelled)
|
||||
state.isCancelled = true;
|
||||
else
|
||||
throw new EventBusException("Calling thread not an active dispatching thread!");
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers an event listener at this event bus.
|
||||
*
|
||||
* @param listener the listener to register
|
||||
* @throws EventBusException if the listener is already registered or a declared event handler
|
||||
* does not comply with the specification
|
||||
* @since 0.0.1
|
||||
* @see Event
|
||||
*/
|
||||
public void registerListener(Object listener) throws EventBusException {
|
||||
Objects.requireNonNull(listener);
|
||||
if (registeredListeners.contains(listener))
|
||||
throw new EventBusException(listener + " already registered!");
|
||||
logger.log(Level.INFO, "Registering event listener {0}", listener.getClass().getName());
|
||||
boolean handlerBound = false;
|
||||
|
||||
registeredListeners.add(listener);
|
||||
for (var method : listener.getClass().getDeclaredMethods()) {
|
||||
Event annotation = method.getAnnotation(Event.class);
|
||||
|
||||
// Skip methods without annotations
|
||||
if (annotation == null)
|
||||
continue;
|
||||
|
||||
// Initialize and bind the handler
|
||||
var handler = new EventHandler(listener, method, annotation);
|
||||
bindings.putIfAbsent(handler.getEventType(), new TreeSet<>());
|
||||
logger.log(Level.DEBUG, "Binding event handler {0}", handler);
|
||||
bindings.get(handler.getEventType())
|
||||
.add(handler);
|
||||
handlerBound = true;
|
||||
}
|
||||
|
||||
if (!handlerBound)
|
||||
logger.log(
|
||||
Level.WARNING,
|
||||
"No event handlers bound for event listener {0}",
|
||||
listener.getClass().getName());
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a specific listener from this event bus.
|
||||
*
|
||||
* @param listener the listener to remove
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public void removeListener(Object listener) {
|
||||
Objects.requireNonNull(listener);
|
||||
logger.log(Level.INFO, "Removing event listener {0}", listener.getClass().getName());
|
||||
|
||||
for (var binding : bindings.values()) {
|
||||
var it = binding.iterator();
|
||||
while (it.hasNext()) {
|
||||
var handler = it.next();
|
||||
if (handler.getListener() == listener) {
|
||||
logger.log(Level.DEBUG, "Unbinding event handler {0}", handler);
|
||||
it.remove();
|
||||
}
|
||||
}
|
||||
}
|
||||
registeredListeners.remove(listener);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all event listeners from this event bus.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public void clearListeners() {
|
||||
logger.log(Level.INFO, "Clearing event listeners");
|
||||
bindings.clear();
|
||||
registeredListeners.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides an unmodifiable view of the event listeners registered at this event bus.
|
||||
*
|
||||
* @return all registered event listeners
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public Set<Object> getRegisteredListeners() {
|
||||
return Collections.unmodifiableSet(registeredListeners);
|
||||
}
|
||||
}
|
||||
@ -1,33 +0,0 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* This runtime exception is thrown when an event bus error occurs. This can
|
||||
* either occur while registering event listeners with invalid handlers, or when
|
||||
* an event handler throws an exception.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public class EventBusException extends RuntimeException {
|
||||
|
||||
private static final long serialVersionUID = 1L;
|
||||
|
||||
/**
|
||||
* Creates a new event bus exception.
|
||||
*
|
||||
* @param message the message to display
|
||||
* @param cause the cause of this exception
|
||||
*/
|
||||
public EventBusException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new event bus exception.
|
||||
*
|
||||
* @param message the message to display
|
||||
*/
|
||||
public EventBusException(String message) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
@ -1,133 +0,0 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import java.lang.reflect.*;
|
||||
|
||||
import dev.kske.eventbus.core.Event.USE_PARAMETER;
|
||||
|
||||
/**
|
||||
* Internal representation of an event handling method.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
* @see EventBus
|
||||
*/
|
||||
final class EventHandler implements Comparable<EventHandler> {
|
||||
|
||||
/**
|
||||
* The priority assigned to every event handler without an explicitly defined priority.
|
||||
*
|
||||
* @since 1.0.0
|
||||
* @see Priority
|
||||
*/
|
||||
public static final int DEFAULT_PRIORITY = 100;
|
||||
|
||||
private final Object listener;
|
||||
private final Method method;
|
||||
private final Class<?> eventType;
|
||||
private final boolean useParameter;
|
||||
private final boolean polymorphic;
|
||||
private final int priority;
|
||||
|
||||
/**
|
||||
* Constructs an event handler.
|
||||
*
|
||||
* @param listener the listener containing the handler
|
||||
* @param method the handler method
|
||||
* @param annotation the event annotation
|
||||
* @throws EventBusException if the method or the annotation do not comply with the
|
||||
* specification
|
||||
* @since 0.0.1
|
||||
*/
|
||||
EventHandler(Object listener, Method method, Event annotation) throws EventBusException {
|
||||
this.listener = listener;
|
||||
this.method = method;
|
||||
useParameter = annotation.value() == USE_PARAMETER.class;
|
||||
|
||||
// Check handler signature
|
||||
if (method.getParameterCount() == 0 && useParameter)
|
||||
throw new EventBusException(method + " does not define an event type!");
|
||||
|
||||
if (method.getParameterCount() == 1 && !useParameter)
|
||||
throw new EventBusException(method + " defines an ambiguous event type!");
|
||||
|
||||
if (method.getParameterCount() > 1)
|
||||
throw new EventBusException(method + " defines more than one parameter!");
|
||||
|
||||
// Determine handler properties
|
||||
eventType = useParameter ? method.getParameterTypes()[0] : annotation.value();
|
||||
polymorphic = method.isAnnotationPresent(Polymorphic.class);
|
||||
priority = method.isAnnotationPresent(Priority.class)
|
||||
? method.getAnnotation(Priority.class).value()
|
||||
: DEFAULT_PRIORITY;
|
||||
|
||||
// Allow access if the method is non-public
|
||||
method.setAccessible(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compares this to another event handler based on priority. In case of equal priority a
|
||||
* non-zero value based on hash codes is returned.
|
||||
* <p>
|
||||
* This is used to retrieve event handlers in order of descending priority from a tree set.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
@Override
|
||||
public int compareTo(EventHandler other) {
|
||||
int priority = other.priority - this.priority;
|
||||
if (priority == 0)
|
||||
priority = listener.hashCode() - other.listener.hashCode();
|
||||
return priority == 0 ? hashCode() - other.hashCode() : priority;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return String.format(
|
||||
"EventHandler[method=%s, eventType=%s, useParameter=%b, polymorphic=%b, priority=%d]",
|
||||
method, eventType, useParameter, polymorphic, priority);
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the event handler.
|
||||
*
|
||||
* @param event the event used as the method parameter
|
||||
* @throws EventBusException if the handler throws an exception
|
||||
* @since 0.0.1
|
||||
*/
|
||||
void execute(Object event) throws EventBusException {
|
||||
try {
|
||||
if (useParameter)
|
||||
method.invoke(listener, event);
|
||||
else
|
||||
method.invoke(listener);
|
||||
} catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
|
||||
throw new EventBusException("Failed to invoke event handler!", e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return the listener containing this handler
|
||||
* @since 0.0.1
|
||||
*/
|
||||
Object getListener() { return listener; }
|
||||
|
||||
/**
|
||||
* @return the event type this handler listens for
|
||||
* @since 0.0.3
|
||||
*/
|
||||
Class<?> getEventType() { return eventType; }
|
||||
|
||||
/**
|
||||
* @return the priority of this handler
|
||||
* @since 0.0.1
|
||||
* @see Priority
|
||||
*/
|
||||
int getPriority() { return priority; }
|
||||
|
||||
/**
|
||||
* @return whether this handler is polymorphic
|
||||
* @since 1.0.0
|
||||
* @see Polymorphic
|
||||
*/
|
||||
boolean isPolymorphic() { return polymorphic; }
|
||||
}
|
||||
@ -1,61 +0,0 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import org.junit.jupiter.api.*;
|
||||
|
||||
/**
|
||||
* Tests the dispatching mechanism of the event bus.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
*/
|
||||
class DispatchTest {
|
||||
|
||||
EventBus bus;
|
||||
static int hits;
|
||||
|
||||
/**
|
||||
* Constructs an event bus and registers this test instance as an event listener.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
@BeforeEach
|
||||
void registerListener() {
|
||||
bus = new EventBus();
|
||||
bus.registerListener(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests {@link EventBus#dispatch(Object)} with multiple handler priorities, a subtype handler
|
||||
* and a static handler.
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
@Test
|
||||
void testDispatch() {
|
||||
bus.dispatch(new SimpleEventSub());
|
||||
bus.dispatch(new SimpleEvent());
|
||||
}
|
||||
|
||||
@Event(SimpleEvent.class)
|
||||
@Priority(200)
|
||||
@Polymorphic
|
||||
void onSimpleEventFirst() {
|
||||
++hits;
|
||||
assertTrue(hits == 1 || hits == 2);
|
||||
}
|
||||
|
||||
@Event(SimpleEvent.class)
|
||||
@Priority(150)
|
||||
static void onSimpleEventSecond() {
|
||||
++hits;
|
||||
assertEquals(3, hits);
|
||||
}
|
||||
|
||||
@Event
|
||||
void onSimpleEventThird(SimpleEvent event) {
|
||||
++hits;
|
||||
assertEquals(4, hits);
|
||||
}
|
||||
}
|
||||
@ -1,9 +0,0 @@
|
||||
package dev.kske.eventbus.core;
|
||||
|
||||
/**
|
||||
* A simple event for testing purposes.
|
||||
*
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 0.0.1
|
||||
*/
|
||||
public class SimpleEvent {}
|
||||
49
pom.xml
49
pom.xml
@ -5,22 +5,24 @@
|
||||
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus</artifactId>
|
||||
<version>1.0.0</version>
|
||||
<version>1.2.0</version>
|
||||
<packaging>pom</packaging>
|
||||
|
||||
<name>Event Bus</name>
|
||||
<description>An event handling framework for Java utilizing annotations.</description>
|
||||
<description>An event handling library for Java utilizing annotations.</description>
|
||||
<url>https://git.kske.dev/kske/event-bus</url>
|
||||
|
||||
<modules>
|
||||
<module>event-bus-core</module>
|
||||
<module>event-bus-proc</module>
|
||||
<module>core</module>
|
||||
<module>proc</module>
|
||||
</modules>
|
||||
|
||||
<licenses>
|
||||
<license>
|
||||
<name>GNU General Public License Version 3</name>
|
||||
<url>http://www.gnu.org/licenses/gpl.txt</url>
|
||||
<name>Apache License, Version 2.0</name>
|
||||
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
|
||||
<distribution>repo</distribution>
|
||||
<comments>A business-friendly OSS license</comments>
|
||||
</license>
|
||||
</licenses>
|
||||
|
||||
@ -38,6 +40,19 @@
|
||||
</developer>
|
||||
</developers>
|
||||
|
||||
<contributors>
|
||||
<contributor>
|
||||
<name>Leon Hofmeister</name>
|
||||
<email>leon@kske.dev</email>
|
||||
<url>https://git.kske.dev/delvh</url>
|
||||
<roles>
|
||||
<role>qa</role>
|
||||
<role>tester</role>
|
||||
</roles>
|
||||
<timezone>Europe/Berlin</timezone>
|
||||
</contributor>
|
||||
</contributors>
|
||||
|
||||
<scm>
|
||||
<connection>scm:git:https://git.kske.dev/kske/event-bus.git</connection>
|
||||
<developerConnection>scm:git:ssh://git@git.kske.dev:420/kske/event-bus.git</developerConnection>
|
||||
@ -105,6 +120,28 @@
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
|
||||
<!-- Support JDK-style Javadoc tags -->
|
||||
<configuration>
|
||||
<tags>
|
||||
<tag>
|
||||
<name>apiNote</name>
|
||||
<placement>a</placement>
|
||||
<head>API Note:</head>
|
||||
</tag>
|
||||
<tag>
|
||||
<name>implSpec</name>
|
||||
<placement>a</placement>
|
||||
<head>Implementation Requirements:</head>
|
||||
</tag>
|
||||
<tag>
|
||||
<name>implNote</name>
|
||||
<placement>a</placement>
|
||||
<head>Implementation Note:</head>
|
||||
</tag>
|
||||
</tags>
|
||||
</configuration>
|
||||
|
||||
</plugin>
|
||||
|
||||
<!-- GPG sign JAR -->
|
||||
|
||||
@ -16,17 +16,17 @@
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="src" output="target/test-classes" path="home/kske/git/event-bus/event-bus-ap">
|
||||
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
|
||||
<attributes>
|
||||
<attribute name="optional" value="true"/>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
<attribute name="test" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="output" path="target/classes"/>
|
||||
</classpath>
|
||||
@ -11,7 +11,7 @@
|
||||
<parent>
|
||||
<groupId>dev.kske</groupId>
|
||||
<artifactId>event-bus</artifactId>
|
||||
<version>1.0.0</version>
|
||||
<version>1.2.0</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
@ -24,9 +24,6 @@
|
||||
|
||||
<build>
|
||||
|
||||
<!-- Disable test folder -->
|
||||
<testSourceDirectory />
|
||||
|
||||
<plugins>
|
||||
|
||||
<!-- Prevent annotation processing error during compilation -->
|
||||
@ -47,13 +47,12 @@ public class EventProcessor extends AbstractProcessor {
|
||||
|
||||
// Task failed successfully
|
||||
eventType = e.getTypeMirror();
|
||||
useParameter = processingEnv.getTypeUtils().isSameType(eventType,
|
||||
getTypeMirror(Event.USE_PARAMETER.class));
|
||||
useParameter = eventType.getKind() == TypeKind.VOID;
|
||||
}
|
||||
|
||||
// Check handler signature
|
||||
boolean pass = false;
|
||||
if (useParameter && eventHandler.getParameters().size() == 0)
|
||||
if (useParameter && eventHandler.getParameters().isEmpty())
|
||||
error(eventHandler, "The method or the annotation must define the event type");
|
||||
else if (!useParameter && eventHandler.getParameters().size() == 1)
|
||||
error(eventHandler,
|
||||
@ -63,6 +62,10 @@ public class EventProcessor extends AbstractProcessor {
|
||||
else
|
||||
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
|
||||
if (!pass)
|
||||
continue;
|
||||
@ -80,23 +83,58 @@ public class EventProcessor extends AbstractProcessor {
|
||||
}
|
||||
}
|
||||
|
||||
// Check for handlers for abstract types that aren't polymorphic
|
||||
// Get the listener containing this handler
|
||||
TypeElement listener = (TypeElement) eventHandler.getEnclosingElement();
|
||||
|
||||
// Default properties
|
||||
boolean defPolymorphic = false;
|
||||
int defPriority = 100;
|
||||
|
||||
// Listener-level polymorphism
|
||||
Polymorphic listenerPolymorphic = listener.getAnnotation(Polymorphic.class);
|
||||
boolean hasListenerPolymorphic = listenerPolymorphic != null;
|
||||
|
||||
// Listener-level priority
|
||||
Priority listenerPriority = listener.getAnnotation(Priority.class);
|
||||
boolean hasListenerPriority = listenerPriority != null;
|
||||
|
||||
// Effective polymorphism
|
||||
boolean polymorphic =
|
||||
hasListenerPolymorphic ? listenerPolymorphic.value() : defPolymorphic;
|
||||
boolean hasHandlerPolymorphic = eventHandler.getAnnotation(Polymorphic.class) != null;
|
||||
if (hasHandlerPolymorphic)
|
||||
polymorphic = eventHandler.getAnnotation(Polymorphic.class).value();
|
||||
|
||||
// Effective priority
|
||||
int priority =
|
||||
hasListenerPriority ? listenerPriority.value() : defPriority;
|
||||
boolean hasHandlerPriority = eventHandler.getAnnotation(Priority.class) != null;
|
||||
if (hasHandlerPriority)
|
||||
priority = eventHandler.getAnnotation(Priority.class).value();
|
||||
|
||||
// Detect useless polymorphism redefinition
|
||||
if (hasListenerPolymorphic && hasHandlerPolymorphic
|
||||
&& listenerPolymorphic.value() == polymorphic)
|
||||
warning(eventHandler, "@Polymorphism is already defined at listener level");
|
||||
|
||||
// Detect useless priority redefinition
|
||||
if (hasListenerPriority && hasHandlerPriority && listenerPriority.value() == priority)
|
||||
warning(eventHandler, "@Priority is already defined at the listener level");
|
||||
|
||||
// Detect missing or useless @Polymorphic
|
||||
Element eventElement = ((DeclaredType) eventType).asElement();
|
||||
if (eventHandler.getAnnotation(Polymorphic.class) == null
|
||||
&& (eventElement.getKind() == ElementKind.INTERFACE
|
||||
|| eventElement.getModifiers().contains(Modifier.ABSTRACT))) {
|
||||
|
||||
// Check for handlers for abstract types that aren't polymorphic
|
||||
if (!polymorphic && (eventElement.getKind() == ElementKind.INTERFACE
|
||||
|| eventElement.getModifiers().contains(Modifier.ABSTRACT)))
|
||||
warning(eventHandler,
|
||||
"Parameter should be instantiable or handler should use @Polymorphic");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private TypeMirror getTypeMirror(Class<?> clazz) {
|
||||
return getTypeElement(clazz).asType();
|
||||
// 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");
|
||||
}
|
||||
|
||||
private TypeElement getTypeElement(Class<?> clazz) {
|
||||
return processingEnv.getElementUtils().getTypeElement(clazz.getCanonicalName());
|
||||
}
|
||||
|
||||
private void warning(Element e, String msg, Object... args) {
|
||||
@ -5,7 +5,7 @@
|
||||
* @author Kai S. K. Engelbart
|
||||
* @since 1.0.0
|
||||
*/
|
||||
module dev.kske.eventbus.ap {
|
||||
module dev.kske.eventbus.proc {
|
||||
|
||||
requires java.compiler;
|
||||
requires dev.kske.eventbus.core;
|
||||
Loading…
Reference in New Issue
Block a user