Fix javadoc errors and warnings with Java 8
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Activator.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Activator.java
index 53fdfaa..c9be4c1 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Activator.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Activator.java
@@ -24,7 +24,7 @@
/**
* The activator of the EventAdmin bundle. This class registers an implementation of
- * the OSGi R4 <tt>EventAdmin</tt> service (see the Compendium 113) with the
+ * the OSGi R4 {@code EventAdmin} service (see the Compendium 113) with the
* framework. It features timeout-based denying of event-handlers for both,
* asynchronous and synchronous event-dispatching (as a spec conform optional
* extension).
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java
index e0faaf9..25b21fc 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java
@@ -50,38 +50,38 @@
* The service knows about the following properties which are read at bundle startup:
* <p>
* <p>
- * <tt>org.apache.felix.eventadmin.ThreadPoolSize</tt> - The size of the thread
+ * {@code org.apache.felix.eventadmin.ThreadPoolSize} - The size of the thread
* pool.
* </p>
* The default value is 10. Increase in case of a large amount of synchronous events
- * where the <tt>EventHandler</tt> services in turn send new synchronous events in
+ * where the {@code EventHandler} services in turn send new synchronous events in
* the event dispatching thread or a lot of timeouts are to be expected. A value of
* less then 2 triggers the default value. A value of 2 effectively disables thread
* pooling.
* </p>
* <p>
* <p>
- * <tt>org.apache.felix.eventadmin.Timeout</tt> - The deny-listing timeout in
+ * {@code org.apache.felix.eventadmin.Timeout} - The deny-listing timeout in
* milliseconds
* </p>
* The default value is 5000. Increase or decrease at own discretion. A value of less
* then 100 turns timeouts off. Any other value is the time in milliseconds granted
- * to each <tt>EventHandler</tt> before it gets put on the denylist.
+ * to each {@code EventHandler} before it gets put on the denylist.
* </p>
* <p>
* <p>
- * <tt>org.apache.felix.eventadmin.RequireTopic</tt> - Are <tt>EventHandler</tt>
+ * {@code org.apache.felix.eventadmin.RequireTopic} - Are {@code EventHandler}
* required to be registered with a topic?
* </p>
- * The default is <tt>true</tt>. The specification says that <tt>EventHandler</tt>
+ * The default is {@code true}. The specification says that {@code EventHandler}
* must register with a list of topics they are interested in. Setting this value to
- * <tt>false</tt> will enable that handlers without a topic are receiving all events
+ * {@code false} will enable that handlers without a topic are receiving all events
* (i.e., they are treated the same as with a topic=*).
* </p>
* <p>
* <p>
- * <tt>org.apache.felix.eventadmin.IgnoreTimeout</tt> - Configure
- * <tt>EventHandler</tt>s to be called without a timeout.
+ * {@code org.apache.felix.eventadmin.IgnoreTimeout} - Configure
+ * {@code EventHandler}s to be called without a timeout.
* </p>
* <p>
* If a timeout is configured by default all event handlers are called using the timeout.
@@ -99,7 +99,7 @@
* </p>
* <p>
* <p>
- * <tt>org.apache.felix.eventadmin.IgnoreTopic</tt> - Configure
+ * {@code org.apache.felix.eventadmin.IgnoreTopic} - Configure
* topics to be ignore and not delivered to registered handlers.
* </p>
* <p>
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/AbstractAdapter.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/AbstractAdapter.java
index 8a687d4..ce8e1eb 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/AbstractAdapter.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/AbstractAdapter.java
@@ -34,7 +34,7 @@
/**
* The constructor of the adapter.
*
- * @param admin The <tt>EventAdmin</tt> to use for posting events.
+ * @param admin The {@code EventAdmin} to use for posting events.
*/
public AbstractAdapter(final EventAdmin admin)
{
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java
index 5719999..0a5f380b 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java
@@ -38,11 +38,11 @@
{
/**
* The constructor of the adapter. This will register the adapter with the given
- * context as a <tt>BundleListener</tt> and subsequently, will post received
+ * context as a {@code BundleListener} and subsequently, will post received
* events via the given EventAdmin.
*
* @param context The bundle context with which to register as a listener.
- * @param admin The <tt>EventAdmin</tt> to use for posting events.
+ * @param admin The {@code EventAdmin} to use for posting events.
*/
public BundleEventAdapter(final BundleContext context, final EventAdmin admin)
{
@@ -57,7 +57,7 @@
/**
* Once a bundle event is received this method assembles and posts an event via
- * the <tt>EventAdmin</tt> as specified in 113.6.4 OSGi R4 compendium.
+ * the {@code EventAdmin} as specified in 113.6.4 OSGi R4 compendium.
*
* @param event The event to adapt.
*/
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/FrameworkEventAdapter.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/FrameworkEventAdapter.java
index 9a971d3..5edfe0c 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/FrameworkEventAdapter.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/FrameworkEventAdapter.java
@@ -39,11 +39,11 @@
{
/**
* The constructor of the adapter. This will register the adapter with the
- * given context as a <tt>FrameworkListener</tt> and subsequently, will
+ * given context as a {@code FrameworkListener} and subsequently, will
* post received events via the given EventAdmin.
*
* @param context The bundle context with which to register as a listener.
- * @param admin The <tt>EventAdmin</tt> to use for posting events.
+ * @param admin The {@code EventAdmin} to use for posting events.
*/
public FrameworkEventAdapter(final BundleContext context, final EventAdmin admin)
{
@@ -59,7 +59,7 @@
/**
* Once a framework event is received this method assembles and posts an event
- * via the <tt>EventAdmin</tt> as specified in 113.6.3 OSGi R4 compendium.
+ * via the {@code EventAdmin} as specified in 113.6.3 OSGi R4 compendium.
*
* @param event The event to adapt.
*/
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/LogEventAdapter.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/LogEventAdapter.java
index 84dcd70..8a11a93 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/LogEventAdapter.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/LogEventAdapter.java
@@ -33,9 +33,9 @@
import org.osgi.service.event.EventConstants;
/**
- * This class registers itself as a listener for <tt>LogReaderService</tt> services
- * with the framework and subsequently, a <tt>LogListener</tt> callback with any
- * currently available <tt>LogReaderService</tt>. Any received log event is then
+ * This class registers itself as a listener for {@code LogReaderService} services
+ * with the framework and subsequently, a {@code LogListener} callback with any
+ * currently available {@code LogReaderService}. Any received log event is then
* posted via the EventAdmin as specified in 113.6.6 OSGi R4 compendium.
* Note that this class does not create a hard dependency on the org.osgi.service.log
* packages. The adaption only takes place if it is present or once it becomes
@@ -56,13 +56,13 @@
/**
* The constructor of the adapter. This will register the adapter with the
- * given context as a listener for <tt>LogReaderService</tt> services and
- * subsequently, a <tt>LogListener</tt> callback with any currently available
- * <tt>LogReaderService</tt>. Any received log event is then posted via the given
+ * given context as a listener for {@code LogReaderService} services and
+ * subsequently, a {@code LogListener} callback with any currently available
+ * {@code LogReaderService}. Any received log event is then posted via the given
* EventAdmin.
*
* @param context The bundle context with which to register as a listener.
- * @param admin The <tt>EventAdmin</tt> to use for posting events.
+ * @param admin The {@code EventAdmin} to use for posting events.
*/
public LogEventAdapter(final BundleContext context, final EventAdmin admin)
{
@@ -106,9 +106,9 @@
}
/**
- * Once a <tt>LogReaderService</tt> register event is received this method
- * registers a <tt>LogListener</tt> with the received service that assembles
- * and posts any log event via the <tt>EventAdmin</tt> as specified in
+ * Once a {@code LogReaderService} register event is received this method
+ * registers a {@code LogListener} with the received service that assembles
+ * and posts any log event via the {@code EventAdmin} as specified in
* 113.6.6 OSGi R4 compendium.
*
* @param event The event to adapt.
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/ServiceEventAdapter.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/ServiceEventAdapter.java
index 74ab293..3dfff93 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/ServiceEventAdapter.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/adapter/ServiceEventAdapter.java
@@ -39,11 +39,11 @@
{
/**
* The constructor of the adapter. This will register the adapter with the
- * given context as a <tt>ServiceListener</tt> and subsequently, will
+ * given context as a {@code ServiceListener} and subsequently, will
* post received events via the given EventAdmin.
*
* @param context The bundle context with which to register as a listener.
- * @param admin The <tt>EventAdmin</tt> to use for posting events.
+ * @param admin The {@code EventAdmin} to use for posting events.
*/
public ServiceEventAdapter(final BundleContext context, final EventAdmin admin)
{
@@ -59,7 +59,7 @@
/**
* Once a Service event is received this method assembles and posts an event
- * via the <tt>EventAdmin</tt> as specified in 113.6.5 OSGi R4 compendium.
+ * via the {@code EventAdmin} as specified in 113.6.5 OSGi R4 compendium.
*
* @param event The event to adapt.
*/
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java
index 05977c0..6f2d235 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java
@@ -31,13 +31,13 @@
/**
* This is the actual implementation of the OSGi R4 Event Admin Service (see the
- * Compendium 113 for details). The implementation uses a <tt>HandlerTasks</tt>
- * in order to determine applicable <tt>EventHandler</tt> for a specific event and
- * subsequently dispatches the event to the handlers via <tt>DeliverTasks</tt>.
- * To do this, it uses two different <tt>DeliverTasks</tt> one for asynchronous and
- * one for synchronous event delivery depending on whether its <tt>post()</tt> or
- * its <tt>send()</tt> method is called. Note that the actual work is done in the
- * implementations of the <tt>DeliverTasks</tt>. Additionally, a stop method is
+ * Compendium 113 for details). The implementation uses a {@code HandlerTasks}
+ * in order to determine applicable {@code EventHandler} for a specific event and
+ * subsequently dispatches the event to the handlers via {@code DeliverTasks}.
+ * To do this, it uses two different {@code DeliverTasks} one for asynchronous and
+ * one for synchronous event delivery depending on whether its {@code post()} or
+ * its {@code send()} method is called. Note that the actual work is done in the
+ * implementations of the {@code DeliverTasks}. Additionally, a stop method is
* provided that prevents subsequent events to be delivered.
*
* @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
@@ -57,10 +57,15 @@
private Matchers.Matcher[] m_ignoreTopics;
/**
- * The constructor of the <tt>EventAdmin</tt> implementation.
+ * The constructor of the {@code EventAdmin} implementation.
*
+ * @param bundleContext The event admin bundle context
* @param syncPool The synchronous thread pool
* @param asyncPool The asynchronous thread pool
+ * @param timeout The timeout
+ * @param ignoreTimeout The configuration for ignoring timeouts
+ * @param requireTopic Are topics required?
+ * @param ignoreTopics The configuration to ignore topics
*/
public EventAdminImpl(
final BundleContext bundleContext,
@@ -162,6 +167,10 @@
/**
* Update the event admin with new configuration.
+ * @param timeout The timeout
+ * @param ignoreTimeout The configuration for ignoring timeouts
+ * @param requireTopic Are topics required?
+ * @param ignoreTopics The configuration to ignore topics
*/
public void update(final int timeout,
final String[] ignoreTimeout,
@@ -176,7 +185,7 @@
}
/**
- * This is a utility method that will throw a <tt>NullPointerException</tt>
+ * This is a utility method that will throw a {@code NullPointerException}
* in case that the given object is null. The message will be of the form
* "${name} + may not be null".
*/
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerProxy.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerProxy.java
index 5ff9938..30a1d79 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerProxy.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerProxy.java
@@ -269,6 +269,7 @@
/**
* Get some info about the event handler
+ * @return Handler info
*/
public String getInfo() {
return this.reference.toString() + " [Bundle " + this.reference.getBundle() + "]";
@@ -284,6 +285,7 @@
/**
* Get the event handler.
+ * @return The event handler or {@code null}
*/
private synchronized EventHandler obtain() {
if (this.handler == null)
@@ -325,7 +327,8 @@
/**
* Get the topics of this handler.
- * If this handler matches all topics <code>null</code> is returned
+ * If this handler matches all topics {@code null} is returned
+ * @return The topics of this handler or {@code null}
*/
public String[] getTopics()
{
@@ -337,6 +340,8 @@
* - denied
* - check filter
* - check permission
+ * @param event The event
+ * @return {@code true} if the event can be delivered
*/
public boolean canDeliver(final Event event)
{
@@ -370,6 +375,7 @@
/**
* Should a timeout be used for this handler?
+ * @return {@code true} if a timeout should be used
*/
public boolean useTimeout()
{
@@ -378,6 +384,7 @@
/**
* Should async events be delivered in order?
+ * @return {@code true} if async events should be delivered in order
*/
public boolean isAsyncOrderedDelivery()
{
@@ -386,6 +393,7 @@
/**
* Check the timeout configuration for this handler.
+ * @param className Handler name
*/
private void checkTimeout(final String className)
{
@@ -408,6 +416,7 @@
/**
* Send the event.
+ * @param event The event
*/
public void sendEvent(final Event event)
{
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerTracker.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerTracker.java
index 7c3c5fd..2e33f56 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerTracker.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/handler/EventHandlerTracker.java
@@ -68,7 +68,8 @@
/**
* Update the timeout configuration.
- * @param ignoreTimeout
+ * @param ignoreTimeout The configuration for ignoring timeout
+ * @param requireTopic Is a topic required
*/
public void update(final String[] ignoreTimeout, final boolean requireTopic) {
final Matchers.Matcher[] ignoreTimeoutMatcher = Matchers.createPackageMatchers(ignoreTimeout);
@@ -227,7 +228,6 @@
/**
* Get all handlers for this event
*
- * @param event The event topic
* @return All handlers for the event
*/
public Collection<EventHandlerProxy> getDeniedHandlers() {
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/EventAdminSecurityDecorator.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/EventAdminSecurityDecorator.java
index a1c0e19..9cf8c6f 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/EventAdminSecurityDecorator.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/EventAdminSecurityDecorator.java
@@ -25,10 +25,10 @@
import org.osgi.service.event.EventAdmin;
/**
- * This class is a decorator for an <tt>EventAdmin</tt> service. It secures the
+ * This class is a decorator for an {@code EventAdmin} service. It secures the
* service by checking any call from a given bundle (i.e., the caller) to the admins
* post or send methods for the appropriate permissions based on a given permission
- * factory. This methods then in turn throw a <tt>SecurityException</tt> in case
+ * factory. This methods then in turn throw a {@code SecurityException} in case
* the given bundle doesn't pass the check or delegate the call to decorated service
* instance, respectively.
*
@@ -45,8 +45,8 @@
/**
* The constructor of this decorator. The given bundle and permission factory
* will be used to determine appropriate permissions for any call to
- * <tt>postEvent()</tt> or <tt>sendEvent()</tt>, respectively. This method then
- * in turn throw a <tt>SecurityException</tt> in case the given bundle doesn't
+ * {@code postEvent()} or {@code sendEvent()}, respectively. This method then
+ * in turn throw a {@code SecurityException} in case the given bundle doesn't
* pass the check.
*
* @param bundle The calling bundle used to determine appropriate permissions
@@ -65,7 +65,7 @@
/**
* This method checks whether the given (i.e., calling) bundle has
* appropriate permissions to post an event to the targeted topic. A
- * <tt>SecurityException</tt> is thrown in case it has not. Otherwise, the
+ * {@code SecurityException} is thrown in case it has not. Otherwise, the
* event is posted using this decorator's service instance.
*
* @param event The event that should be posted
@@ -82,7 +82,7 @@
/**
* This method checks whether the given (i.e., calling) bundle has
* appropriate permissions to send an event to the targeted topic. A
- * <tt>SecurityException</tt> is thrown in case it has not. Otherwise,
+ * {@code SecurityException} is thrown in case it has not. Otherwise,
* the event is posted using this decorator's service instance.
*
* @param event The event that should be send
@@ -97,7 +97,7 @@
}
/**
- * Overrides <tt>hashCode()</tt> and returns the hash code of the decorated
+ * Overrides {@code hashCode()} and returns the hash code of the decorated
* service instance.
*
* @return The hash code of the decorated service instance
@@ -111,7 +111,7 @@
}
/**
- * Overrides <tt>equals()</tt> and delegates the call to the decorated service
+ * Overrides {@code equals()} and delegates the call to the decorated service
* instance. In case that o is an instance of this class it passes o's service
* instance instead of o.
*
@@ -131,7 +131,7 @@
}
/**
- * This is a utility method that will throw a <tt>SecurityExcepiton</tt> in case
+ * This is a utility method that will throw a {@code SecurityExcepiton} in case
* that the given bundle (i.e, the caller) has not appropriate permissions to
* publish to this topic. This method uses Bundle.hasPermission() and the given
* permission factory to determine this.
@@ -147,7 +147,7 @@
}
/*
- * This is a utility method that will throw a <tt>NullPointerException</tt>
+ * This is a utility method that will throw a {@code NullPointerException}
* in case that the given object is null. The message will be of the form name +
* may not be null.
*/
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/PermissionsUtil.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/PermissionsUtil.java
index 3bcccd7..da2eef9 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/PermissionsUtil.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/PermissionsUtil.java
@@ -33,11 +33,11 @@
private static volatile boolean createPermissions = true;
/**
- * Creates a <tt>TopicPermission</tt> for the given topic and the type PUBLISH
+ * Creates a {@code TopicPermission} for the given topic and the type PUBLISH
*
* @param topic The target topic
*
- * @return The created permission or <tt>null</tt> in case the
+ * @return The created permission or {@code null} in case the
* permission could not be created.
*
* @see org.osgi.service.event.TopicPermission
@@ -60,12 +60,12 @@
}
/**
- * Creates a <tt>TopicPermission</tt> for the given topic and the type SUBSCRIBE
+ * Creates a {@code TopicPermission} for the given topic and the type SUBSCRIBE
* Note that a
*
* @param topic The target topic
*
- * @return The created permission or a <tt>null</tt> in case the
+ * @return The created permission or a {@code null} in case the
* permission could not be created.
*
* @see org.osgi.service.event.TopicPermission
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/SecureEventAdminFactory.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/SecureEventAdminFactory.java
index e3a8e46..71c0c7f 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/SecureEventAdminFactory.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/security/SecureEventAdminFactory.java
@@ -24,11 +24,11 @@
import org.osgi.service.event.EventAdmin;
/**
- * This class is a factory that secures a given <tt>EventAdmin</tt> service by
- * wrapping it with a new instance of an <tt>EventAdminSecurityDecorator</tt> on
- * any call to its <tt>getService()</tt> method. The decorator will determine the
+ * This class is a factory that secures a given {@code EventAdmin} service by
+ * wrapping it with a new instance of an {@code EventAdminSecurityDecorator} on
+ * any call to its {@code getService()} method. The decorator will determine the
* appropriate permissions by using the given permission factory and the bundle
- * parameter passed to the <tt>getService()</tt> method.
+ * parameter passed to the {@code getService()} method.
*
* @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
*/
@@ -39,10 +39,10 @@
/**
* The constructor of the factory. The factory will use the given event admin and
- * permission factory to create a new <tt>EventAdminSecurityDecorator</tt>
- * on any call to <tt>getService()</tt>.
+ * permission factory to create a new {@code EventAdminSecurityDecorator}
+ * on any call to {@code getService()}.
*
- * @param admin The <tt>EventAdmin</tt> service to secure.
+ * @param admin The {@code EventAdmin} service to secure.
*/
public SecureEventAdminFactory(final EventAdmin admin)
{
@@ -52,14 +52,14 @@
}
/**
- * Returns a new <tt>EventAdminSecurityDecorator</tt> initialized with the
- * given <tt>EventAdmin</tt>. That in turn will check any call to post or
+ * Returns a new {@code EventAdminSecurityDecorator} initialized with the
+ * given {@code EventAdmin}. That in turn will check any call to post or
* send for the appropriate permissions based on the bundle parameter.
*
* @param bundle The bundle used to determine the permissions of the caller
* @param registration The ServiceRegistration that is not used
*
- * @return The given service instance wrapped by an <tt>EventAdminSecuriryDecorator</tt>
+ * @return The given service instance wrapped by an {@code EventAdminSecuriryDecorator}
*
* @see org.osgi.framework.ServiceFactory#getService(org.osgi.framework.Bundle,
* org.osgi.framework.ServiceRegistration)
@@ -91,7 +91,7 @@
}
/*
- * This is a utility method that will throw a <tt>NullPointerException</tt>
+ * This is a utility method that will throw a {@code NullPointerException}
* in case that the given object is null. The message will be of the form name +
* may not be null.
*/
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/AsyncDeliverTasks.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/AsyncDeliverTasks.java
index 651160c..22efdcb 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/AsyncDeliverTasks.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/AsyncDeliverTasks.java
@@ -62,6 +62,7 @@
* This does not block an unrelated thread used to send a synchronous event.
*
* @param tasks The event handler dispatch tasks to execute
+ * @param event The event
*
*/
public void execute(final Collection<EventHandlerProxy> tasks, final Event event)
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DefaultThreadPool.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DefaultThreadPool.java
index b71f51b..baf8b89 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DefaultThreadPool.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DefaultThreadPool.java
@@ -44,6 +44,8 @@
/**
* Create a new pool.
+ * @param poolSize The size of the pool
+ * @param syncThreads Sync or async pool
*/
public DefaultThreadPool(final int poolSize, final boolean syncThreads)
{
@@ -86,6 +88,7 @@
/**
* Configure a new pool size.
+ * @param poolSize The pool size
*/
public synchronized void configure(final int poolSize)
{
@@ -103,6 +106,7 @@
/**
* Returns current pool size.
+ * @return The pool size
*/
public int getPoolSize()
{
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DenylistLatch.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DenylistLatch.java
index 4d5d1b4..3a11ac3 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DenylistLatch.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/DenylistLatch.java
@@ -68,7 +68,7 @@
*
* Adds a handler task to the timeout based deny list checking.
*
- * @param task
+ * @param task The handler task
*/
public void addToDenylistCheck(final HandlerTask task)
{
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/HandlerTask.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/HandlerTask.java
index bf9b0d4..7d4c889 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/HandlerTask.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/HandlerTask.java
@@ -86,6 +86,7 @@
/**
* This method defines if a timeout handling should be used for the
* task.
+ * @return Use timeout?
*/
public boolean useTimeout()
{
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncDeliverTasks.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncDeliverTasks.java
index abec088..8abe392 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncDeliverTasks.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncDeliverTasks.java
@@ -35,7 +35,7 @@
* thread pool and this thread is used to deliver the event.
* The calling thread is blocked until either the deliver is finished
* or the timeout occurs.
- * <p><tt>
+ * <p>
* Note that in case of a timeout while a task is disabled the thread
* is released and we spin-off a new thread that resumes the disabled
* task hence, this is the only place were we break the semantics of
@@ -44,7 +44,6 @@
* blocked the dispatch for to long) but since it will not receive
* events anymore it will not notice this semantic difference except
* that it might not see events it already sent before.
- * </tt></pre>
*
* If during an event delivery a new event should be delivered from
* within the event handler, the timeout handler is stopped for the
@@ -63,6 +62,7 @@
/**
* Construct a new sync deliver tasks.
* @param pool The thread pool used to spin-off new threads.
+ * @param timeout The timeout configuration
*/
public SyncDeliverTasks(final DefaultThreadPool pool, final long timeout)
{
@@ -72,6 +72,7 @@
/**
* Update the timeout configuration
+ * @param timeout The timeout configuration
*/
public void update(final long timeout)
{
@@ -83,6 +84,8 @@
* event is send (or a timeout occurs).
*
* @param tasks The event handler dispatch tasks to execute
+ * @param event The event
+ * @param filterAsyncUnordered async handling
*
*/
public void execute(final Collection<EventHandlerProxy> tasks, final Event event, final boolean filterAsyncUnordered)
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncThread.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncThread.java
index 3ce23b6..34b71b5 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncThread.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/tasks/SyncThread.java
@@ -30,6 +30,7 @@
/**
* Constructor used by the thread pool.
+ * @param target The target
*/
public SyncThread(Runnable target)
{
diff --git a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/util/LogWrapper.java b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/util/LogWrapper.java
index 9b0b22e..b4f1a97 100644
--- a/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/util/LogWrapper.java
+++ b/eventadmin/impl/src/main/java/org/apache/felix/eventadmin/impl/util/LogWrapper.java
@@ -31,17 +31,17 @@
import org.osgi.framework.ServiceReference;
/**
- * This class mimics the standard OSGi <tt>LogService</tt> interface. An
+ * This class mimics the standard OSGi {@code LogService} interface. An
* instance of this class will be used by the EventAdmin for all logging. The
* implementation of this class sends log messages to standard output, if no
- * <tt>LogService</tt> is present; it uses a log service if one is
+ * {@code LogService} is present; it uses a log service if one is
* installed in the framework. To do that without creating a hard dependency on the
* package it uses fully qualified class names and registers a listener with the
- * framework hence, it does not need access to the <tt>LogService</tt> class but will
+ * framework hence, it does not need access to the {@code LogService} class but will
* use it if the listener is informed about an available service. By using a
* DynamicImport-Package dependency we don't need the package but
* use it if present. Additionally, all log methods prefix the log message with
- * <tt>EventAdmin: </tt>.
+ * {@code EventAdmin: }.
*
* There is one difference in behavior from the standard OSGi LogService.
* This logger has a {@link #m_logLevel} property which decides what messages
@@ -122,7 +122,7 @@
}
/**
- * Set the <tt>BundleContext</tt> of the bundle. This method registers a service
+ * Set the {@code BundleContext} of the bundle. This method registers a service
* listener for LogServices with the framework that are subsequently used to
* log messages.
* <p>
@@ -234,7 +234,7 @@
/**
* Log a message with the given log level. Note that this will prefix the message
- * with <tt>EventAdmin: </tt>.
+ * with {@code EventAdmin: }.
*
* @param level The log level with which to log the msg.
* @param msg The message to log.
@@ -285,7 +285,7 @@
/**
* Log a message with the given log level and the associated exception. Note that
- * this will prefix the message with <tt>EventAdmin: </tt>.
+ * this will prefix the message with {@code EventAdmin: }.
*
* @param level The log level with which to log the msg.
* @param msg The message to log.
@@ -337,7 +337,7 @@
/**
* Log a message with the given log level together with the associated service
- * reference. Note that this will prefix the message with <tt>EventAdmin: </tt>.
+ * reference. Note that this will prefix the message with {@code EventAdmin: }.
*
* @param sr The reference of the service associated with this message.
* @param level The log level with which to log the msg.
@@ -389,7 +389,7 @@
/**
* Log a message with the given log level, the associated service reference and
- * exception. Note that this will prefix the message with <tt>EventAdmin: </tt>.
+ * exception. Note that this will prefix the message with {@code EventAdmin: }.
*
* @param sr The reference of the service associated with this message.
* @param level The log level with which to log the msg.
