IRequestCycle.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.tapestry |
 |
|
Apache Tapestry 4 |
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 |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| FUNCTIONS | Number of function declarations | |
| SIZE | Size of the file in bytes | |
| COMMENT_DENSITY | Comment density | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| COMPARISONS | Number of comparison operators | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| LOGICAL_LINES | Number of statements | |
| BLOCKS | Number of blocks | |
| OPERANDS | Number of operands | |
| RETURNS | Number of return points from functions | |
| UNIQUE_OPERATORS | Number of unique operators | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| EXITS | Procedure exits | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
// Copyright 2004, 2005 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package org.apache.tapestry;
import org.apache.hivemind.ApplicationRuntimeException;
import org.apache.tapestry.engine.IEngineService;
import org.apache.tapestry.services.Infrastructure;
import org.apache.tapestry.services.ResponseBuilder;
import java.util.Iterator;
/**
* Controller object that manages a single request cycle. A request cycle is one 'hit' on the web
* server. In the case of a Tapestry application, this will involve:
* <ul>
* <li>Responding to the URL by finding an {@link IEngineService}object
* <li>Determining the result page
* <li>Renderring the result page
* <li>Releasing any resources
* </ul>
* <p>
* Mixed in with this is:
* <ul>
* <li>Exception handling
* <li>Loading of pages and templates from resources
* <li>Tracking changes to page properties, and restoring pages to prior states
* <li>Pooling of page objects
* </ul>
*
* <p>
* A request cycle is broken up into two phases. The <em>rewind</em> phase is optional, as it tied
* to {@link org.apache.tapestry.form.Form}
* components. In the rewind phase, a previous page render is redone (discarding output) until a
* specific component of the page is reached. This rewinding ensures that the page is restored to
* the exact state it had when the URL for the request cycle was generated, taking into account the
* dynamic nature of the page ({@link org.apache.tapestry.components.ForBean},
* {@link org.apache.tapestry.components.Conditional}, etc.). Once this component is reached, it
* can notify its {@link IActionListener}. The listener has the ability to update the state of any
* pages and select a new result page.
* </p>
*
* <p>
* Following the rewind phase is the <em>render</em> phase. During the render phase, a page is
* actually rendered and output sent to the client web browser.
* </p>
* @author Howard Lewis Ship
*/
public interface IRequestCycle
{
/**
* Invoked after the request cycle is no longer needed, to release any resources it may have.
* This includes releasing any loaded pages back to the page source.
*/
void cleanup();
/**
* Passes the String through
* {@link javax.servlet.http.HttpServletResponse#encodeURL(java.lang.String)}, which ensures
* that the session id is encoded in the URL (if necessary).
*
* @param URL The url to encode.
* @return The encoded form of the url.
*/
String encodeURL(String URL);
/**
* Returns the engine which is processing this request cycle.
*
* @return The engine.
*/
IEngine getEngine();
/**
* Retrieves a previously stored attribute, returning null if not found. Attributes allow
* components to locate each other; primarily they allow a wrapped component to locate a
* component which wraps it. Attributes are cleared at the end of the render (or rewind).
*
* @param name The name of the attribute to retrieve.
* @return The matching attribute with the specified name, or null if none found.
*/
Object getAttribute(String name);
/**
* Identifies the active page, the page which will ultimately render the response.
*
* @return The active page.
*/
IPage getPage();
/**
* Returns the page with the given name. If the page has been previously loaded in the current
* request cycle, that page is returned. Otherwise, the engine's page loader is used to load the
* page.
*
* @param name The page to get a reference to.
* @return The page instance.
*
* @throws PageNotFoundException
* if the page does not exist.
*
* @see org.apache.tapestry.engine.IPageSource#getPage(IRequestCycle, String)
*/
IPage getPage(String name);
/**
* Returns true if the context is being used to rewind a prior state of the page. This is only
* true when there is a target action id.
*
* @return True if rewinding a form, false otherwise.
*/
boolean isRewinding();
/**
* Checks to see if the current action id matches the target action id. Returns true only if
* they match. Returns false if there is no target action id (that is, during page rendering).
* <p>
* If theres a match on action id, then the component is compared against the target component.
* If there's a mismatch then a {@link StaleLinkException}is thrown.
*
* @param component The component to check.
* @return True if the specified component has been rewound.
*/
boolean isRewound(IComponent component);
/**
* Sets the {@link ResponseBuilder} to use for this response, don't
* try setting this unless you're very sure you know what you are doing as
* this isn't the only way that it is used. (ie replacing this builder won't
* necessarily override another builder being used already)
*
* @param builder The response builder that may be used by components
* to help with delegate/sub component rendering.
*/
void setResponseBuilder(ResponseBuilder builder);
/**
* Entry point for getting the response builder used to build
* this response.
* @return The response builder used for this response.
*/
ResponseBuilder getResponseBuilder();
/**
* Tests if the render component chain is empty, meaning no components have
* been loaded onto the stack yet.
*
* @return True, if the current stack is empty.
*/
boolean renderStackEmpty();
/**
* Looks at the object at the top of the render stack without removing
* the {@link IRender} from the stack.
*
* @return The last (parent) item added to the current render stack.
*/
IRender renderStackPeek();
/**
* Removes the {@link IRender} at the top of the stack, if any.
*
* @return The removed {@link IRender}, if any.
*/
IRender renderStackPop();
/**
* Pushes the specified render onto the current render stack.
*
* @param render The {@link IRender} object being pushed.
* @return The added {@link IRender}.
*/
IRender renderStackPush(IRender render);
/**
* Returns the 1-based position where an object is on this stack. If the object
* o occurs as an item in this stack, this method returns the distance from the
* top of the stack of the occurrence nearest the top of the stack; the topmost
* item on the stack is considered to be at distance 1. The equals method is used
* to compare o to the items in this stack.
*
* @param render The {@link IRender} being searched for.
*
* @return the 1-based position from the top of the stack where the object is
* located; the return value -1 indicates that the object is not on the stack.
*/
int renderStackSearch(IRender render);
/**
* Creates a traversable iterator for moving through the stack.
*
* @return An iterator over the current stack.
*/
Iterator renderStackIterator();
/**
* Removes a previously stored attribute, if one with the given name exists.
*
* @param name The key name of the attribute to remove.
*/
void removeAttribute(String name);
/**
* Renders the given page. Applications should always use this method to render the page, rather
* than directly invoking {@link IPage#render(IMarkupWriter, IRequestCycle)}since the request
* cycle must perform some setup before rendering.
*
* @param builder Renders the currently active page using the specified builder.
*/
void renderPage(ResponseBuilder builder);
/**
* Allows a temporary object to be stored in the request cycle, which allows otherwise unrelated
* objects to communicate. This is similar to <code>HttpServletRequest.setAttribute()</code>,
* except that values can be changed and removed as well.
* <p>
* This is used by components to locate each other. A component, such as
* {@link org.apache.tapestry.html.Body}, will write itself under a well-known name into the
* request cycle, and components it wraps can locate it by that name.
* <p>
* Attributes are cleared at the end of each render or rewind phase.
*
* @param name Key name of the attribute to store.
* @param value Value of the attribute.
*/
void setAttribute(String name, Object value);
/**
* Invoked just before rendering the response page to get all
* {@link org.apache.tapestry.engine.IPageRecorder page recorders}touched in this request cycle
* to commit their changes (save them to persistant storage).
*
* @see org.apache.tapestry.engine.IPageRecorder#commit()
*/
void commitPageChanges();
/**
* Returns the service which initiated this request cycle.
*
* @return The service associated with current request.
* @since 1.0.1
*/
IEngineService getService();
/**
* Used by {@link IForm forms}to perform a <em>partial</em> rewind so as to respond to the
* form submission (using the direct service).
*
* @param form The form to rewind.
*
* @since 1.0.2
*/
void rewindForm(IForm form);
/**
* Sets client side form focus off globally for all forms in this request cycle.
*/
void disableFocus();
/**
* Check for global focus being disabled.
* @return True if focus is disabled, false otherwise.
*/
boolean isFocusDisabled();
/**
* Invoked by a {@link IEngineService service} to store an array of application-specific
* parameters. These can later be retrieved (typically, by an application-specific listener
* method) by invoking {@link #getListenerParameters()}.
*
* @param parameters The parameters to set which will be available as method parameters
* to any listeners invoked in this request.
* @see org.apache.tapestry.engine.DirectService
* @since 4.0
*/
void setListenerParameters(Object[] parameters);
/**
* Returns parameters previously stored by {@link #setListenerParameters(Object[])}.
*
* @return The current set of bound listener parameters for the current service.
* @since 4.0
*/
Object[] getListenerParameters();
/**
* A convienience for invoking {@link #activate(IPage)}. Invokes {@link #getPage(String)}to
* get an instance of the named page.
*
* @param name The name of the page to activate.
* @since 3.0
*/
void activate(String name);
/**
* Sets the active page for the request. The active page is the page which will ultimately
* render the response. The activate page is typically set by the {@link IEngineService service}.
* Frequently, the active page is changed (from a listener method) to choose an alternate page
* to render the response).
* <p>
* {@link IPage#validate(IRequestCycle)}is invoked on the page to be activated.
* {@link PageRedirectException}is caught and the page specified in the exception will be the
* active page instead (that is, a page may "pass the baton" to another page using the
* exception). The new page is also validated. This continues until a page does not throw
* {@link PageRedirectException}.
* <p>
* Validation loops can occur, where page A redirects to page B and then page B redirects back
* to page A (possibly with intermediate steps). This is detected and results in an
* {@link ApplicationRuntimeException}.
*
* @param page The page to activate.
*
* @since 3.0
*/
void activate(IPage page);
/**
* Returns a query parameter value, or null if not provided in the request. If multiple values
* are provided, returns the first value.
*
* @param name The name of the request parameter to retrieve.
* @return The value matching the specified parameter name, or null if none found.
* @since 4.0
*/
String getParameter(String name);
/**
* Returns all query parameter values for the given name. Returns null if no values were
* provided.
*
* @param name The name of the parameters to retrieve.
* @return The matching multi value array for the specified name, or null if none found.
* @since 4.0
*/
String[] getParameters(String name);
/**
* Converts a partial URL into an absolute URL. Prefixes the provided URL with servlet context
* path (if any), then expands it to a full URL by prepending with the scheme, server and port
* (determined from the current {@link org.apache.tapestry.web.WebRequest request}.
*
* @param partialURL The url to modify into an absolute url.
* @return The converted absolute url representation of the specified partialURL.
* @since 4.0
*/
String getAbsoluteURL(String partialURL);
/**
* Forgets any stored changes to the specified page. If the page has already been loaded (and
* rolled back) then the loaded page instance is not affected; if the page is only loaded
* subsequently, the page instance will not see any persisted property changes.
*
* @param name The name of the page instance to throw all persistent properties away for.
* @since 4.0
*/
void forgetPage(String name);
/**
* Returns the central {@link org.apache.tapestry.services.Infrastructure} object used to
* manage the processing of the request.
*
* @return The {@link Infrastructure} object associated with this request.
* @since 4.0
*/
Infrastructure getInfrastructure();
/**
* Returns the provided string, possibly modified (with an appended suffix) to make it unique.
*
* @param baseId
* the base id from which to generate the unique string.
* @return baseId, or baseId with a suffix appended (if the method has been previously invoked
* with the same baseId).
*/
String getUniqueId(String baseId);
/**
* Returns what <i>will</i> be the next unique id generated based on the given input, but doesn't
* store the result.
*
* @param baseId
* the base id from which to generate the unique string.
* @return baseId, or baseId with a suffix appended (if the method has been previously invoked
* with the same baseId).
*/
String peekUniqueId(String baseId);
/**
* Sends a redirect to the client web browser. This is currently a convinience for constructing
* and throwing a {@link RedirectException}, but may change in a later release.
*
* @param URL The url to send a client redirect for.
* @since 4.0
* @throws RedirectException
*/
void sendRedirect(String URL);
/**
* Encodes the current state of all allocated component ids (using {@link org.apache.tapestry.util.IdAllocator})
* to a String value that can be embedded in URLs or forms.
*
* <p>
* This method is used primarily by the {@link org.apache.tapestry.form.Form} component to encode the state
* of the current ids allocated so as to maintain consistent state during rewind - especially in cases where
* multiple form components are rendered in a page.
* </p>
*
* @return The encoded state, which can be used to re-initialize a request to the same ID state
* by invoking {@link #initializeIdState(String)}.
*/
String encodeIdState();
/**
* Used in conjunction with {@link #encodeIdState()} to re-initialize the internal id allocation state
* of a request during a form rewind.
*
* @param encodedSeed The value returned from a previous invocation of {@link #encodeIdState()} .
*/
void initializeIdState(String encodedSeed);
}
The table below shows all metrics for IRequestCycle.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 343.00 | Comment lines | |
| COMMENT_DENSITY | 7.62 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 38.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 52.00 | Comments in declarations | |
| DOC_COMMENT | 330.00 | Number of javadoc comment lines | |
| ELOC | 45.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 38.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 12.43 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 23.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.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 | 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 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 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 | 454.00 | Number of lines in the source file | |
| LINE_COMMENT | 13.00 | Number of line comments | |
| LOC | 47.00 | Lines of code | |
| LOGICAL_LINES | 44.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 129.00 | Number of operands | |
| OPERATORS | 175.00 | Number of operators | |
| PARAMS | 23.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 304.00 | Halstead program length | |
| PROGRAM_VOCAB | 99.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 16624.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 83.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 16.00 | Number of unique operators | |
| WHITESPACE | 64.00 | Number of whitespace lines | |