PropertyHelper.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.slide.webdav.util |
 |
 |
Jakarta Slide |
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 | |
|---|---|---|
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' |  |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PARAMS | Number of formal parameter declarations | |
| RETURNS | Number of return points from functions | |
| SIZE | Size of the file in bytes | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| EXITS | Procedure exits | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| COMMENTS | Comment lines | |
| UNIQUE_OPERANDS | Number of unique operands | |
| DECL_COMMENTS | Comments in declarations | |
| OPERANDS | Number of operands | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LINES | Number of lines in the source file | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| OPERATORS | Number of operators | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LOOPS | Number of loops | |
| CYCLOMATIC | Cyclomatic complexity | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| JAVA0265 | JAVA0265 Use of Throwable.printStackTrace() | |
| BLOCKS | Number of blocks | |
| LOC | Lines of code | |
| FUNCTIONS | Number of function declarations | |
| JAVA0036 | JAVA0036 Missing braces in while statement | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| COMPARISONS | Number of comparison operators | |
| LINE_COMMENT | Number of line comments | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* $Header$
* $Revision: 208476 $
* $Date: 2005-02-02 06:33:36 -0500 (Wed, 02 Feb 2005) $
*
* ====================================================================
*
* Copyright 1999-2002 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.slide.webdav.util;
import java.io.IOException;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.slide.common.NamespaceAccessToken;
import org.apache.slide.common.PropertyName;
import org.apache.slide.common.SlideException;
import org.apache.slide.common.SlideToken;
import org.apache.slide.content.Content;
import org.apache.slide.content.NodeProperty;
import org.apache.slide.content.NodeRevisionDescriptor;
import org.apache.slide.content.NodeRevisionDescriptors;
import org.apache.slide.content.NodeRevisionNumber;
import org.apache.slide.content.NodeProperty.NamespaceCache;
import org.apache.slide.lock.NodeLock;
import org.apache.slide.util.XMLValue;
import org.apache.slide.webdav.WebdavServletConfig;
import org.apache.slide.webdav.util.properties.LockDiscoveryProperty;
import org.apache.slide.webdav.util.properties.PropertyComputer;
import org.apache.slide.webdav.util.properties.PropertyDefaultProvider;
import org.apache.slide.webdav.util.resourcekind.AbstractResourceKind;
import org.apache.slide.webdav.util.resourcekind.ResourceKind;
import org.apache.slide.webdav.util.resourcekind.ResourceKindManager;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
/**
* Helper class for handling WebDAV properties.
*
*/
public class PropertyHelper extends AbstractWebdavHelper implements DeltavConstants, AclConstants, DaslConstants, BindConstants {
public final static String LOCKDISCOVERY_INCL_PRINCIPAL =
"lockdiscoveryIncludesPrincipalURL";
public final static String PRIVILEGE_NAMESPACE = "privilege-namespace";
private WebdavServletConfig sConf = null;
private WebdavContext webdavContext = null;
/**
* Factory method.
* @deprecated
*/
public static PropertyHelper getPropertyHelper( SlideToken sToken, NamespaceAccessToken nsaToken) {
return new PropertyHelper( sToken, nsaToken, (WebdavServletConfig)null );
}
/**
* Factory method.
*/
public static PropertyHelper getPropertyHelper( SlideToken sToken, NamespaceAccessToken nsaToken, WebdavServletConfig sConf ) {
return new PropertyHelper( sToken, nsaToken, sConf );
}
public static PropertyHelper getPropertyHelper( SlideToken sToken, NamespaceAccessToken nsaToken, WebdavContext webdavContext ) {
return new PropertyHelper( sToken, nsaToken, webdavContext );
}
/**
* Protected contructor
*/
protected PropertyHelper( SlideToken sToken, NamespaceAccessToken nsaToken, WebdavServletConfig sConf ) {
super( sToken, nsaToken );
this.sConf = sConf;
}
protected PropertyHelper( SlideToken sToken, NamespaceAccessToken nsaToken, WebdavContext webdavContext) {
super( sToken, nsaToken );
this.webdavContext = webdavContext;
this.sConf = webdavContext.getServletConfig();
}
/**
* Create initial default properties to be stored for the specified
* resource kind.
* The result set does not contain transient properties.
* @post result != null
* @return a list of initial non-transient properties (empty list if none)
*/
public List createInitialProperties(ResourceKind resourceKind, String resourcePath) {
List result = new ArrayList();
for(Iterator i = resourceKind.getDefaultProviders().values().iterator(); i.hasNext();) {
PropertyDefaultProvider provider = (PropertyDefaultProvider)i.next();
Object defaultValue = provider.createDefaultValue(this.nsaToken,
this.sToken, resourceKind, resourcePath);
if (defaultValue != null) {
result.add(new NodeProperty(provider.getPropertyName(),
defaultValue));
}
}
return result;
}
/**
* Create CDATA value.
*/
public Object createCdataValue( String text ) {
StringBuffer b = new StringBuffer();
if( text == null )
text = "";
b.append( "![CDATA[" ).append( text ).append( "]]" );
return b.toString();
}
/**
* Create href value.
*/
public Object createHrefValue( String uri ) {
String result = "";
Element href = new Element( E_HREF, DNSP );
href.addContent( uri );
try {
result = xmlOut.outputString( href );
}
catch( Exception x ) {
x.printStackTrace();
}
return result;
}
/**
* Create href set value.
*/
public Object createHrefSetValue( List uriList ) {
StringBuffer b = new StringBuffer();
Iterator i = uriList.iterator();
while( i.hasNext() )
b.append( createHrefValue((String)i.next()) );
return b.toString();
}
/**
* Create href set value.
*/
public Object createHrefSetValue( String rootElement, List uriList ) {
String result = "";
Element root = new Element( rootElement, DNSP );
Iterator i = uriList.iterator();
while( i.hasNext() ) {
Element href = new Element( E_HREF, DNSP );
href.addContent( (String)i.next() );
root.addContent( href );
}
try {
result = xmlOut.outputString( root );
}
catch( Exception x ) {
x.printStackTrace();
}
return result;
}
/**
* Parse an XML-Valued property value.
*/
public Element parsePropertyValue( String propValue ) throws JDOMException, IOException {
Document d = xmlBuilder.build( new StringReader(propValue) );
return d.getRootElement();
}
/**
* Returns the property of a resource described by the resourcePath.
* @deprecated use {@link #getProperty(PropertyName, String, String)}
*/
public NodeProperty getProperty(String propertyName, String resourcePath,
String slideContextPath)
throws SlideException, JDOMException {
return getProperty(PropertyName.getPropertyName(propertyName),
resourcePath, slideContextPath);
}
/**
* Returns the property of a resource described by the resourcePath.
*
* @param propertyName the name of the property.
* @param resourcePath the path that identifies the resource.
* @param slideContextPath a String, path representing the full context of the WebDAV-Servlet.
* @return the property.
* @throws SlideException
* @throws JDOMException
*/
public NodeProperty getProperty(PropertyName propertyName,
String resourcePath, String slideContextPath)
throws SlideException, JDOMException {
UriHandler uriHandler = UriHandler.getUriHandler(resourcePath);
String uri = null;
NodeRevisionDescriptors revisionDescriptors = null;
NodeRevisionDescriptor revisionDescriptor = null;
Content contentHelper = nsaToken.getContentHelper();
if (uriHandler.isVersionUri()) {
uri = uriHandler.getAssociatedHistoryUri();
NodeRevisionNumber revisionNumber = new NodeRevisionNumber(uriHandler.getVersionName());
revisionDescriptors = contentHelper.retrieve(sToken, uri);
revisionDescriptor = contentHelper.retrieve(sToken, revisionDescriptors, revisionNumber);
}
else if (uriHandler.isHistoryUri()) {
uri = uriHandler.getAssociatedHistoryUri();
NodeRevisionNumber revisionNumber = new NodeRevisionNumber("0.0");
revisionDescriptors = contentHelper.retrieve(sToken, uri);
revisionDescriptor = contentHelper.retrieve(sToken, revisionDescriptors, revisionNumber);
}
else {
uri = resourcePath;
revisionDescriptors = contentHelper.retrieve(sToken, uri);
revisionDescriptor = contentHelper.retrieve(sToken, revisionDescriptors);
}
return getProperty(propertyName, revisionDescriptors, revisionDescriptor, slideContextPath);
}
/**
* Returns the property of the resource described by
* the resourcePath.
*
* @param propertyName the name of the property.
* @param revisionDescriptors the NodeRevisionDescriptors of the resource.
* @param revisionDescriptor the NodeRevisionDescriptor of the resource.
*
* @return the property.
*
* @throws SlideException
* @throws JDOMException
* @deprecated use {@link #getProperty(String, NodeRevisionDescriptors, NodeRevisionDescriptor, String)}
*/
public NodeProperty getProperty(String propertyName,
NodeRevisionDescriptors revisionDescriptors,
NodeRevisionDescriptor revisionDescriptor)
throws SlideException, JDOMException {
return getProperty(propertyName, revisionDescriptors, revisionDescriptor, null);
}
/**
* Returns the property of a resource described by its descriptors.
* @deprecated use {@link #getProperty(PropertyName, NodeRevisionDescriptors, NodeRevisionDescriptor, String)}.
*/
public NodeProperty getProperty(String propertyName,
NodeRevisionDescriptors revisionDescriptors,
NodeRevisionDescriptor revisionDescriptor,
String slideContextPath) throws SlideException, JDOMException {
return getProperty(PropertyName.getPropertyName(propertyName),
revisionDescriptors, revisionDescriptor, slideContextPath);
}
/**
* Returns the property of a resource described by its descriptors.
*
* @param propertyName the name of the property.
* @param revisionDescriptors the NodeRevisionDescriptors of the resource.
* @param revisionDescriptor the NodeRevisionDescriptor of the resource.
* @param slideContextPath a String, representing the full context of the webdav servlet.
*
* @return the property.
*
* @throws SlideException
* @throws JDOMException
*/
public NodeProperty getProperty(PropertyName propertyName,
NodeRevisionDescriptors revisionDescriptors,
NodeRevisionDescriptor revisionDescriptor,
String slideContextPath)
throws SlideException, JDOMException
{
NodeProperty property = revisionDescriptor.getProperty(propertyName);
ResourceKind resourceKind = AbstractResourceKind.determineResourceKind(
nsaToken, revisionDescriptors, revisionDescriptor);
if (resourceKind.isSupportedLiveProperty(propertyName)) {
if (resourceKind.isComputedProperty(propertyName)) {
property = computeProperty(propertyName, revisionDescriptors, revisionDescriptor, slideContextPath);
}
}
return property;
}
/**
* Returns the computed property of the resource.
*
* @param propertyName the name of the property.
* @param revisionDescriptors the NodeRevisionDescriptors of the resource.
* @param revisionDescriptor the NodeRevisionDescriptor of the resource.
* @param contextPath a String , the result of HttpRequest.getContextPath()
* @param servletPath a String, the result of HttpRequest.getServletPath()
*
* @return the property.
*
* @throws SlideException
* @throws JDOMException
*/
public NodeProperty computeProperty(String propertyName,
NodeRevisionDescriptors revisionDescriptors,
NodeRevisionDescriptor revisionDescriptor,
String slideContextPath) throws SlideException, JDOMException
{
return computeProperty(PropertyName.getPropertyName(propertyName),
revisionDescriptors, revisionDescriptor, slideContextPath);
}
public NodeProperty computeProperty(PropertyName propertyName,
NodeRevisionDescriptors revisionDescriptors,
NodeRevisionDescriptor revisionDescriptor,
String slideContextPath) throws SlideException, JDOMException
{
ResourceKind resourceKind = ResourceKindManager.determineResourceKind(
this.nsaToken, revisionDescriptors, revisionDescriptor);
PropertyComputer definition = resourceKind.getPropertyComputer(propertyName);
if (this.webdavContext == null) {
this.webdavContext = WebdavContextImpl.create(this.sToken,
sConf, slideContextPath);
}
if (definition != null) {
Object value = definition.computeValue(this.nsaToken,
revisionDescriptors,
revisionDescriptor,
resourceKind,
this.webdavContext);
if (value != null) {
return new NodeProperty(definition.getPropertyName(), value);
} else {
return null; // TODO
}
}
throw new SlideException("Unknown property" + propertyName);
}
/**
** Returns a List of <code><exclude></code> elements containing the
** paths to exclude from the search since they does not contain
** version-controlled resources (e.g. the users path and the history paths) .
**
** @return a List of <code><exclude></code> elements.
**/
public List getNonVcrPathExcludeList() {
return getNonVcrPathExcludeList(this.nsaToken);
}
public static List getNonVcrPathExcludeList(NamespaceAccessToken nsaToken) {
List excludeList = new ArrayList();
String usersPath = truncateLeadingSlash(nsaToken.getNamespaceConfig().getUsersPath());
addExcludeElement(usersPath, excludeList);
String groupsPath = truncateLeadingSlash(nsaToken.getNamespaceConfig().getGroupsPath());
addExcludeElement(groupsPath, excludeList);
String rolesPath = truncateLeadingSlash(nsaToken.getNamespaceConfig().getRolesPath());
addExcludeElement(rolesPath, excludeList);
Iterator historyPathIterator = HistoryPathHandler.getHistoryPathHandler().getResolvedHistoryPaths().iterator();
while (historyPathIterator.hasNext()) {
String path = truncateLeadingSlash(historyPathIterator.next().toString());
addExcludeElement(path, excludeList);
}
return excludeList;
}
private static void addExcludeElement(String path, List excludeList) {
if (path != null && path.length() > 0) {
Element excludeElement = new Element(DaslConstants.E_EXCLUDE, NamespaceCache.SLIDE_NAMESPACE);
excludeElement.setText(path);
excludeList.add(excludeElement);
}
}
/**
* Returns an XMLValue containing the value of the <code><lockdiscovery></code>
* property.
*
* @param objectLockToken the NodeLock for which to compute the value
* @param servletPath a String, the result of HttpRequest.getServletPath()
* @param contextPath a String , the result of HttpRequest.getContextPath()
*
* @return the value of the <code><lockdiscovery></code> property.
*
*/
public XMLValue computeLockDiscovery(NodeLock objectLockToken, String slideContextPath) {
XMLValue xmlValue = new XMLValue();
//Element activelock = createActiveLockElement(objectLockToken, slideContextPath);
Element activelock = LockDiscoveryProperty.createActiveLockElement(
objectLockToken, nsaToken, sConf, slideContextPath);
if (activelock != null) {
xmlValue.add(activelock);
}
return xmlValue;
}
/**
* Returns the concatenation of <code>serverURL</code>, <code>contextPath</code>
* and <code>uri</code> and inserts all needed slashes.
*
* This method is deprecated, as it takes neither scope nor the servlet
* path into account (when the servlet is not the default servlet). Please
* use WebdavUtils.getAbsolutePath() instead.
*
* @deprecated
* @param serverURL the URL of the server
* @param contextPath the context path.
* @param uri the (slide-) URI of the resource.
*
* @return the concatenated URL.
*/
public static String getAbsoluteURL(String serverURL, String contextPath, String uri) {
// FIXME servletContext??
StringBuffer buffer = new StringBuffer();
String lastAppended = null;
// if (serverURL != null) {
// buffer.append(serverURL);
// lastAppended = buffer.toString();
// }
if (contextPath != null) {
if ( (lastAppended != null) && !lastAppended.endsWith("/") && !contextPath.startsWith("/") ) {
buffer.append("/");
}
buffer.append(contextPath);
lastAppended = buffer.toString();
}
if (uri != null) {
if ( (lastAppended != null) && !lastAppended.endsWith("/") && !uri.startsWith("/") ) {
buffer.append("/");
}
buffer.append(uri);
}
return WebdavUtils.encodeURL(buffer.toString());
}
/**
* Returns <code>true</code> if the given <code>uri</code> is an absolute URL.
*
* @param contextPath the context path.
* @param uri the (slide-) URI of the resource.
*
* @return <code>true</code> if the given <code>uri</code> is an absolute URL.
*/
public static boolean isAbsoluteURL(String servletContextPath, String uri) {
if (uri.startsWith(S_RESOURCE_ID)) {
return true;
}
if (uri.startsWith(S_LOCK_TOKEN)) {
return true;
}
if (!uri.startsWith("/")) {
uri = "/" + uri;
}
return uri.startsWith(servletContextPath);
}
/**
* Adds the given <code>uri</code> as a <code><href></code> element
* to the value of the property (specified by the <code>propertyName</code>)
* of the given NodeRevisionDescriptor (if not already contained).
*
* @param revisionDescriptor the NodeRevisionDescriptor for which to
* update the property.
* @param propertyName the name of the property to add the uri to.
* @param uri the uri to add as a <code><href></code> element.
* @return true, if href was added; false, if already contained
* @throws JDOMException
*
*/
public static boolean addHrefToProperty(NodeRevisionDescriptor revisionDescriptor, String propertyName, String uri) throws JDOMException {
return addElementToProperty(revisionDescriptor, propertyName, E_HREF, uri);
}
/**
* Adds the given <code>elementValue</code> as a <code><elementName></code> element
* to the value of the property (specified by the <code>propertyName</code>)
* of the given NodeRevisionDescriptor (if not already contained).
*
* @param revisionDescriptor the NodeRevisionDescriptor for which to
* update the property.
* @param propertyName the name of the property to add the element to.
* @param elementName the name of the element to add.
* @param elementValue the value to add as a <code><elementName></code> element.
* @return true, if element was added; false, if already contained
* @throws JDOMException
*
*/
public static boolean addElementToProperty(NodeRevisionDescriptor revisionDescriptor, String propertyName, String elementName, String elementValue) throws JDOMException {
NodeProperty property = revisionDescriptor.getProperty(propertyName);
if (property == null) {
property = new NodeProperty(propertyName, "");
}
XMLValue xmlValue = new XMLValue((String)property.getValue());
Iterator iterator = xmlValue.iterator();
boolean alreadyContained = false;
Element element = null;
while (iterator.hasNext() && !alreadyContained) {
element = (Element)iterator.next();
if (element.getName().equals(elementName) && element.getText().equals(elementValue)) {
alreadyContained = true;
}
}
if (!alreadyContained) {
element = new Element(elementName);
element.setText(elementValue);
xmlValue.add(element);
}
revisionDescriptor.setProperty(propertyName, xmlValue.toString());
return !alreadyContained;
}
/**
* Removes the <code><href></code> element with the given <code>uri</code>
* from the value of the property (specified by the <code>propertyName</code>)
* of the given NodeRevisionDescriptor (if contained).
*
* @param revisionDescriptor the NodeRevisionDescriptor for which to
* update the property.
* @param propertyName the name of the property to remove the uri from.
* @param uri the uri of the <code><href></code> element
* to remove.
* @return true, if href was removed; false, if not found
* @throws JDOMException
*
*/
public static boolean removeHrefFromProperty(NodeRevisionDescriptor revisionDescriptor, String propertyName, String uri) throws JDOMException {
return removeElementFromProperty(revisionDescriptor, propertyName, E_HREF, uri);
}
/**
* Removes the <code><elementName></code> element with the given <code>elementValue</code>
* from the value of the property (specified by the <code>propertyName</code>)
* of the given NodeRevisionDescriptor (if contained).
*
* @param revisionDescriptor the NodeRevisionDescriptor for which to
* update the property.
* @param propertyName the name of the property to add the element to.
* @param elementName the name of the element to add.
* @param elementValue the value to add as a <code><elementName></code> element.
* @return true, if element was removed; false, if not found
*
* @throws JDOMException
*
*/
public static boolean removeElementFromProperty(NodeRevisionDescriptor revisionDescriptor, String propertyName, String elementName, String elementValue) throws JDOMException {
NodeProperty property = revisionDescriptor.getProperty(propertyName);
boolean found = false;
if (property != null) {
XMLValue xmlValue = new XMLValue((String)property.getValue());
Iterator iterator = xmlValue.iterator();
Element element = null;
while (iterator.hasNext() && !found) {
element = (Element)iterator.next();
if (element.getName().equals(elementName) && element.getText().equals(elementValue)) {
found = true;
iterator.remove();
}
}
if (found) {
revisionDescriptor.setProperty(propertyName, xmlValue.toString());
}
}
return found;
}
public static boolean replaceElementAtProperty(
NodeRevisionDescriptor revisionDescriptor,
PropertyName propertyName, String elementName,
String oldElementValue, String newElementValue) throws JDOMException {
NodeProperty property = revisionDescriptor.getProperty(propertyName);
XMLValue xmlValue = new XMLValue((String)property.getValue());
Iterator iterator = xmlValue.iterator();
boolean anythingReplaced = false;
while (iterator.hasNext()) {
Element element = (Element)iterator.next();
if (element.getName().equals(elementName) && element.getText().equals(oldElementValue)) {
anythingReplaced = true;
element.setText(newElementValue);
}
}
revisionDescriptor.setProperty(propertyName, xmlValue.toString());
return !anythingReplaced;
}
/**
* Any leading <code>/</code> in the given <code>uri</code> will be removed.
*
* @param uri the Uri to remove leading slashes from.
*
* @return the Uri without leading slashes.
*/
public static String truncateLeadingSlash(String uri) {
if (uri == null) {
return uri;
}
while (uri.startsWith("/")) {
uri = uri.substring(1);
}
return uri;
}
/**
* Any leading <code>/</code> in the given <code>uri</code> will be removed.
*
* @param uri the Uri to remove leading slashes from.
*
* @return the Uri without leading slashes.
*/
public static String computeEtag(String uri, NodeRevisionDescriptor nrd) {
StringBuffer sb = new StringBuffer();
sb.append(System.currentTimeMillis()).append('_')
.append(uri.hashCode()).append('_')
.append(nrd.getLastModified()).append('_')
.append(nrd.getContentLength());
return DigestUtils.md5Hex(sb.toString());
}
}
The table below shows all metrics for PropertyHelper.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 69.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 234.00 | Comment lines | |
| COMMENT_DENSITY | 0.82 | Comment density | |
| COMPARISONS | 40.00 | Number of comparison operators | |
| CYCLOMATIC | 75.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 27.00 | Comments in declarations | |
| DOC_COMMENT | 206.00 | Number of javadoc comment lines | |
| ELOC | 286.00 | Effective lines of code | |
| EXEC_COMMENTS | 3.00 | Comments in executable code | |
| EXITS | 81.00 | Procedure exits | |
| FUNCTIONS | 31.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 64.65 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 173.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 | 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 | 1.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 1.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 | 2.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 | 27.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 5.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 9.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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 6.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 2.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 5.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 | 5.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 | 1.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 | 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 | 6.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 | 4.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 | 2.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 | 1.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 678.00 | Number of lines in the source file | |
| LINE_COMMENT | 6.00 | Number of line comments | |
| LOC | 358.00 | Lines of code | |
| LOGICAL_LINES | 176.00 | Number of statements | |
| LOOPS | 8.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1025.00 | Number of operands | |
| OPERATORS | 1614.00 | Number of operators | |
| PARAMS | 79.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2639.00 | Halstead program length | |
| PROGRAM_VOCAB | 366.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 94.00 | Number of return points from functions | |
| SIZE | 26853.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 325.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 41.00 | Number of unique operators | |
| WHITESPACE | 86.00 | Number of whitespace lines | |