FileManager.java
| Index Score | ||
|---|---|---|
 |
 |
com.limegroup.gnutella |
 |
 |
FrostWire |
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 |  |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0141 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| DOC_COMMENT | Number of javadoc comment lines | |
| FUNCTIONS | Number of function declarations | |
| COMMENTS | Comment lines | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| SIZE | Size of the file in bytes | |
| PROGRAM_VOLUME | Halstead program volume | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| CYCLOMATIC | Cyclomatic complexity | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| COMPARISONS | Number of comparison operators | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| LINES | Number of lines in the source file | |
| ELOC | Effective lines of code | |
| EXITS | Procedure exits | |
| LOOPS | Number of loops | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
package com.limegroup.gnutella;
import java.io.File;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.concurrent.TimeoutException;
import com.limegroup.gnutella.downloader.VerifyingFile;
import com.limegroup.gnutella.messages.QueryRequest;
import com.limegroup.gnutella.routing.QueryRouteTable;
import com.limegroup.gnutella.xml.LimeXMLDocument;
/**
* Provides operations to add and remove
* individual files, directory, or sets of directories. Provides a method to
* efficiently query for files whose names contain certain keywords.<p>
*/
public interface FileManager {
/** The string used by Clip2 reflectors to index hosts. */
public static final String INDEXING_QUERY = " ";
/** The string used by LimeWire to browse hosts. */
public static final String BROWSE_QUERY = "*.*";
/** A type-safe empty LimeXMLDocument list. */
public static final List<LimeXMLDocument> EMPTY_DOCUMENTS = Collections.emptyList();
/**
* Characters used to tokenize queries and file names.
*/
public static final String DELIMITERS = " -._+/*()\\,";
/** Asynchronously loads all files by calling loadSettings. Sets this's
* callback to be "callback", and notifies "callback" of all file loads.
* @modifies this
* @see loadSettings */
public abstract void start();
/**
* Invokes {@link #start()} and waits for <code>timeout</code>
* milliseconds for the initialization to finish.
*
* @param timeout timeout in milliseconds
* @throws InterruptedException if interrupted while waiting
* @throws TimeoutException if timeout elapsed before initialization completed
*/
public abstract void startAndWait(long timeout) throws InterruptedException, TimeoutException;
public abstract void stop();
/**
* Returns the size of all files, in <b>bytes</b>. Note that the largest
* value that can be returned is Integer.MAX_VALUE, i.e., ~2GB. If more
* bytes are being shared, returns this value.
*/
public abstract int getSize();
/**
* Returns the number of files.
* This number does NOT include incomplete files or forcibly shared network files.
*/
public abstract int getNumFiles();
/**
* returns the number of store files
* This number does NOT include incomplete files
*/
public abstract int getNumStoreFiles();
/**
* Returns the number of shared incomplete files.
*/
public abstract int getNumIncompleteFiles();
/**
* Returns the number of pending files.
*/
public abstract int getNumPendingFiles();
/**
* Returns the number of forcibly shared files.
*/
public abstract int getNumForcedFiles();
/**
* Returns the file descriptor with the given index. Throws
* IndexOutOfBoundsException if the index is out of range. It is also
* possible for the index to be within range, but for this method to
* return <tt>null</tt>, such as the case where the file has been
* unshared.
*
* @param i the index of the <tt>FileDesc</tt> to access
* @throws <tt>IndexOutOfBoundsException</tt> if the index is out of
* range
* @return the <tt>FileDesc</tt> at the specified index, which may
* be <tt>null</tt>
*/
public abstract FileDesc get(int i);
/**
* Determines whether or not the specified index is valid. The index
* is valid if it is within range of the number of files shared, i.e.,
* if:<p>
*
* i >= 0 && i < _files.size() <p>
*
* @param i the index to check
* @return <tt>true</tt> if the index is within range of our shared
* file data structure, otherwise <tt>false</tt>
*/
public abstract boolean isValidIndex(int i);
/**
* Returns the <tt>URN<tt> for the File. May return null;
*/
public abstract URN getURNForFile(File f);
/**
* Returns the <tt>FileDesc</tt> that is wrapping this <tt>File</tt>
* or null if the file is not shared.
*/
public abstract FileDesc getFileDescForFile(File f);
/**
* Determines whether or not the specified URN is shared in the library
* as a complete file.
*/
public abstract boolean isUrnShared(final URN urn);
/**
* Returns the <tt>FileDesc</tt> for the specified URN. This only returns
* one <tt>FileDesc</tt>, even though multiple indices are possible with
* HUGE v. 0.93.
*
* @param urn the urn for the file
* @return the <tt>FileDesc</tt> corresponding to the requested urn, or
* <tt>null</tt> if no matching <tt>FileDesc</tt> could be found
*/
public abstract FileDesc getFileDescForUrn(final URN urn);
/**
* Returns a list of all shared incomplete file descriptors.
*/
public abstract FileDesc[] getIncompleteFileDescriptors();
/**
* Returns an array of all shared file descriptors.
*/
public abstract FileDesc[] getAllSharedFileDescriptors();
/**
* Returns a list of all shared file descriptors in the given directory,
* in any order.
* Returns null if directory is not shared, or a zero-length array if it is
* shared but contains no files. This method is not recursive; files in
* any of the directory's children are not returned.
*/
public abstract List<FileDesc> getSharedFilesInDirectory(File directory);
/**
* Starts a new revision of the library, ensuring that only items present
* in the appropriate sharing settings are shared.
*
* This method is non-blocking and thread-safe.
*
* @modifies this
*/
public abstract void loadSettings();
public abstract void loadSettingsAndWait(long timeout) throws InterruptedException,
TimeoutException;
/**
* Loads the FileManager with a new list of directories.
*/
public abstract void loadWithNewDirectories(Set<? extends File> shared, Set<File> blackListSet);
/**
* Returns whether or not the loading is finished.
*/
public abstract boolean isLoadFinished();
/**
* Returns whether or not the updating is finished.
*/
public abstract boolean isUpdating();
/**
* Removes a given directory from being completely shared.
*/
public abstract void removeFolderIfShared(File folder);
/**
* Adds a set of folders to be shared and a black list of subfolders that should
* not be shared.
*
* @param folders set of folders to be shared
* @param blackListedSet the subfolders or subsubfolders that are not to be
* shared
*/
public abstract void addSharedFolders(Set<File> folders, Set<File> blackListedSet);
public abstract Set<File> getFolderNotToShare();
/**
* Adds a given folder to be shared.
*/
public abstract boolean addSharedFolder(File folder);
/**
* Always shares the given file.
*/
public abstract void addFileAlways(File file);
/**
* Always shares a file, notifying the given callback when shared.
*/
public abstract void addFileAlways(File file, FileEventListener callback);
/**
* Always shares the given file, using the given list of metadata.
*/
public abstract void addFileAlways(File file, List<? extends LimeXMLDocument> list);
/**
* Adds the given file to share, with the given list of metadata,
* even if it exists outside of what is currently accepted to be shared.
* <p>
* Too large files are still not shareable this way.
*
* The listener is notified if this file could or couldn't be shared.
*/
public abstract void addFileAlways(File file, List<? extends LimeXMLDocument> list,
FileEventListener callback);
/**
* adds a file that will be shared during this session of limewire
* only.
*/
public abstract void addFileForSession(File file);
/**
* adds a file that will be shared during this session of limewire
* only.
*
* The listener is notified if this file could or couldn't be shared.
*/
public abstract void addFileForSession(File file, FileEventListener callback);
/**
* Adds the given file if it's shared.
*/
public abstract void addFileIfShared(File file);
/**
* Adds the given file if it's shared, notifying the given callback.
*/
public abstract void addFileIfShared(File file, FileEventListener callback);
/**
* Adds the file if it's shared, using the given list of metadata.
*/
public abstract void addFileIfShared(File file, List<? extends LimeXMLDocument> list);
/**
* Adds the file if it's shared, using the given list of metadata,
* informing the specified listener about the status of the sharing.
*/
public abstract void addFileIfShared(File file, List<? extends LimeXMLDocument> list,
FileEventListener callback);
/**
* Removes the file if it is being shared, and then removes the file from
* the special lists as necessary.
* @return The FileDesc associated with this file, or null if the file was
* not shared.
*/
public abstract FileDesc stopSharingFile(File file);
/**
* @modifies this
* @effects ensures the first instance of the given file is not
* shared. Returns FileDesc iff the file was removed.
* In this case, the file's index will not be assigned to any
* other files. Note that the file is not actually removed from
* disk.
*/
public abstract FileDesc removeFileIfShared(File f);
/**
* Adds an incomplete file to be used for partial file sharing.
*
* @modifies this
* @param incompleteFile the incomplete file.
* @param urns the set of all known URNs for this incomplete file
* @param name the completed name of this incomplete file
* @param size the completed size of this incomplete file
* @param vf the VerifyingFile containing the ranges for this inc. file
*/
public abstract void addIncompleteFile(File incompleteFile, Set<? extends URN> urns,
String name, long size, VerifyingFile vf);
/**
* Notification that a file has changed and new hashes should be
* calculated.
*/
public abstract void fileChanged(File f);
/** Attempts to validate the given FileDesc. */
public abstract void validate(final FileDesc fd);
/**
* Renames a from from 'oldName' to 'newName'.
*/
public abstract void renameFileIfSharedOrStore(File oldName, File newName);
/**
* If oldName isn't shared, returns false. Otherwise removes "oldName",
* adds "newName", and returns true iff newName is actually shared. The new
* file may or may not have the same index as the original.
*
* This assumes that oldName has been deleted & newName exists now.
* @modifies this
*/
public abstract void renameFileIfSharedOrStore(final File oldName, final File newName,
final FileEventListener callback);
/**
* Validates a file, moving it from 'SENSITIVE_DIRECTORIES_NOT_TO_SHARE'
* to SENSITIVE_DIRECTORIES_VALIDATED'.
*/
public abstract void validateSensitiveFile(File dir);
/**
* Invalidates a file, removing it from the shared directories, validated
* sensitive directories, and adding it to the sensitive directories
* not to share (so we don't ask again in the future).
*/
public abstract void invalidateSensitiveFile(File dir);
/**
* Determines if there are any files shared that are not in completely shared directories.
*/
public abstract boolean hasIndividualFiles();
/**
* Determines if there are any LWS files that are located in a shared
* directory
*/
public abstract boolean hasIndividualStoreFiles();
/**
* @return true if currently we have any files that are
* shared by the application.
*/
public abstract boolean hasApplicationSharedFiles();
/**
* Returns all files that are shared while not in shared directories.
*/
public abstract File[] getIndividualFiles();
/**
* Returns all files that are LWS files that are located in a shared
* directory
*/
public abstract File[] getIndividualStoreFiles();
/**
* Returns true if the file is a store file and is located in a shared directory,
* false otherwise
*/
public abstract boolean isIndividualStore(File f);
/**
* Returns true if the file is not a store file and is shared but the entire folder
* is not shared, false otherwise
*/
public abstract boolean isIndividualShare(File f);
/**
* Returns true if the given file is shared by the FileManager.
* The provided file should be in canonical form.
*/
public abstract boolean isFileShared(File file);
public abstract boolean isRareFile(FileDesc fd);
/**
* Returns true if this file is in a directory that is completely shared.
*/
public abstract boolean isFileInCompletelySharedDirectory(File f);
/**
* Returns true if this dir is completely shared.
*/
public abstract boolean isFolderShared(File dir);
/**
* @return true if this file is a song purchased from the LWS, false otherwise
*
* This does a simple lookup in the lists of store
* files and returns true if that file is found in a store list and false otherwise. This
* method assumes all files have already had there ID3 information examined and placed in
* one of these lists when appropriate
*/
public abstract boolean isStoreFile(File file);
/**
* Returns true if this directory is the folder that is selected to download LWS songs into
* or is a subfolder of the LWS folder and false otherwise. NOTE: this folder can be
* shared and can be the same as the currently selected root shared folder.
*
* @param file
* @return
*/
public abstract boolean isStoreDirectory(File file);
/**
* Returns true if this folder is sharable.
* <p>
* Unsharable folders include:
* <ul>
* <li>A non-directory or unreadable folder</li>
* <li>The incomplete directory</li>
* <li>The 'application special share directory'</li>
* <li>Any root directory</li>
* <li>Any directory listed in 'directories not to share' (<i>Only if
* includeExcludedDirectories is true</i>)</li>
* </ul>
*
* @param folder The folder to check for sharability
* @param includeExcludedDirectories True if this should exclude the folder
* from sharability if it is listed in DIRECTORIES_NOT_TO_SHARE
* @return true if the folder can be shared
*/
public abstract boolean isFolderShareable(File folder, boolean includeExcludedDirectories);
/**
* Returns the QRTable. If the shared files have changed, then it will
* rebuild the QRT. A copy is returned so that FileManager does not expose
* its internal data structure.
*/
public abstract QueryRouteTable getQRT();
/**
* Returns an array of all responses matching the given request. If there
* are no matches, the array will be empty (zero size).
*
* Incomplete Files are NOT returned in responses to queries.
*
* Design note: returning an empty array requires no extra allocations,
* as empty arrays are immutable.
*/
public abstract Response[] query(QueryRequest request);
/**
* @return true if there exists an application-shared file with the
* provided name.
*/
public abstract boolean isFileApplicationShared(String name);
/**
* registers a listener for FileManagerEvents
*/
public abstract void addFileEventListener(FileEventListener listener);
/**
* unregisters a listener for FileManagerEvents
*/
public abstract void removeFileEventListener(FileEventListener listener);
/**
* Returns an iterator for all shared files.
*/
public abstract Iterator<Response> getIndexingIterator(final boolean includeXML);
/**
* Notification that an IncompleteFileDesc has been updated.
*/
public void fileURNSUpdated(FileDesc ifd);
}
The table below shows all metrics for FileManager.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 322.00 | Comment lines | |
| COMMENT_DENSITY | 3.62 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 1.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 68.00 | Comments in declarations | |
| DOC_COMMENT | 322.00 | Number of javadoc comment lines | |
| ELOC | 89.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 1.00 | Procedure exits | |
| FUNCTIONS | 67.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 20.68 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 66.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 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 4.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 | 50.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 28.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 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 4.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 | 133.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 1.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 487.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 89.00 | Lines of code | |
| LOGICAL_LINES | 82.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 280.00 | Number of operands | |
| OPERATORS | 551.00 | Number of operators | |
| PARAMS | 66.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 831.00 | Halstead program length | |
| PROGRAM_VOCAB | 202.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 16443.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 176.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 26.00 | Number of unique operators | |
| WHITESPACE | 76.00 | Number of whitespace lines | |