Events.java
| Index Score | ||
|---|---|---|
 |
 |
org.zkoss.zk.ui.event |
 |
 |
ZK |
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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| COMMENTS | Comment lines | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| SIZE | Size of the file in bytes | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOOPS | Number of loops | |
| WHITESPACE | Number of whitespace lines | |
| BLOCKS | Number of blocks | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
/* Events.java
{{IS_NOTE
Purpose:
Description:
History:
Fri Jul 22 15:49:51 2005, Created by tomyeh
}}IS_NOTE
Copyright (C) 2005 Potix Corporation. All Rights Reserved.
{{IS_RIGHT
This program is distributed under GPL Version 2.0 in the hope that
it will be useful, but WITHOUT ANY WARRANTY.
}}IS_RIGHT
*/
package org.zkoss.zk.ui.event;
import java.lang.reflect.Method;
import org.zkoss.zk.ui.Desktop;
import org.zkoss.zk.ui.Page;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.Execution;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.UiException;
import org.zkoss.zk.ui.sys.ExecutionCtrl;
import org.zkoss.zk.ui.sys.DesktopCtrl;
import org.zkoss.zk.ui.sys.ComponentCtrl;
import org.zkoss.zk.ui.sys.ComponentsCtrl;
import org.zkoss.zk.ui.sys.EventProcessingThread;
import org.zkoss.zk.ui.impl.EventProcessor;
import org.zkoss.zk.au.out.AuEcho;
import org.zkoss.zk.ui.util.Clients;
/**
* Utilities to handle events.
*
* @author tomyeh
*/
public class Events {
private Events() {} //prevent from creation
/** The onClick event (used with {@link MouseEvent}).
*/
public static final String ON_CLICK = "onClick";
/** The onRightClick event (used with {@link MouseEvent}).
*/
public static final String ON_RIGHT_CLICK = "onRightClick";
/** The onDoubleClick event (used with {@link MouseEvent}).
*/
public static final String ON_DOUBLE_CLICK = "onDoubleClick";
/** The onOK event (used with {@link KeyEvent}).
*/
public static final String ON_OK = "onOK";
/** The onCancel event (used with {@link KeyEvent}).
*/
public static final String ON_CANCEL = "onCancel";
/** The onCtrlKey event (used with {@link KeyEvent}).
*/
public static final String ON_CTRL_KEY = "onCtrlKey";
/** The onChange event (used with {@link InputEvent}).
*/
public static final String ON_CHANGE = "onChange";
/** The onChanging event (used with {@link InputEvent}).
*/
public static final String ON_CHANGING = "onChanging";
/** The onError event (used with {@link ErrorEvent}).
*/
public static final String ON_ERROR = "onError";
/** The onScroll event (used with {@link ScrollEvent}).
*/
public static final String ON_SCROLL = "onScroll";
/** The onScrolling event (used with {@link ScrollEvent}).
*/
public static final String ON_SCROLLING = "onScrolling";
/** The onSelect event (used with {@link SelectEvent}).
*/
public static final String ON_SELECT = "onSelect";
/** The onSelection event (used with {@link SelectionEvent}).
*/
public static final String ON_SELECTION = "onSelection";
/** The onCheck event (used with {@link CheckEvent}).
*/
public static final String ON_CHECK = "onCheck";
/** The onMove event (used with {@link MoveEvent}).
*/
public static final String ON_MOVE = "onMove";
/** The onSize event (used with {@link SizeEvent}).
*/
public static final String ON_SIZE = "onSize";
/** The onZIndex event (used with {@link ZIndexEvent}).
*/
public static final String ON_Z_INDEX = "onZIndex";
/** The onOpen event (used with {@link OpenEvent}).
*/
public static final String ON_OPEN = "onOpen";
/** The onClose event (used with {@link Event})
* used to denote the close button is pressed.
*/
public static final String ON_CLOSE = "onClose";
/** The onRender event (used with {@link org.zkoss.zk.ui.ext.client.RenderOnDemand}).
*/
public static final String ON_RENDER = "onRender";
/** The onTimer event (used with {@link Event}).
* Sent when a timer is up.
*/
public static final String ON_TIMER = "onTimer";
/** The onFocus event (used with {@link Event}).
* Sent when a component gets a focus.
*/
public static final String ON_FOCUS = "onFocus";
/** The onBlur event (used with {@link Event}).
* Sent when a component loses a focus.
*/
public static final String ON_BLUR = "onBlur";
/** The onDrop event (used with {@link DropEvent}).
* Sent when a component is dragged and drop to another.
*/
public static final String ON_DROP = "onDrop";
/** The onNotify event (used with {@link Event}).
* It is not used by any component, but it is, rather, designed to
* let users add customized events.
*/
public static final String ON_NOTIFY = "onNotify";
/** The onSort event (used with {@link Event})
* to notify a request for sorting.
*/
public static final String ON_SORT = "onSort";
/** The onUpload event (used with {@link UploadEvent}.
*/
public static final String ON_UPLOAD = "onUpload";
/** The onBookmarkChange event (used with {@link BookmarkEvent})
* to notify that user pressed BACK, FORWARD or specified URL directly
* that causes the bookmark is changed (but still in the same desktop).
* <p>All root components of all pages of the desktop will
* recieve this event.
* @since 3.0.8
*/
public static final String ON_BOOKMARK_CHANGE = "onBookmarkChange";
/** @deprecated As of release 3.0.8, replaced with {@link ON_BOOKMARK_CHANGE}.
*/
public static final String ON_BOOKMARK_CHANGED = "onBookmarkChanged";
/** The onURIChange event (used with {@link URIEvent})
* to notify that the associated URI of a component is changed.
* Currently only the iframe component supports this event.
* @since 3.5.0
*/
public static final String ON_URI_CHANGE = "onURIChange";
/** The onClientInfo event (used with {@link ClientInfoEvent}).
*/
public static final String ON_CLIENT_INFO = "onClientInfo";
/** The onCreate event (used with {@link CreateEvent}) to notify a compoent
* that it (and its children) has been created by ZK's evaluating a ZUML page.
*/
public static final String ON_CREATE = "onCreate";
/** The onModal event (used with {@link Event}) to notify a component
* shall become modal. Currently, only ZUL's window components support it.
*/
public static final String ON_MODAL = "onModal";
/** The onPiggyback event (used with {@link Event}) used to notify
* a root component that the client has sent a request to the server.
* It is meaningful only if it is registered to the root component.
* Once registered, it is called
* each time the client sends a request to the server.
* The onPiggyback's event listener is processed after all other
* events are processed.
*
* <p>The onPiggyback event is designed to let developers piggyback
* the least-emergent UI updates to the client.
*
* @since 2.4.0
*/
public static final String ON_PIGGYBACK = "onPiggyback";
/** The onUser event. It is a generic event that an application developer
* might send from the client. ZK doesn't use this event.
*/
public static final String ON_USER = "onUser";
/** The onMinimize event (used with {@link MinimizeEvent}).
* @since 3.5.0
*/
public static final String ON_MINIMIZE = "onMinimize";
/** The onMaximize event (used with {@link MaximizeEvent}).
* @since 3.5.0
*/
public static final String ON_MAXIMIZE = "onMaximize";
/** Returns whether an event name is valid.
*
* <p>The event name must start with on and the third character
* must be upper case.
*/
public static final boolean isValid(String name) {
return name != null && name.length() > 2
&& name.charAt(0) == 'o' && name.charAt(1) == 'n'
&& Character.isUpperCase(name.charAt(2));
}
/** Returns whether the current thread is an event listener.
*/
public static final boolean inEventListener() {
return EventProcessor.inEventListener();
}
/** Returns whether an event handler or listener is available for
* the specified component and event.
*
* <p>A event handler is either a public method named onXxx or
* a ZUL attribute named onXxx, where onXxx is the event name.
* A event listener is {@link EventListener} being added
* by {@link Component#addEventListener} and {@link Page#addEventListener}.
*
* <p>Unlike {@link Component#isListenerAvailable}, which checks
* only the event listener, this method
* check both event handlers and listeners, i.e.,
* the onXxx members defined in ZUML, the onXxx method defined
* in the implementation class, and the event listener registered.
*
* @param asap whether to check only non-deferrable listener,
* i.e., not implementing {@link org.zkoss.zk.ui.event.Deferrable},
* or {@link org.zkoss.zk.ui.event.Deferrable#isDeferrable} is false.
* @see org.zkoss.zk.ui.event.Deferrable
* @see Component#isListenerAvailable
*/
public static
boolean isListened(Component comp, String evtnm, boolean asap) {
if (((ComponentCtrl)comp).getEventHandler(evtnm) != null)
return true;
if (ComponentsCtrl.getEventMethod(comp.getClass(), evtnm) != null
|| comp.isListenerAvailable(evtnm, asap))
return true;
if (!asap) {
final Page page = comp.getPage();
return page != null && page.isListenerAvailable(evtnm);
}
return false;
}
/** Sends the event to the specified component and process it
* immediately. This method can only be called when processing an event.
* It is OK to send event to component from another page as long as
* they are in the same desktop.
*/
public static void sendEvent(Component comp, Event event) {
final Execution exec = Executions.getCurrent();
final Desktop desktop = exec.getDesktop();
//note: we don't use comp.getDesktop because 1) it may be null
//2) it may be different from the current desktop
event = ((DesktopCtrl)desktop).beforeSendEvent(event);
if (event == null)
return; //done
final Thread thd = (Thread)Thread.currentThread();
if (!(thd instanceof EventProcessingThread)) {
if (!desktop.getWebApp().getConfiguration().isEventThreadEnabled()) {
final ExecutionCtrl execCtrl = (ExecutionCtrl)exec;
final Page page = execCtrl.getCurrentPage();
final EventProcessor proc =
new EventProcessor(desktop, comp, event);
proc.setup();
try {
proc.process();
} catch (Exception ex) {
throw UiException.Aide.wrap(ex);
} finally {
execCtrl.setCurrentPage(page);
}
return; //done
}
throw new UiException("Callable only in the event listener");
}
try {
((EventProcessingThread)thd).sendEvent(comp, event);
} catch (Exception ex) {
throw UiException.Aide.wrap(ex);
}
}
/** Sends the event the target specified in the event.
*
* <p>Note: {@link Event#getTarget} cannot be null.
*/
public static void sendEvent(Event event) {
sendEvent(event.getTarget(), event);
}
/** Posts an event to the current execution.
*
* <p>The priority of the event is assumed to be 0. Refer to
* {@link #postEvent(int, Event)}.
*
* <p>On the other hand, the event sent by {@link #sendEvent} is processed
* immediately without posting it to the queue.
*
* <p>Note: if the target of an event is not attached to
* the page yet, the event is ignored silently.
* @see #sendEvent
* @see #echoEvent
* @see #postEvent(int, Event)
*/
public static final void postEvent(Event event) {
Executions.getCurrent().postEvent(event);
}
/** Posts an instance of {@link Event} to the current execution.
* <p>The priority of the event is assumed to be 0. Refer to
* {@link #postEvent(int, String, Component, Object)}.
* @see #postEvent(Event)
* @see #postEvent(int, String, Component, Object)
*/
public static final
void postEvent(String name, Component target, Object data) {
postEvent(0, name, target, data);
}
/** Posts an event to the current execution with the specified priority.
*
* <p>The posted events are processed from the higher priority to the
* lower one. If two events are posted with the same priority,
* the earlier the event being posted is processed earlier
* (first-in-first-out).
*
* <p>The priority posted by posted by {@link #postEvent(Event)} is
* 0.
* Applications shall not use the priority higher than 10,000 and
* lower than -10,000 since they are reserved for component
* development.
*
* @param priority the priority of the event.
* @since 3.0.7
*/
public static final void postEvent(int priority, Event event) {
Executions.getCurrent().postEvent(priority, event);
}
/** Posts an instance of {@link Event} to the current execution
* with the specified priority.
*
* <p>The posted events are processed from the higher priority to the
* lower one. If two events are posted with the same priority,
* the earlier the event being posted is processed earlier
* (first-in-first-out).
*
* <p>The priority posted by posted by {@link #postEvent(Event)} is
* 0.
* Applications shall not use the priority higher than 10,000 and
* lower than -10,000 since they are reserved for component
* development.
*
* @param priority the priority of the event.
* @since 3.0.7
*/
public static final void postEvent(int priority,
String name, Component target, Object data) {
if (name == null || name.length() == 0 || target == null)
throw new IllegalArgumentException("null");
postEvent(priority, new Event(name, target, data));
}
/** Echos an event.
* By echo we mean the event is fired after the client receives the AU
* responses and then echoes back.
* In others, the event won't be execute in the current execution.
* Rather, it executes after the client receives the AU responses
* and then echoes back the event back.
*
* <p>It is usually if you want to prompt the user before doing a long
* operartion. A typical case is to open a hightlighted window to
* prevent the user from clicking any button before the operation gets done.
*
* @since 3.0.2
* @see #sendEvent
* @see #echoEvent
* @param name the event name, such as onSomething
* @param target the component to receive the event (never null).
* @param data the extra information, or null if not available.
* It will become {@link Event#getData}.
*/
public static final void echoEvent(String name, Component target, String data) {
if (name == null || name.length() == 0 || target == null)
throw new IllegalArgumentException();
Clients.response(new AuEcho(target, name, data));
}
/** <p>Add onXxx event handler defined in controller object to the specified
* component.
* The controller is a POJO file with onXxx methods(the event handler codes).
* This utility method registers these onXxx events to the specified
* component so you don't have to implement and add {@link EventListener}
* into the component one by one.</p>
*
* <p>All public methods whose names start with "on" in controller object
* are considered
* as event handlers and the corresponding event is listened.
* For example, if the controller object has a method named onOK,
* then the onOK event is listened and the onOK method is called
* when the event is received.
* <p>This is a useful tool for MVC design practice. You can write
* onXxx event handler codes in controller object and use this utility to
* register the events to the specified component.</p>
*
* @param comp the component to be registered the events
* @param controller a POJO file with onXxx methods(event handlers)
* @since 3.0.6
* @see GenericEventListener
*/
public static final void addEventListeners(Component comp, final Object controller) {
final Method [] mtds = controller.getClass().getMethods();
final EventListener evtl = new EventListener() {
public void onEvent(Event evt) throws Exception {
final Method mtd = ComponentsCtrl.getEventMethod(controller.getClass(), evt.getName());
if (mtd != null) {
if (mtd.getParameterTypes().length == 0)
mtd.invoke(this, null);
else
mtd.invoke(this, new Object[] {evt});
}
}
};
for(int i=0; i < mtds.length; i ++){
final String evtnm = mtds[i].getName();
if (Events.isValid(evtnm))
comp.addEventListener(evtnm, evtl);
}
}
}
The table below shows all metrics for Events.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 23.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 262.00 | Comment lines | |
| COMMENT_DENSITY | 2.00 | Comment density | |
| COMPARISONS | 22.00 | Number of comparison operators | |
| CYCLOMATIC | 37.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 50.00 | Comments in declarations | |
| DOC_COMMENT | 242.00 | Number of javadoc comment lines | |
| ELOC | 131.00 | Effective lines of code | |
| EXEC_COMMENTS | 1.00 | Comments in executable code | |
| EXITS | 38.00 | Procedure exits | |
| FUNCTIONS | 13.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 47.90 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 51.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 | 8.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 | 1.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 | 14.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 3.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 | 0.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 | 0.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 | 0.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 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 530.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 | 2.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 | 1.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 | 437.00 | Number of lines in the source file | |
| LINE_COMMENT | 2.00 | Number of line comments | |
| LOC | 151.00 | Lines of code | |
| LOGICAL_LINES | 93.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 450.00 | Number of operands | |
| OPERATORS | 811.00 | Number of operators | |
| PARAMS | 23.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1261.00 | Halstead program length | |
| PROGRAM_VOCAB | 245.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 28.00 | Number of return points from functions | |
| SIZE | 15709.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 202.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 43.00 | Number of unique operators | |
| WHITESPACE | 24.00 | Number of whitespace lines | |