EventService.java
| Index Score | ||
|---|---|---|
 |
 |
org.bushe.swing.event |
 |
 |
Phex |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| COMMENTS | Comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| PARAMS | Number of formal parameter declarations | |
| SIZE | Size of the file in bytes | |
| JAVA0141 | JAVA0141 Unnecessary modifier for method in interface | |
| FUNCTIONS | Number of function declarations | |
| LINES | Number of lines in the source file | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| COMMENT_DENSITY | Comment density | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0132 | JAVA0132 Method overload with compatible signature | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| COMPARISONS | Number of comparison operators | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| OPERATORS | Number of operators | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| PROGRAM_LENGTH | Halstead program length | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| EXITS | Procedure exits | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**
* Copyright 2005 Bushe Enterprises, Inc., Hopkinton, MA, USA, www.bushe.com
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
package org.bushe.swing.event;
import java.util.List;
import java.util.regex.Pattern;
import java.lang.reflect.Type;
import org.bushe.swing.event.generics.TypeReference;
/**
* The core interface. An EventService provides publish/subscribe services to a single JVM using Class-based and
* String-based (i.e. "topic") publications and subscriptions.
* <p/>
* In the class-based pub/sub, Objects are published on an {@link EventService} and (@link EventSubscriber}s subscribe
* by providing a class or interface. Full class semantics are used, as expected. That is, if a subscriber subscribes
* to a class, the subscriber is notified if an object of that class is publish or if an object of a subclass of that
* class is published. Likewise if a subscriber subscribes to and interface, it will be notified if any object that
* implements that interface is published. Subscribers can subscribe "exactly" using {@link #subscribeExactly(Class,
*EventSubscriber)} so that they are notified only if an object of the exact class is published (and will not be
* notified if subclasses are published, since this would not be "exact")
* <p/>
* In topic-based pub/sub, a data Object is published on a topic name (String). {@link EventTopicSubscriber}s subscribe
* to either the exact name of the topic or they may subscribe using a Regular Expression that is used to match topic
* names.
* <p/>
* See package documentation for usage details and examples.
* <p/>
* A single subscriber cannot subscribe more than once to an event or topic name. EventService implementations should
* handle double-subscription requests by returing false on subscribe(). A single EventSubscriber can subscribe to more
* than one event class, and a single EventTopicSubscriber can subscribe to more than one topic name or pattern. A
* single object may implement both EventSubscriber and EventTopicSubscriber interfaces. Subscribers are guaranteed to
* only be called for the classes and/or topic names they subscribe to. If a subscriber subscribes to a topic and to a
* regular expression that matches the topic name, this is considered two different subscriptions and the subscriber
* will be called twice for the publication on the topic. Similarly, if a subscriber subscribes to a class and its
* subclasses using subscribe() and again to a class of the same type using subscribeExactly(), this is considered two
* different subscriptions and the subscriber will be called twice for the publication for a single event of the exact
* type.
* <p/>
* By default the EventService only holds WeakReferences to subscribers. If a subscriber has no references to it, then
* it can be garbage collected. This avoids memory leaks in exchange for the risk of accidently adding a listener and
* have it disappear unexpectedly. If you want to subscribe a subscriber that will have no other reference to it, then
* use one of the subscribeStrongly() methods, which will prevent garbage collection.
* <p/>
* Unless garbage collected, EventSubscribers will remain subscribed until they are passed to one of the unsubscribe()
* methods with the event class or topic name to which there are subscribed.
* <p/>
* Publication on a class or topic name can be vetoed by a {@link VetoEventListener}. All VetoEventListeners are checked
* before any EventSubscribers or EventTopicSubscribers are called. This is unlike the JavaBean's
* VetoPropertyEventListener which can leave side effects and half-propogated events. VetoEventListeners are subscribed
* in the same manner as EventSubscribers and EventTopicSubscribers.
* <p/>
* Subscribers are called in the order in which they are subscribed by default (FIFO). This is also unlike Swing, where
* event listeners are called in the reverse order of when they were subscribed (FILO).
* <p/>
* This simple example prints "Hello World"
* <pre>
* EventService eventService = new ThreadSafeEventService();
* //Create a subscriber
* EventTopicSubscriber subscriber = new EventTopicSubscriber() {
* public void onEvent(String topic, Object event) {
* System.out.println(topic+" "+event);
* }
* });
* eventService.subscribe("Hello", subscriber);
* eventService.publish("Hello", "World");
* System.out.println(subscriber + " Since the reference is used after it is subscribed, it doesn't get garbage
* collected,
* this is not necessary if you use subscribeStrongly()");
* </pre>
* <p/>
* Events and/or topic data can be cached, but are not by default. To cache events or topic data, call
* #setDefaultCacheSizePerClassOrTopic(int), #setCacheSizeForEventClass(Class, int), or #setCacheSizeForTopic(String,
* int), #setCacheSizeForTopic(Pattern, int). Retrieve cached values with #getLastEvent(Class),
* #getLastTopicData(String), #getCachedEvents(Class), or #getCachedTopicData(String). Using caching while subscribing
* is most likely to make sense only if you subscribe and publish on the same thread (so caching is very useful for
* Swing applications since both happen on the EDT in a single-threaded manner). In multithreaded applications, you
* never know if your subscriber has handled an event while it was being subscribed (before the subscribe() method
* returned) that is newer or older than the retrieved cached value (taked before or after subscribe() respectively).
* <p/>
* There is nothing special about the term "Event," this could just as easily be called a "Message" Service, this term
* is already taken by the JMS, which is similar, but is used across processes and networks.
*
* @author Michael Bushe michael@bushe.com
* @see ThreadSafeEventService for the default implementation
* @see SwingEventService for the Swing-safe implementation
* @see EventBus for simple access to the Swing-safe implementation
* @see @org.bushe.swing.event.annotation.EventSubscriber for subscription annotations
* @see @org.bushe.swing.event.annotation.EventTopicSubscriber for subscription annotations
*/
public interface EventService {
/**
* Publishes an Object so that subscribers will be notified if they subscribed to the Object's class, one of its
* subclasses, or to one of its implementing interfaces.
*
* @param event The event that occured
*/
public void publish(Object event);
/**
* Use this method to publish generified objects to subscribers of Types, i.e. subscribers that use
* {@link #subscribe(Type, EventSubscriber)}, and to publish to subscribers to the non-generic type, i.e.,
* those that use {@link #subscribe(Class, EventSubscriber)} .
* <p>
* Due to generic type erasure, the type must be supplied by the caller. You can get a declared object's
* type by using the {@link org.bushe.swing.event.generics.TypeReference} class. For Example:
* <pre>
* TypeReference<List<Trade>> subscribingTypeReference = new TypeReference<List<Trade>>(){};
* EventBus.subscribe(subscribingTypeReference.getType(), mySubscriber);
* EventBus.subscribe(List.class, thisSubscriberWillGetCalledToo);
* ...
* //Likely in some other class
* TypeReference<List<Trade>> publishingTypeReference = new TypeReference<List<Trade>>(){};
* List<Trade> trades = new ArrayList<Trade>();
* EventBus.publish(publishingTypeReference.getType(), trades);
* trades.add(trade);
* EventBus.publish(publishingTypeReference.getType(), trades);
* </pre>
* <p>
* @param genericType the generified type of the event. Due to generic type erasure, this must be supplied.
* @param event The event that occured
*/
public void publish(Type genericType, Object event);
/**
* Publishes an object on a topic name so that all subscribers to that name will be notified about it.
*
* @param topic The name of the topic subscribed to
* @param o the object to publish
*/
public void publish(String topic, Object o);
/**
* Subscribes a <b>WeakReference</b> to an EventSubscriber to the publication of events of an event class and its
* subclasses, or to an event's interface.
* <p/>
* Subscription is weak by default to avoid having to call unsubscribe(), and to avoid the memory leaks that would
* occur if unsubscribe was not called. The service will respect the WeakReference semantics. In other words, if
* the subscriber has not been garbage collected, then onEvent(Object) will be called normally. If the hard
* reference has been garbage collected, the service will unsubscribe it's WeakReference.
* <p/>
* It's allowable to call unsubscribe() with the same EventSubscriber hard reference to stop a subscription
* immediately.
* <p/>
* The service will create the WeakReference on behalf of the caller. on behalf of the caller.
*
* @param eventClass the class of published objects to listen to
* @param subscriber The subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribe(Class eventClass, EventSubscriber subscriber);
public boolean subscribe(Type type, EventSubscriber subscriber);
/**
* Subscribes a <b>WeakReference</b> to an EventSubscriber to the publication of events of an event class (not its
* subclasses).
* <p/>
* Subscription is weak by default to avoid having to call unsubscribe(), and to avoid the memory leaks that would
* occur if unsubscribe was not called. The service will respect the WeakReference semantics. In other words, if
* the subscriber has not been garbage collected, then the onEvent will be called normally. If the hard reference
* has been garbage collected, the service will unsubscribe it's WeakReference.
* <p/>
* It's allowable to call unsubscribe() with the same EventSubscriber hard reference to stop a subscription
* immediately.
* <p/>
* The service will create the WeakReference on behalf of the caller.
*
* @param eventClass the class of published objects to listen to
* @param subscriber The subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribeExactly(Class eventClass, EventSubscriber subscriber);
/**
* Subscribes a <b>WeakReference</b> to an EventSubscriber to the publication of a topic name.
* <p/>
* Subscription is weak by default to avoid having to call unsubscribe(), and to avoid the memory leaks that would
* occur if unsubscribe was not called. The service will respect the WeakReference semantics. In other words, if
* the subscriber has not been garbage collected, then the onEvent will be called normally. If the hard reference
* has been garbage collected, the service will unsubscribe it's WeakReference.
* <p/>
* It's allowable to call unsubscribe() with the same EventSubscriber hard reference to stop a subscription
* immediately.
* <p/>
*
* @param topic the name of the topic listened to
* @param subscriber The topic subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribe(String topic, EventTopicSubscriber subscriber);
/**
* Subscribes a <b>WeakReference</b> to an EventSubscriber to the publication of all the topic names that match a
* RegEx Pattern.
* <p/>
* Subscription is weak by default to avoid having to call unsubscribe(), and to avoid the memory leaks that would
* occur if unsubscribe was not called. The service will respect the WeakReference semantics. In other words, if
* the subscriber has not been garbage collected, then the onEvent will be called normally. If the hard reference
* has been garbage collected, the service will unsubscribe it's WeakReference.
* <p/>
* It's allowable to call unsubscribe() with the same EventSubscriber hard reference to stop a subscription
* immediately.
* <p/>
*
* @param topicPattern pattern that matches to the name of the topic published to
* @param subscriber The topic subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribe(Pattern topicPattern, EventTopicSubscriber subscriber);
/**
* Subscribes a subscriber to an event class and its subclasses.
* <p/>
* The subscriber will remain subscribed until {@link #unsubscribe(Class,EventSubscriber)} is called.
*
* @param eventClass the class of published objects to listen to
* @param subscriber The subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribeStrongly(Class eventClass, EventSubscriber subscriber);
/**
* Subscribes a subscriber to an event class (and not its subclasses).
* <p/>
* The subscriber will remain subscribed until {@link #unsubscribe(Class,EventSubscriber)} is called.
*
* @param eventClass the class of published objects to listen to
* @param subscriber The subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribeExactlyStrongly(Class eventClass, EventSubscriber subscriber);
/**
* Subscribes a subscriber to an event topic name.
* <p/>
* The subscriber will remain subscribed until {@link #unsubscribe(String,EventTopicSubscriber)} is called.
*
* @param topic the name of the topic listened to
* @param subscriber The topic subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribeStrongly(String topic, EventTopicSubscriber subscriber);
/**
* Subscribes a subscriber to all the event topic names that match a RegEx expression.
* <p/>
* The subscriber will remain subscribed until {@link #unsubscribe(String,EventTopicSubscriber)} is called.
*
* @param topicPattern the name of the topic listened to
* @param subscriber The topic subscriber that will accept the events when published.
*
* @return true if the subscriber was subscribed sucessfully, false otherwise
*/
public boolean subscribeStrongly(Pattern topicPattern, EventTopicSubscriber subscriber);
/**
* Stop the subscription for a subscriber that is subscribed to an event class and its subclasses.
*
* @param eventClass the class of published objects to listen to
* @param subscriber The subscriber that is subscribed to the event. The same reference as that was subscribed.
*
* @return true if the subscriber was subscribed to the event, false if it wasn't
*/
public boolean unsubscribe(Class eventClass, EventSubscriber subscriber);
/**
* Stop the subscription for a subscriber that is subscribed to an event class (and not its subclasses).
*
* @param eventClass the class of published objects to listen to
* @param subscriber The subscriber that is subscribed to the event. The same reference as that was subscribed.
*
* @return true if the subscriber was subscribed to the event, false if it wasn't
*/
public boolean unsubscribeExactly(Class eventClass, EventSubscriber subscriber);
/**
* Stop the subscription for a subscriber that is subscribed to an event topic
*
* @param topic the topic listened to
* @param subscriber The subscriber that is subscribed to the topic. The same reference as that was subscribed.
*
* @return true if the subscriber was subscribed to the event, false if it wasn't
*/
public boolean unsubscribe(String topic, EventTopicSubscriber subscriber);
/**
* Stop the subscription for a subscriber that is subscribed to an event topic
*
* @param topicPattern the regex expression matching topics listened to
* @param subscriber The subscriber that is subscribed to the topic. The same reference as that was subscribed.
*
* @return true if the subscriber was subscribed to the event, false if it wasn't
*/
public boolean unsubscribe(Pattern topicPattern, EventTopicSubscriber subscriber);
/**
* Subscribes a <b>WeakReference</b> to a VetoListener to a event class and its subclasses.
* <p/>
* Use this method to avoid having to call unsubscribe(), though with care since garbage collection semantics is
* indeterminate. The service will respect the WeakReference semantics. In other words, if the vetoListener has not
* been garbage collected, then the onEvent will be called normally. If the hard reference has been garbage
* collected, the service will unsubscribe it's WeakReference.
* <p/>
* It's allowable to call unsubscribe() with the same VetoListener hard reference to stop a subscription
* immediately.
* <p/>
* The service will create the WeakReference on behalf of the caller.
*
* @param eventClass the class of published objects that can be vetoed
* @param vetoListener The vetoListener that can determine whether an event is published.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*/
public boolean subscribeVetoListener(Class eventClass, VetoEventListener vetoListener);
/**
* Subscribes a <b>WeakReference</b> to a VetoListener to a event class (but not its subclasses).
* <p/>
* Use this method to avoid having to call unsubscribe(), though with care since garbage collection semantics is
* indeterminate. The service will respect the WeakReference semantics. In other words, if the vetoListener has not
* been garbage collected, then the onEvent will be called normally. If the hard reference has been garbage
* collected, the service will unsubscribe it's WeakReference.
* <p/>
* It's allowable to call unsubscribe() with the same VetoListener hard reference to stop a subscription
* immediately.
* <p/>
* The service will create the WeakReference on behalf of the caller.
*
* @param eventClass the class of published objects that can be vetoed
* @param vetoListener The vetoListener that can determine whether an event is published.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*/
public boolean subscribeVetoListenerExactly(Class eventClass, VetoEventListener vetoListener);
/**
* Subscribes a <b>WeakReference</b> to a VetoTopicEventListener to a topic name.
*
* @param topic the name of the topic listened to
* @param vetoListener The vetoListener that can determine whether an event is published.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*/
public boolean subscribeVetoListener(String topic, VetoTopicEventListener vetoListener);
/**
* Subscribes a <b>WeakReference</b> to an VetoTopicEventListener to all the topic names that match the RegEx
* Pattern.
*
* @param topicPattern the RegEx pattern to match topics with
* @param vetoListener The vetoListener that can determine whether an event is published.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*/
public boolean subscribeVetoListener(Pattern topicPattern, VetoTopicEventListener vetoListener);
/**
* Subscribes a VetoListener for an event class and its subclasses.
* <p/>
* The VetoListener will remain subscribed until {@link #unsubscribeVetoListener(Class,VetoEventListener)} is
* called.
*
* @param eventClass the class of published objects to listen to
* @param vetoListener The vetoListener that will accept the events when published.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*/
public boolean subscribeVetoListenerStrongly(Class eventClass, VetoEventListener vetoListener);
/**
* Subscribes a VetoListener for an event class (but not its subclasses).
* <p/>
* The VetoListener will remain subscribed until {@link #unsubscribeVetoListener(Class,VetoEventListener)} is
* called.
*
* @param eventClass the class of published objects to listen to
* @param vetoListener The vetoListener that will accept the events when published.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*/
public boolean subscribeVetoListenerExactlyStrongly(Class eventClass, VetoEventListener vetoListener);
/**
* Subscribes a VetoListener to a topic name.
* <p/>
* The VetoListener will remain subscribed until {@link #unsubscribeVetoListener(String,VetoTopicEventListener)} is
* called.
*
* @param topic the name of the topic listened to
* @param vetoListener The topic vetoListener that will accept or reject publication.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*
* @see #subscribeVetoListenerStrongly(Class,VetoEventListener)
*/
public boolean subscribeVetoListenerStrongly(String topic, VetoTopicEventListener vetoListener);
/**
* Subscribes a VetoTopicEventListener to a set of topics that match a RegEx expression.
* <p/>
* The VetoListener will remain subscribed until {@link #unsubscribeVetoListener(Pattern,VetoTopicEventListener)} is
* called.
*
* @param topicPattern the RegEx pattern that matches the name of the topics listened to
* @param vetoListener The topic vetoListener that will accept or reject publication.
*
* @return true if the vetoListener was subscribed sucessfully, false otherwise
*
* @see #subscribeVetoListenerStrongly(Pattern,VetoTopicEventListener)
*/
public boolean subscribeVetoListenerStrongly(Pattern topicPattern, VetoTopicEventListener vetoListener);
/**
* Stop the subscription for a vetoListener that is subscribed to an event class and its subclasses.
*
* @param eventClass the class of published objects that can be vetoed
* @param vetoListener The vetoListener that will accept or reject publication of an event.
*
* @return true if the vetoListener was subscribed to the event, false if it wasn't
*/
public boolean unsubscribeVetoListener(Class eventClass, VetoEventListener vetoListener);
/**
* Stop the subscription for a vetoListener that is subscribed to an event class (but not its subclasses).
*
* @param eventClass the class of published objects that can be vetoed
* @param vetoListener The vetoListener that will accept or reject publication of an event.
*
* @return true if the vetoListener was subscribed to the event, false if it wasn't
*/
public boolean unsubscribeVetoListenerExactly(Class eventClass, VetoEventListener vetoListener);
/**
* Stop the subscription for a VetoTopicEventListener that is subscribed to an event topic name.
*
* @param topic the name of the topic that is listened to
* @param vetoListener The vetoListener that can determine whether an event is published on that topic
*
* @return true if the vetoListener was subscribed to the topic, false if it wasn't
*/
public boolean unsubscribeVetoListener(String topic, VetoTopicEventListener vetoListener);
/**
* Stop the subscription for a VetoTopicEventListener that is subscribed to an event topic RegEx pattern.
*
* @param topicPattern the RegEx pattern matching the name of the topics listened to
* @param vetoListener The vetoListener that can determine whether an event is published on that topic
*
* @return true if the vetoListener was subscribed to the topicPattern, false if it wasn't
*/
public boolean unsubscribeVetoListener(Pattern topicPattern, VetoTopicEventListener vetoListener);
/**
* Union of getSubscribersToClass(Class) and getSubscribersToExactClass(Class)
*
* @param eventClass the eventClass of interest
*
* @return the subscribers that will be called when an event of eventClass is published, this includes those
* subscribed that match by exact class and those that match to a class and its subtypes
*/
public List getSubscribers(Class eventClass);
/**
* @param eventClass the eventClass of interest
*
* @return the subscribers that are subscribed to match to a class and its subtypes, but not those subscribed by
* exact class
*/
public List getSubscribersToClass(Class eventClass);
/**
* @param eventClass the eventClass of interest
*
* @return the subscribers that are subscribed by exact class but not those subscribed to match to a class and its
* subtypes
*/
public List getSubscribersToExactClass(Class eventClass);
/**
* Union of getSubscribersByPattern(String) and geSubscribersToTopic(String)
*
* @param topic the topic of interest
*
* @return the subscribers that will be called when an event is published on the topic. This includes subscribers
* subsribed to match the exact topic name and those subscribed by a RegEx Pattern that matches the topic
* name.
*/
public List getSubscribers(String topic);
/**
* @param topic the topic of interest
*
* @return the subscribers that subscribed to the exact topic name.
*/
public List getSubscribersToTopic(String topic);
/**
* @param pattern the RegEx pattern for the topic of interest
*
* @return the subscribers that subscribed by a RegEx Pattern that matches the topic name.
*/
public List getSubscribersByPattern(String pattern);
/**
* @param eventClass the eventClass of interest
*
* @return the veto subscribers that will be called when an event of eventClass or its subclasses is published.
*/
public List getVetoSubscribers(Class eventClass);
/**
* @param eventClass the eventClass of interest
*
* @return the veto subscribers that will be called when an event of eventClass (but not its subclasses) is
* published.
*/
public List getVetoSubscribersToExactClass(Class eventClass);
/**
* @param eventClass the eventClass of interest
*
* @return the veto subscribers that are subscribed to the eventClass and its subclasses
*/
public List getVetoSubscribersToClass(Class eventClass);
/**
* @param topic the topic of interest
*
* @return the veto subscribers that will be called when an event is published on the topic.
*/
public List getVetoSubscribers(String topic);
/**
* @param pattern the RegEx pattern for the topic of interest
*
* @return the veto subscribers that will be called when an event is published on the topic.
*/
public List getVetoSubscribers(Pattern pattern);
/** Clears all current subscribers and veto subscribers */
public void clearAllSubscribers();
/**
* Sets the default cache size for each kind of event, default is 0 (no caching).
* <p/>
* If this value is set to a positive number, then when an event is published, the EventService caches the event or
* topic payload data for later retrieval. This allows subscribers to find out what has most recently happened
* before they subscribed. The cached event(s) are returned from #getLastEvent(Class), #getLastTopicData(String),
* #getCachedEvents(Class), or #getCachedTopicData(String)
* <p/>
* The default can be overridden on a by-event-class or by-topic basis.
*
* @param defaultCacheSizePerClassOrTopic
*/
public void setDefaultCacheSizePerClassOrTopic(int defaultCacheSizePerClassOrTopic);
/** @return the default number of event payloads kept per event class or topic */
public int getDefaultCacheSizePerClassOrTopic();
/**
* Set the number of events cached for a particular class of event. By default, no events are cached.
* <p/>
* This overrides any setting for the DefaultCacheSizePerClassOrTopic.
* <p/>
* Class hierarchy semantics are respected. That is, if there are three events, A, X and Y, and X and Y are both
* derived from A, then setting the cache size for A applies the cache size for all three. Setting the cache size
* for X applies to X and leaves the settings for A and Y in tact. Intefaces can be passed to this method, but they
* only take effect if the cache size of a class or it's superclasses has been set. Just like Class.getInterfaces(),
* if multiple cache sizes are set, the interface names declared earliest in the implements clause of the eventClass
* takes effect.
* <p/>
* The cache for an event is not adjusted until the next event of that class is published.
*
* @param eventClass the class of event
* @param cacheSize the number of published events to cache for this event
*/
public void setCacheSizeForEventClass(Class eventClass, int cacheSize);
/**
* Returns the number of events cached for a particular class of event. By default, no events are cached.
* <p/>
* This result is computed for a particular class from the values passed to #setCacheSizeForEventClass(Class, int),
* and respects the class hierarchy.
*
* @param eventClass the class of event
*
* @return the maximum size of the event cache for the given event class
*
* @see #setCacheSizeForEventClass(Class,int)
*/
public int getCacheSizeForEventClass(Class eventClass);
/**
* Set the number of published data objects cached for a particular event topic. By default, no data are cached.
* <p/>
* This overrides any setting for the DefaultCacheSizePerClassOrTopic.
* <p/>
* Exact topic names take precedence over pattern matching.
* <p/>
* The cache for a topic is not adjusted until the next publication on that topic.
*
* @param topicName the topic name
* @param cacheSize the number of published data Objects to cache for this topci
*/
public void setCacheSizeForTopic(String topicName, int cacheSize);
/**
* Set the number of published data objects cached for a topics matching a pattern. By default, no data are cached.
* <p/>
* This overrides any setting for the DefaultCacheSizePerClassOrTopic.
* <p/>
* Exact topic names take precedence over pattern matching.
* <p/>
* The cache for a topic is not adjusted until the next publication on that topic.
*
* @param pattern the pattern matching topic names
* @param cacheSize the number of data Objects to cache for this topci
*/
public void setCacheSizeForTopic(Pattern pattern, int cacheSize);
/**
* Returns the number of cached data objects published on a particular topic.
* <p/>
* This result is computed for a particular class from the values passed to #setCacheSizeForEventClass(Class, int),
* and respects the class hierarchy.
*
* @param topic the topic name
*
* @return the maximum size of the data Object cache for the given topic
*
* @see #setCacheSizeForTopic(String,int)
* @see #setCacheSizeForTopic(java.util.regex.Pattern,int)
*/
public int getCacheSizeForTopic(String topic);
/**
* @param eventClass an index into the cache
*
* @return the last event published for this event class, or null if caching is turned off (the default)
*/
public Object getLastEvent(Class eventClass);
/**
* @param eventClass an index into the cache
*
* @return the last events published for this event class, or null if caching is turned off (the default)
*/
public List getCachedEvents(Class eventClass);
/**
* @param topic an index into the cache
*
* @return the last data Object published on this topic, or null if caching is turned off (the default)
*/
public Object getLastTopicData(String topic);
/**
* @param topic an index into the cache
*
* @return the last data Objects published on this topic, or null if caching is turned off (the default)
*/
public List getCachedTopicData(String topic);
/**
* Clears the event cache for a specific event class or interface and it's any of it's subclasses or implementing
* classes.
*
* @param eventClass the event class to clear the cache for
*/
public void clearCache(Class eventClass);
/**
* Clears the topic data cache for a specific topic name.
*
* @param topic the topic name to clear the cache for
*/
public void clearCache(String topic);
/**
* Clears the topic data cache for all topics that match a particular pattern.
*
* @param pattern the pattern to match topic caches to
*/
public void clearCache(Pattern pattern);
/** Clear all event caches for all topics and event. */
public void clearCache();
/**
* When using annotations, an object may be subscribed by proxy. This unsubscibe method will unsubscribe an object
* that is subscribed with a ProxySubscriber.
* <p/>
* If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
* still unsubscribe the object.
*
* @param eventClass class this object is subscribed to by proxy
* @param subcribedByProxy object subscribed by proxy
*/
boolean unsubscribe(Class eventClass, Object subcribedByProxy);
/**
* When using annotations, an object may be subscribed by proxy. This unsubscibe method will unsubscribe an object
* that is subscribed with a ProxySubscriber.
* <p/>
* If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
* still unsubscribe the object.
*
* @param eventClass class this object is subscribed to by proxy
* @param subcribedByProxy object subscribed by proxy
*/
boolean unsubscribeExactly(Class eventClass, Object subcribedByProxy);
/**
* When using annotations, an object may be subscribed by proxy. This unsubscibe method will unsubscribe an object
* that is subscribed with a ProxySubscriber.
* <p/>
* If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
* still unsubscribe the object.
*
* @param topic the topic this object is subscribed to by proxy
* @param subcribedByProxy object subscribed by proxy
*/
boolean unsubscribe(String topic, Object subcribedByProxy);
/**
* When using annotations, an object may be subscribed by proxy. This unsubscibe method will unsubscribe an object
* that is subscribed with a ProxySubscriber.
* <p/>
* If an object is subscribed by proxy and it implements EventSubscriber, then the normal unsubscribe methods will
* still unsubscribe the object.
*
* @param pattern the RegEx expression this object is subscribed to by proxy
* @param subcribedByProxy object subscribed by proxy
*/
boolean unsubscribe(Pattern pattern, Object subcribedByProxy);
}
The table below shows all metrics for EventService.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 630.00 | Comment lines | |
| COMMENT_DENSITY | 9.69 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 59.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 60.00 | Comments in declarations | |
| DOC_COMMENT | 630.00 | Number of javadoc comment lines | |
| ELOC | 65.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 59.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 11.07 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 90.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 4.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 5.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 55.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 759.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 66.00 | Lines of code | |
| LOGICAL_LINES | 64.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 272.00 | Number of operands | |
| OPERATORS | 344.00 | Number of operators | |
| PARAMS | 90.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 616.00 | Halstead program length | |
| PROGRAM_VOCAB | 186.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 36748.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 172.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 14.00 | Number of unique operators | |
| WHITESPACE | 63.00 | Number of whitespace lines | |