P4.java
| Index Score | ||
|---|---|---|
 |
 |
net.sourceforge.cruisecontrol.sourcecontrols |
 |
 |
CruiseControl |
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 | |
|---|---|---|
| RETURNS | Number of return points from functions |  |
| EXITS | Procedure exits | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| LOGICAL_LINES | Number of statements | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| OPERATORS | Number of operators | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| ELOC | Effective lines of code | |
| BLOCKS | Number of blocks | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOC | Lines of code | |
| FUNCTIONS | Number of function declarations | |
| LINES | Number of lines in the source file | |
| JAVA0077 | JAVA0077 Private field not used in declaring class | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| LOOPS | Number of loops | |
| COMPARISONS | Number of comparison operators | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0137 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/********************************************************************************
* CruiseControl, a Continuous Integration Toolkit
* Copyright (c) 2001-2003, ThoughtWorks, Inc.
* 200 E. Randolph, 25th Floor
* Chicago, IL 60601 USA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* + Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* + Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************/
package net.sourceforge.cruisecontrol.sourcecontrols;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.StringTokenizer;
import net.sourceforge.cruisecontrol.CruiseControlException;
import net.sourceforge.cruisecontrol.Modification;
import net.sourceforge.cruisecontrol.SourceControl;
import net.sourceforge.cruisecontrol.util.CommandExecutor;
import net.sourceforge.cruisecontrol.util.Commandline;
import net.sourceforge.cruisecontrol.util.DiscardConsumer;
import net.sourceforge.cruisecontrol.util.IO;
import net.sourceforge.cruisecontrol.util.StreamConsumer;
import net.sourceforge.cruisecontrol.util.StreamLogger;
import net.sourceforge.cruisecontrol.util.StreamPumper;
import net.sourceforge.cruisecontrol.util.Util;
import net.sourceforge.cruisecontrol.util.ValidationHelper;
import org.apache.log4j.Logger;
import org.jdom.Element;
/**
* This class implements the SourceControlElement methods for a P4 depot. The call to CVS is assumed to work without any
* setup. This implies that if the authentication type is pserver the call to cvs login should be done prior to calling
* this class. <p/> P4Element depends on the optional P4 package delivered with Ant v1.3. But since it probably doesn't
* make much sense using the P4Element without other P4 support it shouldn't be a problem. <p/> P4Element sets the
* property ${p4element.change} with the latest changelist number or the changelist with the latest date. This should
* then be passed into p4sync or other p4 commands.
*
* @author <a href="mailto:niclas.olofsson@ismobile.com">Niclas Olofsson - isMobile.com</a>
* @author <a href="mailto:jcyip@thoughtworks.com">Jason Yip</a>
* @author Tim McCune
* @author J D Glanville
* @author Patrick Conant Copyright (c) 2005 Hewlett-Packard Development Company, L.P.
* @author John Lussmyer
*/
public class P4 implements SourceControl {
private static final Logger LOG = Logger.getLogger(P4.class);
private String p4Port;
private String p4Client;
private String p4User;
private String p4View;
private String p4Passwd;
private boolean correctForServerTime = true;
private boolean useP4Email = true;
private final SimpleDateFormat p4RevisionDateFormatter = new SimpleDateFormat("yyyy/MM/dd:HH:mm:ss");
private final SourceControlProperties properties = new SourceControlProperties();
private static final String SERVER_DATE = "Server date: ";
private static final String P4_SERVER_DATE_FORMAT = "yyyy/MM/dd HH:mm:ss";
public void setPort(String p4Port) {
this.p4Port = p4Port;
}
public void setClient(String p4Client) {
this.p4Client = p4Client;
}
public void setUser(String p4User) {
this.p4User = p4User;
}
public void setView(String p4View) {
this.p4View = p4View;
}
public void setPasswd(String p4Passwd) {
this.p4Passwd = p4Passwd;
}
/**
* Indicates whether to correct for time differences between the p4 server and the CruiseControl server. Setting the
* flag to "true" will correct for both time zone differences and for non-synchronized system clocks.
*/
public void setCorrectForServerTime(boolean flag) {
correctForServerTime = flag;
}
/**
* Sets if the Email address for the user should be retrieved from Perforce.
*
* @param flag
* true to retrieve email addresses from perforce.
*/
public void setUseP4Email(boolean flag) {
useP4Email = flag;
}
public void setProperty(String propertyName) {
properties.assignPropertyName(propertyName);
}
public Map getProperties() {
return properties.getPropertiesAndReset();
}
public void validate() throws CruiseControlException {
ValidationHelper.assertIsSet(p4Port, "port", this.getClass());
ValidationHelper.assertIsSet(p4Client, "client", this.getClass());
ValidationHelper.assertIsSet(p4User, "user", this.getClass());
ValidationHelper.assertIsSet(p4View, "view", this.getClass());
ValidationHelper.assertNotEmpty(p4Passwd, "passwd", this.getClass());
}
/**
* Get a List of modifications detailing all the changes between now and the last build. Return this as an element.
* It is not necessary for sourcecontrols to actually do anything other than returning a chunk of XML data back.
*
* @param lastBuild
* time of last build
* @param now
* time this build started
* @return a list of XML elements that contains data about the modifications that took place. If no changes, this
* method returns an empty list.
*/
public List getModifications(Date lastBuild, Date now) {
List mods = new ArrayList();
try {
String[] changelistNumbers = collectChangelistSinceLastBuild(lastBuild, now);
if (changelistNumbers.length == 0) {
return mods;
}
mods = describeAllChangelistsAndBuildOutput(changelistNumbers);
} catch (Exception e) {
LOG.error("Log command failed to execute succesfully", e);
}
if (!mods.isEmpty()) {
properties.modificationFound();
}
return mods;
}
private List describeAllChangelistsAndBuildOutput(String[] changelistNumbers) throws Exception {
Commandline command = buildDescribeCommand(changelistNumbers);
LOG.debug(command.toString());
Process p = command.execute();
Thread error = logErrorStream(p.getErrorStream());
InputStream p4Stream = p.getInputStream();
List mods = parseChangeDescriptions(p4Stream);
getRidOfLeftoverData(p4Stream);
// Get the Email address of the user for each changelist
if ((mods.size() > 0) && useP4Email) {
getEmailAddresses(mods);
}
p.waitFor();
error.join();
IO.close(p);
return mods;
}
/**
* Get the Email Address of the users who submitted the change lists.
*
* @param mods
* List of P4Modification structures
* @throws IOException
* @throws InterruptedException
*/
private void getEmailAddresses(List mods) throws IOException, InterruptedException {
Iterator iter = mods.iterator();
Map users = new HashMap();
while (iter.hasNext()) {
P4Modification change = (P4Modification) iter.next();
if ((change.userName != null) && (change.userName.length() > 0)) {
change.emailAddress = (String) users.get(change.userName);
if (change.emailAddress == null) {
change.emailAddress = getUserEmailAddress(change.userName);
users.put(change.userName, change.emailAddress);
}
}
}
}
/**
* Get the Email Address for the given P4 User
*
* @param username
* Perforce user name
* @return User Email address if available
* @throws IOException
* @throws InterruptedException
*/
private String getUserEmailAddress(String username) throws IOException, InterruptedException {
String emailaddr = null;
Commandline command = buildUserCommand(username);
LOG.debug(command.toString());
Process p = command.execute();
logErrorStream(p.getErrorStream());
InputStream p4Stream = p.getInputStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(p4Stream));
// Find first Changelist item if there is one.
String line;
while ((line = readToNotPast(reader, "info: Email:", "I really don't care")) != null) {
StringTokenizer st = new StringTokenizer(line);
try {
st.nextToken(); // skip 'info:' text
st.nextToken(); // skip 'Email:' text
emailaddr = st.nextToken();
} catch (NoSuchElementException ex) {
// No email address given
}
}
getRidOfLeftoverData(p4Stream);
p.waitFor();
IO.close(p);
return (emailaddr);
}
private String[] collectChangelistSinceLastBuild(Date lastBuild, Date now) throws Exception {
Commandline command = buildChangesCommand(lastBuild, now, Util.isWindows());
LOG.debug(command.toString());
Process p = command.execute();
Thread error = logErrorStream(p.getErrorStream());
InputStream p4Stream = p.getInputStream();
String[] changelistNumbers = parseChangelistNumbers(p4Stream);
p.waitFor();
error.join();
IO.close(p);
return changelistNumbers;
}
private void getRidOfLeftoverData(InputStream stream) {
new StreamPumper(stream, new DiscardConsumer()).run();
}
protected String[] parseChangelistNumbers(InputStream is) throws IOException {
ArrayList changelists = new ArrayList();
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
String line;
while ((line = reader.readLine()) != null) {
if (line.startsWith("error:")) {
throw new IOException("Error reading P4 stream: P4 says: " + line);
} else if (line.startsWith("exit: 1")) {
throw new IOException("Error reading P4 stream: P4 says: " + line);
} else if (line.startsWith("exit: 0")) {
break;
} else if (line.startsWith("info:")) {
StringTokenizer st = new StringTokenizer(line);
st.nextToken(); // skip 'info:' text
st.nextToken(); // skip 'Change' text
changelists.add(st.nextToken());
}
}
if (line == null) {
throw new IOException("Error reading P4 stream: Unexpected EOF reached");
}
String[] changelistNumbers = new String[0];
return (String[]) changelists.toArray(changelistNumbers);
}
protected List parseChangeDescriptions(InputStream is) throws Exception {
int serverOffset = 0;
if (correctForServerTime) {
serverOffset = (int) calculateServerTimeOffset();
}
ArrayList changelists = new ArrayList();
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
// Find first Changelist item if there is one.
String line;
while ((line = readToNotPast(reader, "text: Change", "exit:")) != null) {
P4Modification changelist = new P4Modification();
if (line.startsWith("error:")) {
throw new IOException("Error reading P4 stream: P4 says: " + line);
} else if (line.startsWith("exit: 1")) {
throw new IOException("Error reading P4 stream: P4 says: " + line);
} else if (line.startsWith("exit: 0")) {
return changelists;
} else if (line.startsWith("text: Change")) {
StringTokenizer st = new StringTokenizer(line);
st.nextToken(); // skip 'text:' text
st.nextToken(); // skip 'Change' text
changelist.revision = st.nextToken();
st.nextToken(); // skip 'by' text
// split user@client
StringTokenizer st2 = new StringTokenizer(st.nextToken(), "@");
changelist.userName = st2.nextToken();
changelist.client = st2.nextToken();
st.nextToken(); // skip 'on' text
String date = st.nextToken() + ":" + st.nextToken();
try {
Calendar cal = Calendar.getInstance();
cal.setTime(p4RevisionDateFormatter.parse(date));
cal.add(Calendar.MILLISECOND, -serverOffset);
changelist.modifiedTime = cal.getTime();
} catch (ParseException xcp) {
changelist.modifiedTime = new Date();
}
}
reader.readLine(); // get past a 'text:'
StringBuffer descriptionBuffer = new StringBuffer();
// Use this since we don't want the final (empty) line
String previousLine = null;
line = reader.readLine();
while (line != null && line.startsWith("text:") && !line.startsWith("text: Affected files ...")) {
if (previousLine != null) {
if (descriptionBuffer.length() > 0) {
descriptionBuffer.append('\n');
}
descriptionBuffer.append(previousLine);
}
try {
previousLine = line.substring(5).trim();
} catch (Exception e) {
LOG.error("Error parsing Perforce description, line that caused problem was: [" + line + "]");
}
line = reader.readLine();
}
changelist.comment = descriptionBuffer.toString();
// Ok, read affected files if there are any.
if (line != null) {
reader.readLine(); // read past next 'text:'
line = readToNotPast(reader, "info1:", "text:");
while (line != null && line.startsWith("info1:")) {
String fileName = line.substring(7, line.lastIndexOf("#"));
Modification.ModifiedFile affectedFile = changelist.createModifiedFile(fileName, null);
affectedFile.action = line.substring(line.lastIndexOf(" ") + 1);
affectedFile.revision = line.substring(line.lastIndexOf("#") + 1, line.lastIndexOf(" "));
line = readToNotPast(reader, "info1:", "text:");
}
}
changelists.add(changelist);
}
return changelists;
}
private Thread logErrorStream(InputStream is) {
Thread errorThread = new Thread(StreamLogger.getWarnPumper(LOG, is));
errorThread.start();
return errorThread;
}
/**
* p4 -s [-c client] [-p port] [-u user] changes -s submitted [view@lastBuildTime@now]
*
* @throws CruiseControlException
*/
public Commandline buildChangesCommand(Date lastBuildTime, Date now, boolean isWindows)
throws CruiseControlException {
// If the Perforce server time is different from the CruiseControl
// server time, correct the parameter dates for the difference.
if (correctForServerTime) {
int offset = (int) calculateServerTimeOffset();
Calendar cal = Calendar.getInstance();
cal.setTime(lastBuildTime);
cal.add(Calendar.MILLISECOND, offset);
lastBuildTime = cal.getTime();
cal.setTime(now);
cal.add(Calendar.MILLISECOND, offset);
now = cal.getTime();
} else {
LOG.debug("No server time offset determined.");
}
Commandline commandLine = buildBaseP4Command();
commandLine.createArgument("changes");
commandLine.createArguments("-s", "submitted");
commandLine.createArgument(p4View + "@" + p4RevisionDateFormatter.format(lastBuildTime) + ",@"
+ p4RevisionDateFormatter.format(now));
return commandLine;
}
/**
* p4 -s [-c client] [-p port] [-u user] describe -s [change number]
*/
public Commandline buildDescribeCommand(String[] changelistNumbers) {
Commandline commandLine = buildBaseP4Command();
// execP4Command("describe -s " + changeNumber.toString(),
commandLine.createArgument("describe");
commandLine.createArgument("-s");
for (int i = 0; i < changelistNumbers.length; i++) {
commandLine.createArgument(changelistNumbers[i]);
}
return commandLine;
}
/**
* p4 -s [-c client] [-p port] [-u user] user -o [username]
*/
public Commandline buildUserCommand(String username) {
Commandline commandLine = buildBaseP4Command();
commandLine.createArgument("user");
commandLine.createArguments("-o", username);
return commandLine;
}
/**
* Calculate the difference in time between the Perforce server and the CruiseControl server. A negative time
* difference indicates that the Perforce server time is later than CruiseControl server (e.g. Perforce in New York,
* CruiseControl in San Francisco). A positive offset indicates that the Perforce server time is before the
* CruiseControl server.
*
* @throws CruiseControlException
*/
protected long calculateServerTimeOffset() throws CruiseControlException {
ServerInfoConsumer serverInfo = new ServerInfoConsumer();
CommandExecutor executor = new CommandExecutor(buildInfoCommand());
executor.logErrorStreamTo(LOG);
executor.setOutputConsumer(serverInfo);
executor.executeAndWait();
return serverInfo.getOffset();
}
Commandline buildInfoCommand() {
Commandline command = buildBaseP4Command(false);
command.createArgument("info");
return command;
}
private Commandline buildBaseP4Command() {
boolean prependField = true;
return buildBaseP4Command(prependField);
}
private Commandline buildBaseP4Command(boolean prependField) {
Commandline commandLine = new Commandline();
commandLine.setExecutable("p4");
if (prependField) {
commandLine.createArgument("-s");
}
if (p4Client != null) {
commandLine.createArguments("-c", p4Client);
}
if (p4Port != null) {
commandLine.createArguments("-p", p4Port);
}
if (p4User != null) {
commandLine.createArguments("-u", p4User);
}
if (p4Passwd != null) {
commandLine.createArguments("-P", p4Passwd);
}
return commandLine;
}
/**
* This is a modified version of the one in the CVS element. I found it far more useful if you actually return
* either or, because otherwise it would be darn hard to use in places where I actually need the notPast line. Or
* did I misunderstand something?
*/
private String readToNotPast(BufferedReader reader, String beginsWith, String notPast) throws IOException {
String nextLine = reader.readLine();
// (!A && !B) || (!A && !C) || (!B && !C)
// !A || !B || !C
while (!(nextLine == null || nextLine.startsWith(beginsWith) || nextLine.startsWith(notPast))) {
nextLine = reader.readLine();
}
return nextLine;
}
private static class P4Modification extends Modification {
public String client;
public int compareTo(Object o) {
P4Modification modification = (P4Modification) o;
return getChangelistNumber() - modification.getChangelistNumber();
}
public boolean equals(Object o) {
if (o == null || !(o instanceof P4Modification)) {
return false;
}
P4Modification modification = (P4Modification) o;
return getChangelistNumber() == modification.getChangelistNumber();
}
public int hashCode() {
return getChangelistNumber();
}
private int getChangelistNumber() {
return Integer.parseInt(revision);
}
P4Modification() {
super("p4");
}
public Element toElement(DateFormat format) {
Element element = super.toElement(format);
LOG.debug("client = " + client);
Element clientElement = new Element("client");
clientElement.addContent(client);
element.addContent(clientElement);
return element;
}
}
static String getQuoteChar(boolean isWindows) {
return isWindows ? "\"" : "'";
}
protected static class ServerInfoConsumer implements StreamConsumer {
private boolean found;
private long offset;
private final SimpleDateFormat p4ServerDateFormatter = new SimpleDateFormat(P4_SERVER_DATE_FORMAT);
private Date ccServerTime = new Date();
public void consumeLine(String line) {
Date p4ServerTime;
// Consume the full stream after we have found the offset
if (found) {
return;
}
if (line.startsWith(SERVER_DATE)) {
try {
String dateString = line.substring(SERVER_DATE.length(), SERVER_DATE.length()
+ P4_SERVER_DATE_FORMAT.length());
p4ServerTime = p4ServerDateFormatter.parse(dateString);
offset = p4ServerTime.getTime() - ccServerTime.getTime();
found = true;
} catch (ParseException pe) {
LOG.error("Unable to parse p4 server time from line \'" + line + "\'. " + pe.getMessage()
+ "; Proceeding without time offset.");
}
}
}
public long getOffset() {
LOG.info("Perforce server time offset: " + offset + " ms");
return offset;
}
}
}
The table below shows all metrics for P4.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 82.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 126.00 | Comment lines | |
| COMMENT_DENSITY | 0.38 | Comment density | |
| COMPARISONS | 51.00 | Number of comparison operators | |
| CYCLOMATIC | 85.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 12.00 | Comments in declarations | |
| DOC_COMMENT | 113.00 | Number of javadoc comment lines | |
| ELOC | 332.00 | Effective lines of code | |
| EXEC_COMMENTS | 11.00 | Comments in executable code | |
| EXITS | 83.00 | Procedure exits | |
| FUNCTIONS | 36.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 81.61 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 113.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 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 1.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 | 2.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 | 9.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 5.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 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 9.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 | 3.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 | 2.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 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 1.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 | 4.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 | 2.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 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 638.00 | Number of lines in the source file | |
| LINE_COMMENT | 13.00 | Number of line comments | |
| LOC | 404.00 | Lines of code | |
| LOGICAL_LINES | 244.00 | Number of statements | |
| LOOPS | 8.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1044.00 | Number of operands | |
| OPERATORS | 1836.00 | Number of operators | |
| PARAMS | 33.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2880.00 | Halstead program length | |
| PROGRAM_VOCAB | 392.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 80.00 | Number of return points from functions | |
| SIZE | 23777.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 339.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 53.00 | Number of unique operators | |
| WHITESPACE | 108.00 | Number of whitespace lines | |