HtmlBasedComponent.java
| Index Score | ||
|---|---|---|
 |
 |
org.zkoss.zk.ui |
 |
 |
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 | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0020 | JAVA0020 Field name does not have required form | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMMENTS | Comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| FUNCTIONS | Number of function declarations | |
| COMPARISONS | Number of comparison operators | |
| SIZE | Size of the file in bytes | |
| RETURNS | Number of return points from functions | |
| LINES | Number of lines in the source file | |
| JAVA0071 | JAVA0071 Strings compared with == | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0080 | JAVA0080 Import declaration not used | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0106 | JAVA0106 Unnecessary import from current package | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| WHITESPACE | Number of whitespace lines | |
| LOOPS | Number of loops | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
/* HtmlBasedComponent.java
{{IS_NOTE
Purpose:
Description:
History:
Sat Dec 31 12:30:18 2005, Created by tomyeh
}}IS_NOTE
Copyright (C) 2004 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;
import java.io.Writer;
import java.io.IOException;
import org.zkoss.lang.Objects;
import org.zkoss.lang.Strings;
import org.zkoss.xml.HTMLs;
import org.zkoss.zk.ui.AbstractComponent;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.ext.client.Movable;
import org.zkoss.zk.ui.ext.client.Sizable;
import org.zkoss.zk.ui.ext.client.ZIndexed;
import org.zkoss.zk.ui.ext.render.ZidRequired;
import org.zkoss.zk.ui.ext.render.Floating;
import org.zkoss.zk.ui.ext.render.PrologAllowed;
import org.zkoss.zk.ui.sys.ComponentCtrl;
import org.zkoss.zk.au.out.AuFocus;
import org.zkoss.zk.fn.ZkFns;
/**
* A skeletal implementation for HTML based components.
* It simplifies to implement methods common to HTML based components.
*
* <p>It supports
* <ul>
* <li>{@link #getSclass} and {@link #getStyle}.</li>
* <li>{@link #getWidth}, {@link #getHeight}, {@link #getLeft},
* {@link #getTop}, {@link #getZIndex}</li>
* <li>{@link #getOuterAttrs}</li>
* <li>{@link #getInnerAttrs}</li>
* <li>{@link #focus}</li>
* </ul>
*
* @author tomyeh
*/
abstract public class HtmlBasedComponent extends AbstractComponent {
private String _tooltiptext;
/** The width. */
private String _width;
/** The height. */
private String _height;
/** The CSS class. */
private String _sclass;
/** The CSS class of the specific mold. */
private String _moldSclass;
/** The CSS style. */
private String _style;
private String _left, _top;
/** The draggable. */
private String _draggable;
/** The droppable. */
private String _droppable;
private int _zIndex = -1;
/** The prolog content that shall be generated before real content. */
private String _prolog;
protected HtmlBasedComponent() {
}
/** Returns the left position.
*/
public String getLeft() {
return _left;
}
/** Sets the left position.
*/
public void setLeft(String left) {
if (!Objects.equals(_left, left)) {
_left = left;
smartUpdate("style.left", getLeft());
}
}
/** Returns the top position.
*/
public String getTop() {
return _top;
}
/** Sets the top position.
*/
public void setTop(String top) {
if (_top != top) {
_top = top;
smartUpdate("style.top", getTop());
}
}
/** Returns the Z index.
* <p>Default: -1 (means system default;
*/
public int getZIndex() {
return _zIndex;
}
/** Sets the Z index.
*/
public void setZIndex(int zIndex) {
if (_zIndex < -1)
_zIndex = -1;
if (_zIndex != zIndex) {
_zIndex = zIndex;
if (_zIndex < 0)
smartUpdate("style.zIndex", null);
else
smartUpdate("style.zIndex", _zIndex);
}
}
/** Returns the height. If null, the best fit is used.
* <p>Default: null.
*/
public String getHeight() {
return _height;
}
/** Sets the height. If null, the best fit is used.
*/
public void setHeight(String height) {
if (height != null && height.length() == 0)
height = null;
if (!Objects.equals(_height, height)) {
_height = height;
smartUpdate("style.height", getHeight());
}
}
/** Returns the width. If null, the best fit is used.
* <p>Default: null.
*/
public String getWidth() {
return _width;
}
/** Sets the width. If null, the best fit is used.
*/
public void setWidth(String width) {
if (width != null && width.length() == 0)
width = null;
if (!Objects.equals(_width, width)) {
_width = width;
smartUpdate("style.width", getWidth());
}
}
/** Returns the text as the tooltip.
* <p>Default: null.
*/
public String getTooltiptext() {
return _tooltiptext;
}
/** Sets the text as the tooltip.
*/
public void setTooltiptext(String tooltiptext) {
if (tooltiptext != null && tooltiptext.length() == 0)
tooltiptext = null;
if (!Objects.equals(_tooltiptext, tooltiptext)) {
_tooltiptext = tooltiptext;
smartUpdate("title", _tooltiptext);
}
}
/**
* Returns the CSS class(es) of the specific mold of the component.
* It usually depends on the implementation of the mold (@{link #getMold}).
* <p>Default: null.
* @since 3.5.0
* @see #getSclass
* @see #getRealSclass
*/
public String getMoldSclass() {
return _moldSclass;
}
/**
* Sets the CSS class of the specific mold of the component.
* It usually depends on the implementation of the mold (@{link #getMold}).
* Replacing the CSS classes with {@link #setMoldSclass} will
* replace all default styles. In other words, you have to provide
* a complete replacement.
* On the other hand, if you want to do small adjustments,
* use {@link #setSclass} instead.
*
* @since 3.5.0
* @see #setSclass
*/
public void setMoldSclass(String moldSclass) {
if (moldSclass != null && moldSclass.length() == 0) moldSclass = null;
if (!Objects.equals(_moldSclass, moldSclass)) {
_moldSclass = moldSclass;
invalidate();
}
}
/** Returns the CSS class.
* Due to Java's limitation, we cannot use the name called getClas.
* <p>Default: null (the default value depends on element).
* @see #getRealSclass
* @see #getMoldSclass
*/
public String getSclass() {
return _sclass;
}
/** Sets the CSS class.
* @see #setMoldSclass
*/
public void setSclass(String sclass) {
if (sclass != null && sclass.length() == 0) sclass = null;
if (!Objects.equals(_sclass, sclass)) {
_sclass = sclass;
invalidate();
}
}
/** Sets the CSS class. This method is a bit confused with Java's class,
* but we provide it for XUL compatibility.
* The same as {@link #setSclass}.
*/
public final void setClass(String sclass) {
setSclass(sclass);
}
/** Returns the CSS style.
* <p>Default: null.
*/
public String getStyle() {
return _style;
}
/** Sets the CSS style.
*/
public void setStyle(String style) {
if (style != null && style.length() == 0) style = null;
if (!Objects.equals(_style, style)) {
_style = style;
smartUpdate("style", getRealStyle());
}
}
/** Sets "true" or "false" to denote whether a component is draggable,
* or an identifier of a draggable type of objects.
*
* <p>The simplest way to make a component draggable is to set
* this attribute to true. To disable it, set this to false.
*
* <p>If there are several types of draggable objects, you could
* assign an identifier for each type of draggable object.
* The identifier could be anything but empty.
*
* @param draggable "false", null or "" to denote non-draggable; "true" for draggable
* with anonymous identifier; others for an identifier of draggable.
*/
public void setDraggable(String draggable) {
if (draggable != null
&& (draggable.length() == 0 || "false".equals(draggable)))
draggable = null;
if (!Objects.equals(_draggable, draggable)) {
_draggable = draggable;
smartUpdate("z.drag", _draggable);
}
}
/** Returns the identifier of a draggable type of objects, or "false"
* if not draggable (never null nor empty).
*/
public final String getDraggable() {
return _draggable != null ? _draggable: "false";
}
/** Sets "true" or "false" to denote whether a component is droppable,
* or a list of identifiers of draggable types of objects that could
* be droped to this component.
*
* <p>The simplest way to make a component droppable is to set
* this attribute to true. To disable it, set this to false.
*
* <p>If there are several types of draggable objects and this
* component accepts only some of them, you could assign a list of
* identifiers that this component accepts, separated by comma.
* For example, if this component accpets dg1 and dg2, then
* assign "dg1, dg2" to this attribute.
*
* @param droppable "false", null or "" to denote not-droppable;
* "true" for accepting any draggable types; a list of identifiers,
* separated by comma for identifiers of draggables this compoent
* accept (to be dropped in).
*/
public void setDroppable(String droppable) {
if (droppable != null
&& (droppable.length() == 0 || "false".equals(droppable)))
droppable = null;
if (!Objects.equals(_droppable, droppable)) {
_droppable = droppable;
smartUpdate("z.drop", _droppable);
}
}
/** Returns the identifier of a droppable type of objects, or "false"
* if not droppable (never null nor empty).
*/
public final String getDroppable() {
return _droppable != null ? _droppable: "false";
}
/** Sets focus to this element. If an element does not accept focus,
* this method has no effect.
*/
public void focus() {
response("focus", new AuFocus(this));
}
/** Sets focus to this element.
* It is same as {@link #focus}, but used to allow ZUML to set focus
* to particular component.
*
* <pre><code><textbox focus="true"/></code></pre>
*
* @param focus whether to set focus. If false, this method has no effect.
* @since 3.0.5
*/
public void setFocus(boolean focus) {
if (focus) focus();
}
//-- component developer only --//
/** Returns the attributes for onClick, onRightClick and onDoubleClick
* by checking whether the corresponding listeners are added,
* or null if none is added.
*
* @since 3.0.5
*/
protected String getAllOnClickAttrs() {
StringBuffer sb = null;
sb = appendAsapAttr(sb, Events.ON_CLICK);
sb = appendAsapAttr(sb, Events.ON_DOUBLE_CLICK);
sb = appendAsapAttr(sb, Events.ON_RIGHT_CLICK);
return sb != null ? sb.toString(): null;
}
/** Returns the exterior attributes for generating the enclosing
* HTML tag; never return null.
*
* <p>Used only by component developers.
*
* <p>Default: Generates the tooltip text, style, sclass, draggable
* and droppable attribute if necessary.
* In other words, the corresponding attribute is generated if
* {@link #getTooltiptext}, {@link #getRealStyle},
* {@link #getSclass}, {@link #getDraggable}, {@link #getDroppable}
* are defined.
*
* <p>You have to call both {@link #getOuterAttrs} and
* {@link #getInnerAttrs} to generate complete attributes.
*
* <p>For simple components that all attributes are put on
* the outest HTML element, all you need is as follows.
*
* <pre><code><xx id="${self.uuid}"${self.outerAttrs}${self.innerAttrs}></code></pre>
*
* <p>If you want to put attributes in a nested HTML element, you
* shall use the following pattern. Notice: if {@link #getInnerAttrs}
* in a different tag, the tag must be named with "${self.uuid}!real".
*
* <pre><code><xx id="${self.uuid}"${self.outerAttrs}>
* <yy id="${self.uuid}!real"${self.innerAttrs}>...
*</code></pre>
*
* <p>Note: This class handles non-deferrable event listeners automatically.
* However, you have to invoke {@link #appendAsapAttr} for each event
* the component handles in {@link #getOuterAttrs} as follows.
*<pre><code>
* appendAsapAttr(sb, Events.ON_OPEN);
* appendAsapAttr(sb, Events.ON_CHANGE);
*</code></pre>
*
* <p>Theorectically, you could put any attributes in either
* {@link #getInnerAttrs} or {@link #getOuterAttrs}.
* However, zkau.js assumes all attributes are put at the outer one.
* If you want something different, you have to provide your own
* setAttr (refer to how checkbox is implemented).
*/
public String getOuterAttrs() {
final StringBuffer sb = new StringBuffer(64);
HTMLs.appendAttribute(sb, "class", getRealSclass());
HTMLs.appendAttribute(sb, "style", getRealStyle());
HTMLs.appendAttribute(sb, "title", getTooltiptext());
HTMLs.appendAttribute(sb, "z.drag", _draggable);
HTMLs.appendAttribute(sb, "z.drop", _droppable);
HTMLs.appendAttribute(sb, "z.mcls", getMoldSclass());
final Object xc = getExtraCtrl();
if ((xc instanceof ZidRequired) && ((ZidRequired)xc).isZidRequired())
HTMLs.appendAttribute(sb, "z.zid", getId());
if ((xc instanceof Floating) && ((Floating)xc).isFloating())
sb.append(" z.float=\"true\"");
return sb.toString();
}
/** Returns the interior attributes for generating the inner HTML tag;
* never return null.
*
* <p>Used only by component developers.
*
* <p>Default: empty string.
* Refer to {@link #getOuterAttrs} for more details.
*/
public String getInnerAttrs() {
return "";
}
/** Returns the real style class that will be generated to the client
* (when {@link #getOuterAttrs} is called).
*
* <p>Default: it simply returns the catenation of {@link #getSclass}
* and {@link #getMoldSclass()} (since 3.5.0).
*
* <p>Derived classes might override it to provide, say, dual style classes.
* For example,
* <pre><code>final String sclass = getSclass();
*return sclass != null ? sclass + " my-addon": "myaddon";</code></pre>
*
* @since 3.0.0
* @see #getMoldSclass()
*/
protected String getRealSclass() {
final String moldsclass = getMoldSclass();
final String sclass = getSclass();
return moldsclass == null ? sclass :
sclass == null ? moldsclass : sclass + " " + moldsclass;
}
/** Returns the real style that will be generated to client
* (when {@link #getOuterAttrs} is called).
*
* <p>Default: this method will append width, height and others
* to {@link #setStyle} (never null).
*
* <p>Use {@link #getRealStyleFlags} to control what attributes to
* exclude.
*/
protected String getRealStyle() {
final int flags = getRealStyleFlags();
final StringBuffer sb = new StringBuffer(32);
if ((flags & RS_NO_WIDTH) == 0)
HTMLs.appendStyle(sb, "width", getWidth());
if ((flags & RS_NO_HEIGHT) == 0)
HTMLs.appendStyle(sb, "height", getHeight());
HTMLs.appendStyle(sb, "left", getLeft());
HTMLs.appendStyle(sb, "top", getTop());
final int zIndex = getZIndex();
if (zIndex > 0)
HTMLs.appendStyle(sb, "z-index", Integer.toString(zIndex));
String style = getStyle();
if (style != null && style.length() > 0) {
sb.append(style);
if (!style.endsWith(";")) sb.append(';');
}
if ((flags & RS_NO_DISPLAY) == 0 && !isVisible()) {
if (sb.length() == 0)
return "display:none;";
sb.append("display:none;");
}
return sb.toString();
}
/** Used by {@link #getRealStyleFlags} to denote that {@link #getRealStyle}
* shall not generate the width style.
*/
protected static final int RS_NO_WIDTH = 0x0001;
/** Used by {@link #getRealStyleFlags} to denote that {@link #getRealStyle}
* shall not generate the height style.
*/
protected static final int RS_NO_HEIGHT = 0x0002;
/** Used by {@link #getRealStyleFlags} to denote that {@link #getRealStyle}
* shall not generate the display style.
*/
protected static final int RS_NO_DISPLAY = 0x0004;
/** Returns a combination of {@link #RS_NO_WIDTH} and {@link #RS_NO_HEIGHT}.
* <p>Default: return 0.
*/
protected int getRealStyleFlags() {
return 0;
}
//-- Component --//
public void redraw(Writer out) throws IOException {
if (_prolog != null) {
final Writer o = out != null ? out: ZkFns.getCurrentOut();
if (o != null) o.write(_prolog);
//don't reset _prolog, since it might be redrawn later
}
super.redraw(out);
}
//--ComponentCtrl--//
/** Used by {@link #getExtraCtrl} to create a client control.
* It is used only by component developers.
*
* <p>Defaut: creates an instance of {@link HtmlBasedComponent.ExtraCtrl}.
*/
protected Object newExtraCtrl() {
return new ExtraCtrl();
}
/** A utility class to implement {@link #getExtraCtrl}.
* It is used only by component developers.
*
* <p>If a component requires more client controls, it is suggested to
* override {@link #newExtraCtrl} to return an instance that extends from
* this interface.
*/
protected class ExtraCtrl implements Movable, Sizable, ZIndexed, PrologAllowed {
//-- Movable --//
public void setLeftByClient(String left) {
_left =left;
}
public void setTopByClient(String top) {
_top = top;
}
//-- Sizable --//
public void setWidthByClient(String width) {
_width = width;
}
public void setHeightByClient(String height) {
_height = height;
}
//-- ZIndexed --//
public void setZIndexByClient(int zIndex) {
_zIndex = zIndex;
}
//-- PrologAware --//
public void setPrologContent(String prolog) {
_prolog = prolog;
}
}
}
The table below shows all metrics for HtmlBasedComponent.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 54.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 268.00 | Comment lines | |
| COMMENT_DENSITY | 1.36 | Comment density | |
| COMPARISONS | 52.00 | Number of comparison operators | |
| CYCLOMATIC | 93.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 53.00 | Comments in declarations | |
| DOC_COMMENT | 242.00 | Number of javadoc comment lines | |
| ELOC | 197.00 | Effective lines of code | |
| EXEC_COMMENTS | 1.00 | Comments in executable code | |
| EXITS | 37.00 | Procedure exits | |
| FUNCTIONS | 40.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 69.43 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 63.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 | 1.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 | 12.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 | 20.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 | 1.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 | 1.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 1.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 | 4.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 | 1.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 | 1.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 10.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 18.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 | 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 | 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 | 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 | 687.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 | 544.00 | Number of lines in the source file | |
| LINE_COMMENT | 8.00 | Number of line comments | |
| LOC | 253.00 | Lines of code | |
| LOGICAL_LINES | 124.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 2.00 | Maximum nesting depth | |
| OPERANDS | 591.00 | Number of operands | |
| OPERATORS | 1112.00 | Number of operators | |
| PARAMS | 20.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1703.00 | Halstead program length | |
| PROGRAM_VOCAB | 226.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 43.00 | Number of return points from functions | |
| SIZE | 16484.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 183.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 43.00 | Number of unique operators | |
| WHITESPACE | 23.00 | Number of whitespace lines | |