RtfDocumentSettings.java
| Index Score | ||
|---|---|---|
 |
 |
com.lowagie.text.rtf.document |
 |
 |
iText |
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 | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| SIZE | Size of the file in bytes | |
| FUNCTIONS | Number of function declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0030 | JAVA0030 Private field not used | |
| COMPARISONS | Number of comparison operators | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| EXITS | Procedure exits | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| OPERANDS | Number of operands | |
| CYCLOMATIC | Cyclomatic complexity | |
| RETURNS | Number of return points from functions | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* $Id: RtfDocumentSettings.java 3580 2008-08-06 15:52:00Z howard_s $
*
* Copyright 2003, 2004, 2005 by Mark Hall
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.rtf.document;
import com.lowagie.text.DocWriter;
import com.lowagie.text.rtf.document.output.RtfDataCache;
import com.lowagie.text.rtf.style.RtfParagraphStyle;
/**
* The RtfDocumentSettings contains output specific settings. These settings modify
* how the actual document is then generated and some settings may mean that some
* RTF readers can't read the document or render it wrongly.
*
* @version $Id: RtfDocumentSettings.java 3580 2008-08-06 15:52:00Z howard_s $
* @author Mark Hall (Mark.Hall@mail.room3b.eu)
* @author Thomas Bickel (tmb99@inode.at)
* @author Howard Shank (hgshank@yahoo.com)
*/
public class RtfDocumentSettings {
/**
* The RtfDocument this RtfDocumentSettings belongs to.
*/
private RtfDocument document = null;
/**
* Whether to also output the table row definition after the cell content.
*/
private boolean outputTableRowDefinitionAfter = true;
/**
* Whether to output the line breaks that make the rtf document source more readable.
*/
private boolean outputDebugLineBreaks = false;
/**
* Whether to always generate soft linebreaks for \n in Chunks.
*/
private boolean alwaysGenerateSoftLinebreaks = false;
/**
* Whether to always translate characters past 'z' into unicode representations.
*/
private boolean alwaysUseUnicode = true;
/**
* How to cache the document during generation. Defaults to RtfDataCache.CACHE_MEMORY;
*/
private int dataCacheStyle = RtfDataCache.CACHE_MEMORY;
/**
* Whether to write image scaling information. This is required for Word 2000, 97 and Word for Mac
*/
private boolean writeImageScalingInformation = false;
/**
* Whether images should be written in order to mimick the PDF output.
*/
private boolean imagePDFConformance = true;
/**
* Document protection level.
* Author: Howard Shank (hgshank@yahoo.com)
* @since 2.1.1
*/
private int protectionLevel = RtfProtection.LEVEL_NONE;
/**
* Document protection level password hash.
* Author: Howard Shank (hgshank@yahoo.com)
* @since 2.1.1
*/
private String protectionHash = null;
/**
* Document read password hash.
* Author: Howard Shank (hgshank@yahoo.com)
* @since 2.1.1
*/
private String writereservhash = null; //\*\writereservhash - not implemented
/**
* Document recommended to be opened in read only mode.
* Author: Howard Shank (hgshank@yahoo.com)
* @since 2.1.1
*/
private boolean readOnlyRecommended = false;
/**
* Images are written as binary data and not hex encoded.
* Author: Mark Hall (Mark.Hall@mail.room3b.eu)
* @since 2.1.1
*/
private boolean imageWrittenAsBinary = true;
/**
* Constructs a new RtfDocumentSettings object.
*
* @param document The RtfDocument this RtfDocumentSettings belong to.
*/
public RtfDocumentSettings(RtfDocument document) {
this.document = document;
}
/**
* Gets whether to output the line breaks for increased rtf document readability.
*
* @return Whether to output line breaks.
*/
public boolean isOutputDebugLineBreaks() {
return outputDebugLineBreaks;
}
/**
* Sets whether to output the line breaks for increased rtf document readability.
* Some line breaks may be added where the rtf specification demands it.
*
* @param outputDebugLineBreaks The outputDebugLineBreaks to set.
*/
public void setOutputDebugLineBreaks(boolean outputDebugLineBreaks) {
this.outputDebugLineBreaks = outputDebugLineBreaks;
}
/**
* Gets whether the table row definition should also be written after the cell content.
*
* @return Returns the outputTableRowDefinitionAfter.
*/
public boolean isOutputTableRowDefinitionAfter() {
return outputTableRowDefinitionAfter;
}
/**
* Sets whether the table row definition should also be written after the cell content.
* This is recommended to be set to <code>true</code> if you need Word2000 compatiblity and
* <code>false</code> if the document should be opened in OpenOffice.org Writer.
*
* @param outputTableRowDefinitionAfter The outputTableRowDefinitionAfter to set.
*/
public void setOutputTableRowDefinitionAfter(
boolean outputTableRowDefinitionAfter) {
this.outputTableRowDefinitionAfter = outputTableRowDefinitionAfter;
}
/**
* Gets whether all linebreaks inside Chunks are generated as soft linebreaks.
*
* @return <code>True</code> if soft linebreaks are generated, <code>false</code> for hard linebreaks.
*/
public boolean isAlwaysGenerateSoftLinebreaks() {
return this.alwaysGenerateSoftLinebreaks;
}
/**
* Sets whether to always generate soft linebreaks.
*
* @param alwaysGenerateSoftLinebreaks Whether to always generate soft linebreaks.
*/
public void setAlwaysGenerateSoftLinebreaks(boolean alwaysGenerateSoftLinebreaks) {
this.alwaysGenerateSoftLinebreaks = alwaysGenerateSoftLinebreaks;
}
/**
* Gets whether all characters bigger than 'z' are represented as unicode.
*
* @return <code>True</code> if unicode representation is used, <code>false</code> otherwise.
*/
public boolean isAlwaysUseUnicode() {
return this.alwaysUseUnicode;
}
/**
* Sets whether to represent all characters bigger than 'z' as unicode.
*
* @param alwaysUseUnicode <code>True</code> to use unicode representation, <code>false</code> otherwise.
*/
public void setAlwaysUseUnicode(boolean alwaysUseUnicode) {
this.alwaysUseUnicode = alwaysUseUnicode;
}
/**
* Registers the RtfParagraphStyle for further use in the document. This does not need to be
* done for the default styles in the RtfParagraphStyle object. Those are added automatically.
*
* @param rtfParagraphStyle The RtfParagraphStyle to register.
*/
public void registerParagraphStyle(RtfParagraphStyle rtfParagraphStyle) {
this.document.getDocumentHeader().registerParagraphStyle(rtfParagraphStyle);
}
/**
* Sets the data cache style. This controls where the document is cached during
* generation. Two cache styles are supported:
* <ul>
* <li>RtfDataCache.CACHE_MEMORY: The document is cached in memory. This is fast,
* but places a limit on how big the document can get before causing
* OutOfMemoryExceptions.</li>
* <li>RtfDataCache.CACHE_DISK: The document is cached on disk. This is slower
* than the CACHE_MEMORY setting, but the document size is now only constrained
* by the amount of free disk space.</li>
* </ul>
*
* @param dataCacheStyle The data cache style to set. Valid constants can be found
* in RtfDataCache.
* @see com.lowagie.text.rtf.document.output.RtfDataCache
*/
public void setDataCacheStyle(int dataCacheStyle) {
switch(dataCacheStyle) {
case RtfDataCache.CACHE_MEMORY_EFFICIENT:
this.dataCacheStyle = RtfDataCache.CACHE_MEMORY_EFFICIENT;
break;
case RtfDataCache.CACHE_DISK:
this.dataCacheStyle = RtfDataCache.CACHE_DISK;
break;
default:
case RtfDataCache.CACHE_MEMORY:
this.dataCacheStyle = RtfDataCache.CACHE_MEMORY;
break;
}
}
/**
* Gets the current data cache style.
*
* @return The current data cache style.
*/
public int getDataCacheStyle() {
return this.dataCacheStyle;
}
/**
* Gets the current setting on image PDF conformance.
*
* @return The current image PDF conformance.
*/
public boolean isImagePDFConformance() {
return this.imagePDFConformance;
}
/**
* Sets the image PDF conformance setting. By default images will be added
* as if they were displayed with 72dpi. Set this to <code>false</code>
* if images should be generated with the Word default DPI setting.
*
* @param imagePDFConformance <code>True</code> if PDF equivalence is desired, <code>false</code>
* for the default Word display.
*/
public void setImagePDFConformance(boolean imagePDFConformance) {
this.imagePDFConformance = imagePDFConformance;
}
/**
* Gets whether to write scaling information for images.
*
* @return Whether to write scaling information for images.
*/
public boolean isWriteImageScalingInformation() {
return this.writeImageScalingInformation;
}
/**
* Sets whether image scaling information should be written. This needs to be set to <code>true</code>
* MS Word 2000, MS Word 97 and Word for Mac.
*
* @param writeImageScalingInformation Whether to write image scaling information.
*/
public void setWriteImageScalingInformation(boolean writeImageScalingInformation) {
this.writeImageScalingInformation = writeImageScalingInformation;
}
/**
* Set the options required for RTF documents to display correctly in MS Word 2000
* and MS Word 97.
* Sets <code>outputTableRowDefinitionAfter = true</code> and <code>writeImageScalingInformation = true</code>.
*/
public void setOptionsForMSWord2000And97() {
this.setOutputTableRowDefinitionAfter(true);
this.setWriteImageScalingInformation(true);
}
/**
* Set the options required for RTF documents to display correctly in MS Word for Mac.
* Sets <code>writeImageScalingInformation = true</code>.
*/
public void setOptionsForMSWordForMac() {
this.setWriteImageScalingInformation(true);
}
/**
* Set the options required for RTF documents to display correctly in MS Word XP (2002).
* Sets <code>writeImageScalingInformation = false</code>.
*/
public void setOptionsForMSWordXP() {
this.setWriteImageScalingInformation(false);
}
/**
* Set the options required for RTF documents to display correctly in OpenOffice.Org
* Writer.
* Sets <code>outputTableRowDefinitionAfter = false</code>.
*/
public void setOptionsForOpenOfficeOrg() {
this.setOutputTableRowDefinitionAfter(false);
}
/**
* Author: Howard Shank (hgshank@yahoo.com)
* @param level Document protecton level
* @param pwd Document password - clear text
* @since 2.1.1
*/
public boolean setProtection(int level, String pwd) {
boolean result = false;
if(this.protectionHash == null) {
if(!setProtectionLevel(level)) {
result = false;
}
else
{
protectionHash = RtfProtection.generateHash(pwd);
result = true;
}
}
else {
if(this.protectionHash.equals(RtfProtection.generateHash(pwd))) {
if(!setProtectionLevel(level)) {
result = false;
}
else
{
protectionHash = RtfProtection.generateHash(pwd);
result = true;
}
}
}
return result;
}
/**
* Author: Howard Shank (hgshank@yahoo.com)
* @param pwd Document password - clear text
* @return true if document unprotected, false if protection is not removed.
* @since 2.1.1
*/
public boolean unprotectDocument(String pwd) {
boolean result = false;
if (this.protectionHash.equals(RtfProtection.generateHash(pwd))) {
this.protectionLevel = RtfProtection.LEVEL_NONE;
this.protectionHash = null;
result = true;
}
return result;
}
/**
* Author: Howard Shank (hgshank@yahoo.com)
* @param level Document protection level
* @since 2.1.1
*/
public boolean setProtectionLevel(int level) {
boolean result = false;
switch(level) {
case RtfProtection.LEVEL_NONE:
if(this.protectionHash == null) {
break;
}
case RtfProtection.LEVEL_ANNOTPROT:
case RtfProtection.LEVEL_FORMPROT:
case RtfProtection.LEVEL_REVPROT:
case RtfProtection.LEVEL_READPROT:
this.protectionLevel = level;
result = true;
break;
default:
}
return result;
}
/**
* This function is not intended for general use. Please see 'public boolean setProtection(int level, String pwd)'.
* Author: Howard Shank (hgshank@yahoo.com)
* @param pwd Password HASH to set the document password hash to.
* @since 2.1.1
*/
public void setPasswordHash(String pwd) {
if(pwd != null && pwd.length() != 8) return;
this.protectionHash = pwd;
}
/**
* Converts protection level from internal bitmap value to protlevel output value.
* Author: Howard Shank (hgshank@yahoo.com)
* @return <pre>
* 0 = Revision protection
* 1 = Annotation/Comment protection
* 2 = Form protection
* 3 = Read only protection
* </pre>
* @since 2.1.1
*/
private int convertProtectionLevel() {
int level = 0;
switch(this.protectionLevel) {
case RtfProtection.LEVEL_NONE:
break;
case RtfProtection.LEVEL_REVPROT:
level = 0;
break;
case RtfProtection.LEVEL_ANNOTPROT:
level = 1;
break;
case RtfProtection.LEVEL_FORMPROT:
level = 2;
break;
case RtfProtection.LEVEL_READPROT:
level = 3;
break;
}
return level;
}
/**
* Author: Howard Shank (hgshank@yahoo.com)
* @return RTF document protection level
* @since 2.1.1
*/
public int getProtectionLevelRaw() {
return this.protectionLevel;
}
/**
* Author: Howard Shank (hgshank@yahoo.com)
* @return RTF document protection level
* @since 2.1.1
*/
public int getProtectionLevel() {
return convertProtectionLevel();
}
/**
* Author: Howard Shank (hgshank@yahoo.com)
* @return RTF document protection level as a byte array (byte[])
* @since 2.1.1
*/
public byte[] getProtectionLevelBytes() {
return DocWriter.getISOBytes(Integer.toString(convertProtectionLevel()));
}
/**
* Author: Howard Shank (hgshank@yahoo.com)
* @param oldPwd Old password - clear text
* @param newPwd New password - clear text
* @return true if password set, false if password not set
* @since 2.1.1
*/
public boolean setNewPassword(String oldPwd, String newPwd) {
boolean result = false;
if (this.protectionHash.equals(RtfProtection.generateHash(oldPwd))) {
this.protectionHash = RtfProtection.generateHash(newPwd);
result = true;
}
return result;
}
/**
* Set the RTF flag that recommends the document be opened in read only mode.
* Author: Howard Shank (hgshank@yahoo.com)
* @param value true if the flag is to be set, false if it is NOT to be set
* @since 2.1.1
*/
public void setReadOnlyRecommended(boolean value) {
this.readOnlyRecommended = value;
}
/**
* Get the RTF flag that recommends if the the document should be opened in read only mode.
* Author: Howard Shank (hgshank@yahoo.com)
* @return true if flag is set, false if it is not set
* @since 2.1.1
*/
public boolean getReadOnlyRecommended() {
return this.readOnlyRecommended;
}
/**
* Determine if document has protection enabled.
* Author: Howard Shank (hgshank@yahoo.com)
* @return true if protection is enabled, false if it is not enabled
* @since 2.1.1
*/
public boolean isDocumentProtected() {
return !(this.protectionHash == null);
}
/**
* Obtain the password has as a byte array.
* Author: Howard Shank (hgshank@yahoo.com)
* @return The bytes of the password hash as a byte array (byte[])
* @since 2.1.1
*/
public byte[] getProtectionHashBytes() {
return DocWriter.getISOBytes(this.protectionHash);
}
/**
* Set whether images are written as binary data or are hex encoded.
* Author: Mark Hall (Mark.Hall@mail.room3b.eu)
* @param imageWrittenAsBinary <code>True</code> to write images as binary data, <code>false</code> for hex encoding.
* @since 2.1.1
*/
public void setImageWrittenAsBinary(boolean imageWrittenAsBinary) {
this.imageWrittenAsBinary = imageWrittenAsBinary;
}
/**
* Gets whether images are written as binary data or are hex encoded. Defaults to <code>true</code>.
* Author: Mark Hall (Mark.Hall@mail.room3b.eu)
* @since 2.1.1
* @return <code>True</code> if images are written as binary data, <code>false</code> if hex encoded.
*/
public boolean isImageWrittenAsBinary() {
return this.imageWrittenAsBinary;
}
}
The table below shows all metrics for RtfDocumentSettings.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 45.00 | Number of blocks | |
| BLOCK_COMMENT | 48.00 | Number of block comment lines | |
| COMMENTS | 316.00 | Comment lines | |
| COMMENT_DENSITY | 2.07 | Comment density | |
| COMPARISONS | 10.00 | Number of comparison operators | |
| CYCLOMATIC | 59.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 50.00 | Comments in declarations | |
| DOC_COMMENT | 268.00 | Number of javadoc comment lines | |
| ELOC | 153.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 11.00 | Procedure exits | |
| FUNCTIONS | 35.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 42.76 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 54.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 | 1.00 | JAVA0030 Private field not used | |
| JAVA0031 | 2.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 1.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 | 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 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 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 | 2.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 | 0.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 | 146.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 565.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 204.00 | Lines of code | |
| LOGICAL_LINES | 88.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 259.00 | Number of operands | |
| OPERATORS | 741.00 | Number of operators | |
| PARAMS | 18.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1000.00 | Halstead program length | |
| PROGRAM_VOCAB | 141.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 36.00 | Number of return points from functions | |
| SIZE | 19634.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 106.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 35.00 | Number of unique operators | |
| WHITESPACE | 45.00 | Number of whitespace lines | |