Page.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 | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMMENTS | Comment lines | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0141 | JAVA0141 Unnecessary modifier for method in interface | |
| FUNCTIONS | Number of function declarations | |
| PARAMS | Number of formal parameter declarations | |
| SIZE | Size of the file in bytes | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| COMMENT_DENSITY | Comment density | |
| EXEC_COMMENTS | Comments in executable code | |
| LINE_COMMENT | Number of line comments | |
| COMPARISONS | Number of comparison operators | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| OPERATORS | Number of operators | |
| LOOPS | Number of loops | |
| EXITS | Procedure exits | |
| WHITESPACE | Number of whitespace lines | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
/* Page.java
{{IS_NOTE
Purpose:
Description:
History:
Fri Jun 3 18:17:32 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;
import java.util.Map;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import org.zkoss.xel.FunctionMapper;
import org.zkoss.xel.VariableResolver;
import org.zkoss.xel.Function;
import org.zkoss.zk.scripting.Interpreter;
import org.zkoss.zk.scripting.Namespace;
import org.zkoss.zk.scripting.InterpreterNotFoundException;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.metainfo.LanguageDefinition;
import org.zkoss.zk.ui.metainfo.ComponentDefinition;
import org.zkoss.zk.ui.metainfo.ComponentDefinitionMap;
/**
* A page. A desktop consists of a set of pages.
* <p>When a ZK request is asking to render a new page, a new page is
* created and components that are created duing this request all belong to
* this page.
*
* <p>If a ZK requst is asking an update, it must have at lease one UUID of
* a component ({@link Component#getUuid}.
* From this UUID, we know which page it belongs and activate it
* to process the update.
*
<p>By activation, the system guarantees no concurrent access to pages
* and components (so you don't need use synchronized for them).
*
* <h2>Desktop</h2>
*
* <p>In portal and some environments, a client request (e.g., ServletRequest)
* might consists of several ZK requests ({@link org.zkoss.zk.au.AuRequest}).
* While each ZK request might ask to create an independent page,
* all these pages are grouped as a desktop, such that they are activated
* and removed at the same time.
* Moreover, pages in the same desktop could communicate to eath other
* (see <a href="#inter-page">Inter-page communication</a>).
*
* <p>A session, {@link Session}, might have multiple desktops of pages,
* {@link Page}, while a page belongs to exactly one session.
* A page, {@link Page}, might have many components, {@link Component}, while
* a component belongs to exactly one page.
*
* <p>All components of the same desktop of pages are removed at the same time
* if a page become 'obsolete'.
*
* <p>During each execution (${link Execution}), exactly one desktop of
* pages are locked (aka., activated). Though an execution serves
* a client request (e.g., ServletRequest), a client request might consist
* of multiple ZK request ({@link org.zkoss.zk.au.AuRequest}).
* Each ZK request might target to a different page (of the same desktop).
*
* <h2><a name="#inter-page"></a>Inter-page Communication</h2>
*
* <p>To do inter-page communication, you could do:
* <ol>
* <li>Invoke methods of components from another page directly.</li>
* <li>Use {@link Execution#postEvent} to post events to components from
* another page.</li>
* </ol>
*
* <p>They are the same as handling components from the same page.
* However, invoking method directly for components from another page has
* one restriction:<br>
* It cannot <b>create</b> component.
*
* @author tomyeh
*/
public interface Page extends IdSpace {
/** Returns ID which is unique in the request (never null).
*
* <p>Note: it returns null when
* {@link org.zkoss.zk.ui.util.Initiator#doInit} is called.
*/
public String getId();
/** Sets the identifier of this page.
*
* <p>Note: you can change the page's ID only in
* {@link org.zkoss.zk.ui.util.Initiator#doInit}
* or {@link org.zkoss.zk.ui.util.ExecutionInit#init}.
* Once the page is initialized (by {@link org.zkoss.zk.ui.sys.PageCtrl#init}),
* calling this
* method will cause an exception.
*
* @exception UiException if the page is initialized, i.e.,
* {@link org.zkoss.zk.ui.sys.PageCtrl#init} is called.
*/
public void setId(String id);
/** Returns UUID (universal unique ID) which is unquie in the whole
* session. The UUID is generated automatically and immutable.
*
* <p>It is mainly used for communication between client and server
* and you rarely need to access it.
*/
public String getUuid();
/** Returns the title of the desktop this page belongs to
* (and evaluate it if it contains an expression).
* <p>Default: "".
*/
public String getTitle();
/** Sets the title of the desktop this page belongs to
* (it might contain an expression).
*/
public void setTitle(String title);
/** Returns the CSS style of this page, or empty if not specified.
*/
public String getStyle();
/** Sets the CSS style of this page.
*
* <p>Note: Unlike {@link #setTitle}, you can change the style only in
* the lifecycle of the loading page.
*/
public void setStyle(String style);
/** Returns the request path of this page, or "" if not available.
* <p>It is the same as the servlet path
* (javax.servlet.http.HttpServletRequest's getServletPath), if ZK is running
* at a servlet container.
*
* <p>Note: {@link Desktop#getRequestPath} returns the request path
* that causes the desktop to create. And, there might be multiple
* pages in the same desktop.
*
* @see Execution#getContextPath
* @see Desktop#getRequestPath
*/
public String getRequestPath();
/** Returns the desktop that this page belongs to.
*
* <p>Note: it returns null when
* {@link org.zkoss.zk.ui.util.Initiator#doInit} is called.
*/
public Desktop getDesktop();
/** Returns a readonly list of the root components.
*/
public Collection getRoots();
/** Used with {@link #getAttribute} and relevants to denote
* custom attributes shared by the same page.
* <p>It is also known as the page attributes.
* <p>It is the same as {@link Page#getAttributes}.
*/
public static final int PAGE_SCOPE = Component.PAGE_SCOPE;
/** Used with {@link #getAttribute} and relevants to denote
* custom attributes shared by the same desktop.
* <p>It is also known as the desktop attributes.
* <p>It is the same as {@link Desktop#getAttributes}.
*/
public static final int DESKTOP_SCOPE = Component.DESKTOP_SCOPE;
/** Used with {@link #getAttribute} and relevants to denote
* custom attributes shared by the same session.
* <p>It is also known as the session attributes.
* <p>It is the same as {@link Session#getAttributes}.
*/
public static final int SESSION_SCOPE = Component.SESSION_SCOPE;
/** Used with {@link #getAttribute} and relevants to denote
* custom attributes shared by the whole application.
* <p>It is also known as the application attributes.
* <p>It is the same as {@link WebApp#getAttributes}.
*/
public static final int APPLICATION_SCOPE = Component.APPLICATION_SCOPE;
/** Used with {@link #getAttribute} and relevants to denote
* custom attributes shared by the same request.
* <p>It is also known as the request attributes.
* <p>It is the same as {@link Execution#getAttributes}.
*/
public static final int REQUEST_SCOPE = Component.REQUEST_SCOPE;
/** Returns all custom attributes of the specified scope.
* You could reference them thru componentScope, spaceScope, pageScope,
* requestScope and desktopScope in zscript and EL.
*
* <p>If scope is {@link #PAGE_SCOPE}, it means custom attributes shared
* by components from the same page as this one's.
* <p>If scope is {@link #DESKTOP_SCOPE}, it means custom attributes shared
* by components from the same desktopas this one's.
* @param scope {@link #APPLICATION_SCOPE}, {@link #SESSION_SCOPE},
* {@link #PAGE_SCOPE}, {@link #REQUEST_SCOPE} or {@link #DESKTOP_SCOPE}.
*/
public Map getAttributes(int scope);
/** Returns the value of the specified custom attribute in the specified scope.
*
* <p>If scope is {@link #PAGE_SCOPE}, it means custom attributes shared
* by components from the same page as this one's.
* <p>If scope is {@link #DESKTOP_SCOPE}, it means custom attributes shared
* by components from the same desktopas this one's.
* @param scope {@link #APPLICATION_SCOPE}, {@link #SESSION_SCOPE},
* {@link #PAGE_SCOPE}, {@link #REQUEST_SCOPE} or {@link #DESKTOP_SCOPE}.
*/
public Object getAttribute(String name, int scope);
/** Sets the value of the specified custom attribute in the specified scope.
*
* <p>If scope is {@link #PAGE_SCOPE}, it means custom attributes shared
* by components from the same page as this one's.
* <p>If scope is {@link #DESKTOP_SCOPE}, it means custom attributes shared
* by components from the same desktopas this one's.
* @param scope {@link #APPLICATION_SCOPE}, {@link #SESSION_SCOPE},
* {@link #PAGE_SCOPE}, {@link #REQUEST_SCOPE} or {@link #DESKTOP_SCOPE}.
*/
public Object setAttribute(String name, Object value, int scope);
/** Removes the specified custom attribute in the specified scope.
*
* <p>If scope is {@link #PAGE_SCOPE}, it means custom attributes shared
* by components from the same page as this one's.
* <p>If scope is {@link #DESKTOP_SCOPE}, it means custom attributes shared
* by components from the same desktopas this one's.
* @param scope {@link #APPLICATION_SCOPE}, {@link #SESSION_SCOPE},
* {@link #PAGE_SCOPE}, {@link #REQUEST_SCOPE} or {@link #DESKTOP_SCOPE}.
*/
public Object removeAttribute(String name, int scope);
/** Returns all custom attributes associated with this page.
*/
public Map getAttributes();
/** Returns the value of the specified attribute associated with this page.
*/
public Object getAttribute(String name);
/** Sets the value of the specified custom attribute associated with this page.
*
* <p>Note: The attribute is removed (by {@link #removeAttribute}
* if value is null, while {@link #setVariable} considers null as a legal value.
*
* @param value the value. If null, the attribute is removed.
*/
public Object setAttribute(String name, Object value);
/** Removes the specified attribute custom associated with the page.
*/
public Object removeAttribute(String name);
/** Sets a variable to the namespace ({@link #getNamespace}).
*
* <p>It is the same as getNamespace().setVariable(name, value, true).
*
* @see Component#setVariable
* @see Component#getNamespace
*/
public void setVariable(String name, Object val);
/** Returns whether the specified variable is defined.
*
* <p>Note: null is a valid value for variable, so this method is used
* to know whether a variable is defined.
* On the other hand, {@link #setAttribute} actually remove
* an attribute (by {@link #removeAttribute} if value is null.
*/
public boolean containsVariable(String name);
/** Returns the value of a variable defined in the namespace ({@link #getNamespace}).
*
* <p>It is the same as getNamespace().getVariable(name, true).
*
* <h3>Differences between {@link #getVariable} and {@link #getZScriptVariable}</h3>
*
* <p>{@link #getVariable} returns only variables defined by
* {@link #setVariable} (i.e., a shortcut to {@link Namespace#setVariable}).
* On the other hand, {@link #getZScriptVariable} returns these variables
* and those defined when executing zscripts.
*
* @see Component#getVariable
* @see Component#getNamespace
*/
public Object getVariable(String name);
/** Unsets a variable from the namespace ({@link #getNamespace}).
*
* <p>It is the same as getNamespace().unsetVariable(name, true).
*
* @see Component#unsetVariable
* @see Component#getNamespace
*/
public void unsetVariable(String name);
/** Returns the class of the specified name by searching
* the thread class loader and the classes defined in the
* loaded interpreters.
*
* <p>Note: if not defined in the interpeter, it will also look for
* the class by use of the current thread's class loader.
* See {@link #resolveClass}.
*
* @return the class, or null if not found
* @see #getLoadedInterpreters
*/
public Class getZScriptClass(String clsnm);
/** Resolves the class of the specified name.
* It first looks at Classes and then all loaded interpreters
* {@link #getLoadedInterpreters}.
*
* <p>It is similar to {@link #getZScriptClass}, except
* <ol>
* <li>It searches the current thread's class loader first,
* and then, the loaded interpreters.</li>
* <li>It throws ClassNotFoundException if not found</li>
* </ol>
*
* @since 3.0.1
* @see #getZScriptClass
*/
public Class resolveClass(String clsnm) throws ClassNotFoundException;
/** Returns the variable of the specified name by searching
* the loaded interpreters.
*
* @return the method, or null if not found
* @see #getLoadedInterpreters
* @since 3.0.0
*/
public Function getZScriptFunction(String name, Class[] argTypes);
/** Returns the variable of the specified name by searching
* the logical scope of the specified namespace for all
* the loaded interpreters.
*
* <p>It is similar to {@link #getZScriptVariable(String)}, except
* it uses the specified namespace as a reference to identify the
* correct scope for searching the variable.
* If the interpreter does NOT support hierachical scopes,
* this method is the same as {@link #getZScriptVariable(String)}.
*
* @param ns the namespace used as a reference to identify the
* correct scope for searching the variable.
* It is ignored if the interpreter doesn't support hierachical scopes.
* Note: this method doesn't look for any variable stored in ns.
* @return the method, or null if not found
* @see #getLoadedInterpreters
* @since 2.4.1
*/
public Function getZScriptFunction(Namespace ns, String name, Class[] argTypes);
/** Returns the variable of the specified name by searching
* the logical scope of the namespace of the specified component
* for all the loaded interpreters.
*
* <p>It is a shortcut: getZScriptFunction(comp.getNamespace(), name, argTypes);
* @since 3.0.0
*/
public Function getZScriptFunction(Component comp, String name, Class[] argTypes);
/** Returns the value of the variable of the specified name by searching
* the loaded interpreters, if any.
*
* <h3>Differences between {@link #getVariable} and {@link #getZScriptVariable}</h3>
*
* <p>{@link #getVariable} returns variables defined by
* {@link #setVariable} (i.e., a shortcut to {@link Namespace#setVariable}).
* On the other hand, {@link #getZScriptVariable} returns the variables
* that are defined when executing zscripts.
*
* @return the value of the variable, or null if not found
* @see #getLoadedInterpreters
*/
public Object getZScriptVariable(String name);
/** Returns the value of the variable of the specified name by searching
* the logical scope of the specified namespace for all
* the loaded interpreters, if any.
*
* <p>It is similar to {@link #getZScriptVariable(String)}, except
* it uses the specified namespace as a reference to identify the
* correct scope for searching the variable.
* If the interpreter does NOT support hierachical scopes,
* this method is the same as {@link #getZScriptVariable(String)}.
*
* @param ns the namespace used as a reference to identify the
* correct scope for searching the variable.
* It is ignored if the interpreter doesn't support hierachical scopes.
* Note: this method doesn't look for any variable stored in ns.
*/
public Object getZScriptVariable(Namespace ns, String name);
/** Returns the value of the variable of the specified name by searching
* the logical scope of the namespace of the specified component
* for all the loaded interpreters, if any.
*
* <p>It is a shortcut: getZScriptVariable(comp.getNamespace(), name);
* @since 3.0.0
*/
public Object getZScriptVariable(Component comp, String name);
/** Returns a variable that is visible to XEL expressions.
*
* <p>This method is mainly used to access special variable, such as
* request parameters (if this page is requested by HTTP).
*
* <p>Note: components that are specified with an ID are already accessible
* by {@link #getVariable}.
* @since 3.0.0
*/
public Object getXelVariable(String name);
/** Adds a name resolver that will be used to resolve a variable
* by {@link #getVariable}.
*
* <p>Note: the variables resolved by the specified resolver are
* accessible to both zscript and EL expressions.
*
* @return wether the resolver is added successfully.
* Note: if the resolver was added before, it won't be added again
* and this method returns false.
*/
public boolean addVariableResolver(VariableResolver resolver);
/** Removes a name resolve that was added by {@link #addVariableResolver}.
*
* @return false if resolved is not added before.
*/
public boolean removeVariableResolver(VariableResolver resolver);
//-- event listener --//
/** Adds an event listener to specified event for all components in
* this page.
*
* <p>Due to performance consideration, unlike {@link Component#addEventListener},
* all event listeners for the page are deferrable, no matter
* {@link org.zkoss.zk.ui.event.Deferrable} is implemented or not.
*
* @param evtnm what event to listen (never null)
* @return whether the listener is added; false if it was added before.
* @see Component#addEventListener
*/
public boolean addEventListener(String evtnm, EventListener listener);
/** Removes an event listener.
* @return whether the listener is removed; false if it was never added.
*/
public boolean removeEventListener(String evtnm, EventListener listener);
/** Returns whether the event listener is available.
*/
public boolean isListenerAvailable(String evtnm);
/** Returns an iterator for iterating listener for the specified event.
*/
public Iterator getListenerIterator(String evtnm);
//-- special control --//
/** Removes all components in this page.
*
* @see Execution#createComponents(String,Component,Map)
*/
public void removeComponents();
/** Invalidates this page to cause all components to redraw.
*/
public void invalidate();
/** Returns the namespace used to store variables belonging to
* the ID space of this page.
*
* @see #interpret
*/
public Namespace getNamespace();
/** Interpret a script of the specified scripting language against
* the specified namespace.
*
* @param zslang the scripting language. If null, {@link #getZScriptLanguage}
* is assumed.
* @param ns the namspace. If null, the current namespace is assumed.
* The current namespace is the event target's namespace
* ({@link org.zkoss.zk.ui.event.Event#getTarget}),
* if the thread is processing an event.
* Otherwise, the current namespace is this page's namespace
*/
public void interpret(String zslang, String script, Namespace ns);
/** Returns the interpreter of the specified scripting language.
*
* <p>The interpreter will be loaded and initialized,
* if it is not loaded yet.
*
* @param zslang the scripting language. If null, {@link #getZScriptLanguage}
* is assumed.
* @exception InterpreterNotFoundException if not found.
*/
public Interpreter getInterpreter(String zslang);
/** Returns all loaded interpreters.
*/
public Collection getLoadedInterpreters();
/** Returns the default scripting language which is assumed when
* a zscript element doesn't specify any language.
*
* @return the default scripting language, say, Java. Never null.
*/
public String getZScriptLanguage();
/** Sets the defafult scripting language which will be assumed
* if a zscript element doesn't specify any language.
*
* @exception InterpreterNotFoundException if no such language
*/
public void setZScriptLanguage(String zslang)
throws InterpreterNotFoundException;
/** Returns the implementation of the expression factory that
* is used by this page, or null if
* {@link org.zkoss.zk.ui.util.Configuration#getExpressionFactoryClass}
* is used.
*
* <p>Default: null.
*
* @see #setExpressionFactoryClass
* @since 3.0.4
*/
public Class getExpressionFactoryClass();
/** Sets the implementation of the expression factory that
* is used by this page.
*
* @param expfcls the class that implements
* {@link org.zkoss.xel.ExpressionFactory},
* If null, {@link org.zkoss.zk.ui.util.Configuration#getExpressionFactoryClass}
* is used.
* @see #getExpressionFactoryClass
* @since 3.0.4
*/
public void setExpressionFactoryClass(Class expfcls);
/** Returns if this page is a complete page.
* By complete we mean the page has everything that the client expects.
* For example, for HTML browsers, the page will generate
* the HTML, HEAD and BODY tags.
*
* <p>Default: false. It means that we assume a page is complete
* if and only if it is <em>not</em> included by other page.
*
* <p>If you have a page that has a complete HTML page and
* it is included by other page, you have to specify the complete flag
* to be true.
* @since 3.0.4
*/
public boolean isComplete();
/** Sets if the page is a complete page.
*
* <p>Default: false. It means a page is complete if and only if it
* is <em>not</em> included by other page.
*
* @param complete whether the page is complete.
* If true, this page is assumed to be complete no matter it is included
* or not. If false, this page is assumed to be complete if it is
* not included by other page.
* @see #isComplete
* @since 3.0.4
*/
public void setComplete(boolean complete);
//metainfo//
/** Returns the function mapper for resolving XEL functions, or null if
* not available.
*
* @since 3.0.0
*/
public FunctionMapper getFunctionMapper();
/** Adds the function mapper in addition to the current one.
*
* <p>The new added function mapper has the higher priority.
* {@link #getFunctionMapper} will return the new
*
* @param mapper the new function mapper (null to ignore).
*/
public void addFunctionMapper(FunctionMapper mapper);
/** Returns the language definition that this page belongs to (never null).
*/
public LanguageDefinition getLanguageDefinition();
/** Returns the map of component definitions (never null).
*
* <p>Note: the map is shared among all instance of the same page definition.
* Any component definition added (by {@link ComponentDefinitionMap#add})
* are visible to all other instances of the same page definition.
* Thus, it is NOT a good idea to change its content.
*/
public ComponentDefinitionMap getComponentDefinitionMap();
/** Returns the component definition of the specified name, or null
* if not found.
*
* <p>Note: unlike {@link LanguageDefinition#getComponentDefinition},
* this method doesn't throw ComponentNotFoundException if not found.
* It just returns null.
*
* @param recur whether to look up the component from {@link #getLanguageDefinition}
*/
public ComponentDefinition getComponentDefinition(String name, boolean recur);
/** Returns the component definition of the specified class, or null
* if not found.
*
* <p>Note: unlike {@link LanguageDefinition#getComponentDefinition},
* this method doesn't throw ComponentNotFoundException if not found.
* It just returns null.
*
* @param recur whether to look up the component from {@link #getLanguageDefinition}
*/
public ComponentDefinition getComponentDefinition(Class cls, boolean recur);
}
The table below shows all metrics for Page.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 503.00 | Comment lines | |
| COMMENT_DENSITY | 6.53 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 55.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 65.00 | Comments in declarations | |
| DOC_COMMENT | 482.00 | Number of javadoc comment lines | |
| ELOC | 77.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 55.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 18.98 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 56.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 | 1.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 | 5.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 | 40.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 34.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 | 1.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 | 1.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 | 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 | 502.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 | 1.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 | 609.00 | Number of lines in the source file | |
| LINE_COMMENT | 3.00 | Number of line comments | |
| LOC | 78.00 | Lines of code | |
| LOGICAL_LINES | 75.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 282.00 | Number of operands | |
| OPERATORS | 395.00 | Number of operators | |
| PARAMS | 56.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 677.00 | Halstead program length | |
| PROGRAM_VOCAB | 177.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 23303.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 156.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 21.00 | Number of unique operators | |
| WHITESPACE | 28.00 | Number of whitespace lines | |