MemoryFile.java
| Index Score | ||
|---|---|---|
 |
 |
phex.download |
 |
 |
Phex |
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 | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| LINE_COMMENT | Number of line comments | |
| SIZE | Size of the file in bytes | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| LINES | Number of lines in the source file | |
| LOGICAL_LINES | Number of statements | |
| JAVA0236 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| ELOC | Effective lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| COMPARISONS | Number of comparison operators | |
| COMMENTS | Comment lines | |
| OPERANDS | Number of operands | |
| CYCLOMATIC | Cyclomatic complexity | |
| EXITS | Procedure exits | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0266 | JAVA0266 Use of System.out | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| RETURNS | Number of return points from functions | |
| FUNCTIONS | Number of function declarations | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2008 Phex Development Group
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* --- SVN Information ---
* $Id: MemoryFile.java 4238 2008-07-27 13:35:21Z gregork $
*/
package phex.download;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.locks.ReentrantLock;
import edu.umd.cs.findbugs.annotations.NonNull;
import phex.common.FileHandlingException;
import phex.common.RunnerQueueWorker;
import phex.common.file.ManagedFile;
import phex.common.file.ManagedFileException;
import phex.common.log.NLogger;
import phex.download.ThexVerificationData.ThexData;
import phex.download.strategy.ScopeSelectionStrategy;
import phex.download.strategy.ScopeSelectionStrategyProvider;
import phex.download.swarming.SWDownloadCandidate;
import phex.download.swarming.SWDownloadConstants;
import phex.download.swarming.SWDownloadFile;
import phex.download.swarming.SWDownloadSegment;
import phex.prefs.core.DownloadPrefs;
import phex.thex.TTHashCalcUtils;
import phex.xml.sax.downloads.DDownloadFile;
import phex.xml.sax.downloads.DDownloadScope;
/**
* A memory representation of the file data that is downloaded. It keeps track
* of the download scopes and maintains a small memory cache of downloaded data
* before it is written to disk.
* Download scopes are hold in the following lists and live cycle:
*
* 1) missingScope List
* gets allocated -> blockedScopeList (2)
* 2) blockedScopeList
* gets released
* missing parts -> missingScopeList (1)
* finished parts -> bufferedDataScopeList (3)
* 3) bufferedDataScopeList
* gets written to disk -> unverifiedScopeList (4)
* 4) unverifiedScopeList
* gets verified against THEX -> toBeVerifiedScopeList (5)
* download finished and no THEX -> finishedScopeList (6)
* 5) toBeVerifiedScopeList
* scopes during verification
* when verification successful -> finishedScopeList (6)
* when verification failed -> finishedScopeList (1)
* 6) finishedScopeList
* used to verify if download is complete...
*
* *) finalizationPhaseScopeList
* The finalizationPhaseScopeList aggregates all scope lists
* from bufferedDataScopeList downwards. It is used to ensure
* that double downloaded scopes don't creep into the
* finalization phase and onto the disk.
*
* Locking:
* The scope lists have two main areas that get locked during
* access. They are represented by the allocationLock and
* the finalizationLock.
* The allocationLock must be locked during all access to the
* missingScopeList and blockedScopeList.
* The finalizationLock must be locked during all access to the
* bufferedDataScopeList, unverifiedScopeList, toBeVerifiedScopeList,
* finishedScopeList and finalizationPhaseScopeList.
* In case both locks must be used the allocationLock should always
* be locked before locking the finalizationLock, and released vice
* versa.
*
*/
public class MemoryFile
{
private ScopeSelectionStrategy scopeSelectionStrategy;
/**
* A list of missing download scopes.
*/
private DownloadScopeList missingScopeList;
/**
* A list of download scopes currently blocked in downloads.
*/
private DownloadScopeList blockedScopeList;
/**
* Contains DataDownloadScope with the downloaded data. No DownloadScopeList
* is used since we don't like to mess with the merging of DirectByteBuffers
* that are part of the DataDownloadScope. The bufferedDataScopeList is
* written to disk in regular intervals.
*/
private List<DataDownloadScope> bufferedDataScopeList;
/**
* Counts the number of buffered bytes and ensures that buffer size
* is limited to configured value.
* Access needs no locking.
*/
private BufferVolumeTracker bufferedVolume;
/**
* A list of unverified and written to disc download scopes.
*/
private DownloadScopeList unverifiedScopeList;
/**
* A list of scopes ready to be verified.
*/
private DownloadScopeList toBeVerifiedScopeList;
/**
* A list of finished download scopes.
*/
private DownloadScopeList finishedScopeList;
/**
* The finalizationPhaseScopeList aggregates all scope lists
* from bufferedDataScopeList downwards. It is used to ensure
* that double downloaded scopes don't creep into the
* finalization phase and onto the disk.
*/
private DownloadScopeList finalizationPhaseScopeList;
private final ReentrantLock allocationLock;
private final ReentrantLock finalizationLock;
/**
* This list contains rated download scopes representing the availability
* of scopes from candidates.
*/
private RatedDownloadScopeList ratedScopeList;
/**
* The last time the rated download scope list was build.
*/
private long ratedScopeListBuildTime;
/**
* If true indicates that the buffers should be writing to disk
* from the DownloadDataWriter.
*/
private boolean isBufferWritingRequested;
/**
* Indicates it the {@link MemoryFile} has ever allocated a blocked
* {@link DownloadScope}. This is mainly used to tune performance
* during the release of scopes.
*/
private boolean isBlockedScopeAllocated;
private final SWDownloadFile downloadFile;
private final RunnerQueueWorker downloadVerifyRunner;
public MemoryFile( SWDownloadFile downloadFile,
BufferVolumeTracker globalBufferVolumeTracker,
DownloadDataWriter downloadDataWriter,
RunnerQueueWorker downloadVerifyRunner )
{
this.downloadFile = downloadFile;
this.downloadVerifyRunner = downloadVerifyRunner;
isBufferWritingRequested = false;
isBlockedScopeAllocated = false;
missingScopeList = new DownloadScopeList();
blockedScopeList = new DownloadScopeList();
bufferedDataScopeList = new ArrayList<DataDownloadScope>();
unverifiedScopeList = new DownloadScopeList();
toBeVerifiedScopeList = new DownloadScopeList();
finishedScopeList = new DownloadScopeList();
finalizationPhaseScopeList = new DownloadScopeList( );
allocationLock = new ReentrantLock( );
finalizationLock = new ReentrantLock( );
bufferedVolume = new BufferVolumeTracker(
globalBufferVolumeTracker,
DownloadPrefs.MaxWriteBufferPerDownload.get().intValue(),
downloadDataWriter );
long fileSize = downloadFile.getTotalDataSize();
if ( fileSize == SWDownloadConstants.UNKNOWN_FILE_SIZE )
{
missingScopeList.add( new DownloadScope( 0, Long.MAX_VALUE ) );
}
else
{
missingScopeList.add( new DownloadScope( 0, fileSize - 1 ) );
}
scopeSelectionStrategy = ScopeSelectionStrategyProvider.getAvailBeginRandSelectionStrategy();
}
public void setScopeSelectionStrategy( ScopeSelectionStrategy strategy )
{
scopeSelectionStrategy = strategy;
}
public ScopeSelectionStrategy getScopeSelectionStrategy()
{
return scopeSelectionStrategy;
}
public void updateFileSize( )
{
long fileSize = downloadFile.getTotalDataSize();
allocationLock.lock();
try
{
missingScopeList.remove( new DownloadScope( fileSize, Long.MAX_VALUE) );
blockedScopeList.remove( new DownloadScope( fileSize, Long.MAX_VALUE) );
}
finally
{
allocationLock.unlock();
}
scopeConsistencyCheck();
}
/**
* For user interface... no modifications to the scope list should be done.
*/
public DownloadScopeList getBlockedScopeList()
{
return blockedScopeList;
}
/**
* For user interface... no modifications to the scope list should be done.
*/
public DownloadScopeList getUnverifiedScopeList()
{
return unverifiedScopeList;
}
/**
* For user interface... no modifications to the scope list should be done.
*/
public DownloadScopeList getToBeVerifiedScopeList()
{
return toBeVerifiedScopeList;
}
/**
* For user interface... no modifications to the scope list should be done.
*/
public DownloadScopeList getFinishedScopeList()
{
return finishedScopeList;
}
public List<DownloadScope> getFinishedScopeListCopy()
{
finalizationLock.lock();
try
{
return finishedScopeList.getScopeListCopy();
}
finally
{
finalizationLock.unlock();
}
}
public List<DownloadScope> getUnverifiedScopeListCopy()
{
finalizationLock.lock();
try
{
return unverifiedScopeList.getScopeListCopy();
}
finally
{
finalizationLock.unlock();
}
}
/**
* Returns the number of downloaded fragments.
* @return the number of downloaded fragments.
*/
public int getDownloadedFragmentCount()
{
finalizationLock.lock();
try
{
return finishedScopeList.size() + unverifiedScopeList.size() + toBeVerifiedScopeList.size();
}
finally
{
finalizationLock.unlock();
}
}
/**
* The aggregated length of finished download fragments.
* @return aggregated length of finished download fragments.
*/
public long getFinishedLength()
{
finalizationLock.lock();
try
{
return finishedScopeList.getAggregatedLength();
}
finally
{
finalizationLock.unlock();
}
}
/**
* The aggregated length of missing download fragments.
* @return aggregated length of missing download fragments.
*/
public long getMissingLength()
{
allocationLock.lock();
try
{
return missingScopeList.getAggregatedLength();
}
finally
{
allocationLock.unlock();
}
}
private boolean isComplete()
{
finalizationLock.lock();
try
{
return finishedScopeList.getAggregatedLength() == downloadFile.getTotalDataSize();
}
finally
{
finalizationLock.unlock();
}
}
/**
* Checks if the beginning of the file (scope starting at byte 0) is
* available as unverified or finished scope. This info is used to check
* if a file preview would be possible.
* @return true if file beginning is available, false otherwise.
*/
public boolean isFileBeginningAvailable( )
{
finalizationLock.lock();
try
{
if ( unverifiedScopeList.size() > 0 )
{
DownloadScope scope = unverifiedScopeList.getScopeAt( 0 );
if ( scope.getStart() == 0 )
{// file beginning available.
return true;
}
}
if ( finishedScopeList.size() > 0 )
{
DownloadScope scope = finishedScopeList.getScopeAt( 0 );
if ( scope.getStart() == 0 )
{// file beginning available.
return true;
}
}
if ( toBeVerifiedScopeList.size() > 0 )
{
DownloadScope scope = toBeVerifiedScopeList.getScopeAt( 0 );
if ( scope.getStart() == 0 )
{// file beginning available.
return true;
}
}
return false;
}
finally
{
finalizationLock.unlock();
}
}
public long getFileBeginningScopeLength()
{
finalizationLock.lock();
try
{
// build a scope list containing all available scopes.
DownloadScopeList scopeList = (DownloadScopeList) finishedScopeList.clone();
scopeList.addAll( unverifiedScopeList );
scopeList.addAll( toBeVerifiedScopeList );
DownloadScope startScope = scopeList.getScopeAt( 0 );
// no matching start scope found...
if ( startScope == null || startScope.getStart() != 0 )
{
return 0;
}
return startScope.getLength();
}
finally
{
finalizationLock.unlock();
}
}
public RatedDownloadScopeList getRatedScopeList()
{
long now = System.currentTimeMillis();
if ( ratedScopeListBuildTime + SWDownloadConstants.RATED_SCOPE_LIST_TIMEOUT > now )
{
return ratedScopeList;
}
if ( ratedScopeList == null )
{
ratedScopeList = new RatedDownloadScopeList();
}
else
{
ratedScopeList.clear();
}
ratedScopeList.addAll( missingScopeList );
downloadFile.rateDownloadScopeList( ratedScopeList );
ratedScopeListBuildTime = System.currentTimeMillis();
return ratedScopeList;
}
/**
* Used to check if a scope is allocateable. This check is done early
* before a connection to a candidate is opened. The actual allocation happens
* after the connection to the candidate is established. Though it can happen
* that all scopes are already allocated until then.
* @param candidateScopeList the ranges that are wanted for this download if
* set to null all ranges are allowed.
* @return true if there is a scope available. false otherwise.
*/
public boolean isMissingScopeAllocateable( DownloadScopeList candidateScopeList )
{
allocationLock.lock();
try
{
if ( missingScopeList.isEmpty() && blockedScopeList.isEmpty() )
{
return false;
}
if ( missingScopeList.isEmpty() &&
downloadFile.getTotalDataSize() == SWDownloadConstants.UNKNOWN_FILE_SIZE )
{
return false;
}
if ( downloadFile.getTotalDataSize() != SWDownloadConstants.UNKNOWN_FILE_SIZE
&& candidateScopeList != null )
{
DownloadScopeList wantedScopeList = (DownloadScopeList) missingScopeList.clone();
wantedScopeList.addAll( blockedScopeList );
wantedScopeList.retainAll( candidateScopeList );
return wantedScopeList.size() > 0;
}
else
{
return true;
}
}
finally
{
allocationLock.unlock();
}
}
/**
* Allocates a missing scope.
* @return a missing scope ready to download.
*/
public DownloadScope allocateMissingScope( long preferredSize )
{
allocationLock.lock();
try
{
if ( missingScopeList.isEmpty() )
{
return null;
}
DownloadScope scope = missingScopeList.getScopeAt( 0 );
missingScopeList.remove( scope );
synchronized( scope )
{
// ignore preferred size if fileSize is unknown
if ( downloadFile.getTotalDataSize() != SWDownloadConstants.UNKNOWN_FILE_SIZE &&
scope.getLength() > preferredSize )
{
DownloadScope beforeScope = new DownloadScope(
scope.getStart(), scope.getStart() + preferredSize - 1 );
DownloadScope afterScope = new DownloadScope(
scope.getStart() + preferredSize, scope.getEnd() );
missingScopeList.add( afterScope );
scope = beforeScope;
}
}
blockedScopeList.add( scope );
return scope;
}
finally
{
allocationLock.unlock();
scopeConsistencyCheck();
}
}
public DownloadScope allocateMissingScopeForCandidate( DownloadScopeList candidateScopeList,
long preferredSize )
{
allocationLock.lock();
try
{
int segmentMultiple = DownloadPrefs.SegmentMultiple.get().intValue();
// adjust preferredSize to allocation situation.
long missingLength = missingScopeList.getAggregatedLength();
if ( missingLength < preferredSize*2 )
{
// only take half of the size that is left.
preferredSize = Math.max( missingLength / 2, segmentMultiple );
}
DownloadScopeList wantedScopeList = (DownloadScopeList)missingScopeList.clone();
wantedScopeList.addAll( missingScopeList );
wantedScopeList.retainAll( candidateScopeList );
if ( wantedScopeList.size() > 0 )
{
DownloadScope scope = scopeSelectionStrategy.selectDownloadScope(
downloadFile, wantedScopeList, preferredSize );
if ( scope == null )
{
return null;
}
missingScopeList.remove( scope );
blockedScopeList.add( scope );
return scope;
}
// don't touch blocked scope list in case we would still have missing scope
// available but just nothing is matching this candidate.
if ( missingLength > 0 )
{
return null;
}
// for now... disable double scope allocation... to risky...
return null;
// wantedScopeList = (DownloadScopeList)blockedScopeList.clone();
// wantedScopeList.addAll( blockedScopeList );
// wantedScopeList.retainAll( candidateScopeList );
// if ( wantedScopeList.size() == 0 )
// {
// return null;
// }
//
// // find the slowest candidate
// SWDownloadCandidate slowestCandidate = null;
// long slowestSpeed = Integer.MAX_VALUE;
// DownloadScope slowestScope = null;
// for ( SWDownloadCandidate candidate : downloadFile.getAllocatedCandidates() )
// {
// SWDownloadSegment downloadSegment = candidate.getDownloadSegment();
// if ( downloadSegment == null )
// {
// continue;
// }
// long start = downloadSegment.getTransferStartPosition();
// long end = downloadSegment.getEnd();
// DownloadScope scope = new DownloadScope( start, end );
// if ( !wantedScopeList.contains( scope ) || scope.getLength() < segmentMultiple*2 )
// {
// // not a matching candidate
// continue;
// }
// // average speed of this transfer, and the last transfer, if available ( >0 )
// long speed = downloadSegment.getTransferSpeed();
// long candidateSpeed = candidate.getSpeed();
// if ( candidateSpeed > 0 )
// {
// speed = (speed + candidateSpeed) / 2;
// }
// if ( speed < 1 )
// {
// // no data yet... max out...
// speed = Integer.MAX_VALUE;
// }
// if ( slowestCandidate == null || slowestSpeed > candidateSpeed )
// {
// slowestCandidate = candidate;
// slowestSpeed = speed;
// slowestScope = scope;
// }
// }
//
// if ( slowestScope == null )
// {
// return null;
// }
//
// // split slowest scope...
// long splitPoint = slowestScope.getStart() + slowestScope.getLength() / 2;
// DownloadScope scope = new DownloadScope( splitPoint, slowestScope.getEnd() );
// isBlockedScopeAllocated = true;
// return scope;
}
finally
{
allocationLock.unlock();
scopeConsistencyCheck();
}
}
/**
* Releases the missing part of the download scope. The downloaded part
* is handled through the buffered data writer.
*/
public void releaseAllocatedScope( DownloadScope downloadScope,
long transferredSize, SWDownloadCandidate downloadCandidate )
{
if ( downloadScope.getEnd() == Long.MAX_VALUE
&& downloadFile.getTotalDataSize() != SWDownloadConstants.UNKNOWN_FILE_SIZE )
{
downloadScope = new DownloadScope( downloadScope.getStart(),
downloadFile.getTotalDataSize() - 1 );
}
DownloadScope unblockScope;
if ( transferredSize == 0 )
{// just give back the scope for unblock.
unblockScope = downloadScope;
}
else if ( transferredSize < downloadScope.getLength() )
{
unblockScope = new DownloadScope( downloadScope.getStart()
+ transferredSize, downloadScope.getEnd() );
}
else
{
// fully downloaded scope nothing to unblock
return;
}
if ( isBlockedScopeAllocated )
{
releaseMultiBlockedAllocScope( unblockScope, downloadCandidate );
releaseMultiBlockedAllocScope( unblockScope, downloadCandidate );
}
else
{
releaseSingleAllocScope( unblockScope );
}
}
private void releaseMultiBlockedAllocScope(@NonNull DownloadScope unblockScope,
@NonNull SWDownloadCandidate downloadCandidate)
{
allocationLock.lock();
try
{
finalizationLock.lock();
try
{
// allocationLock must include this block otherwise candidate segment
// alloc/dealoc could happen concurrently
DownloadScopeList unblockScopeList = new DownloadScopeList( );
unblockScopeList.add( unblockScope );
// we need to ensure that the scope we release dosn't contain data
// already downloaded through a different candidate.
unblockScopeList.removeAll( finalizationPhaseScopeList );
// we might have allocated a blocked scoped which could be in use by
// other allocated candidates... the unblocking gets more complex,
// since we don't like to unblocked still allocated scopes.
long scopeStart = unblockScope.getStart();
long scopeEnd = unblockScope.getEnd();
List<SWDownloadCandidate> allocCandidatesList = downloadFile.getAllocatedCandidates();
for( SWDownloadCandidate allocCandidate : allocCandidatesList )
{
if ( allocCandidate == downloadCandidate )
{
continue;
}
SWDownloadSegment downloadSegment = allocCandidate.getDownloadSegment();
if ( downloadSegment == null )
{
continue;
}
long segStart = downloadSegment.getStart();
long segEnd = downloadSegment.getEnd();
if ( segEnd == -1 )
{
segEnd = Long.MAX_VALUE;
}
// not overlapping.. skip..
if ( !(scopeEnd >= segStart && scopeStart <= segEnd ) )
{
continue;
}
if ( segStart <= scopeStart && segEnd >= scopeEnd )
{// segment contains scope... nothing to be done...
return;
}
unblockScopeList.remove( new DownloadScope( segStart, segEnd ) );
}
if ( unblockScopeList.size() > 0 )
{
blockedScopeList.removeAll( unblockScopeList );
missingScopeList.addAll( unblockScopeList );
}
scopeConsistencyCheck();
}
finally
{
finalizationLock.unlock();
}
}
finally
{
allocationLock.unlock();
scopeConsistencyCheck();
}
}
private void releaseSingleAllocScope(DownloadScope unblockScope)
{
allocationLock.lock();
try
{
blockedScopeList.remove( unblockScope );
missingScopeList.add( unblockScope );
}
finally
{
allocationLock.unlock();
scopeConsistencyCheck();
}
}
public long getDownloadedLength()
{
finalizationLock.lock();
try
{
long length = unverifiedScopeList.getAggregatedLength();
length += toBeVerifiedScopeList.getAggregatedLength();
length += finishedScopeList.getAggregatedLength();
length += bufferedVolume.getUsedBufferSize();
return length;
}
finally
{
finalizationLock.unlock();
}
}
public int getBufferedDataLength()
{
return bufferedVolume.getUsedBufferSize();
}
public void bufferDataScope( DataDownloadScope dataScope ) throws IOException
{
allocationLock.lock();
try
{
finalizationLock.lock();
try
{
for ( DownloadScope finScope : finalizationPhaseScopeList )
{
if ( dataScope.isOverlapping( finScope ) )
{
// scope is overlapping a scope already in the fin phase..
// this is problematic... how is the split case handled??
throw new IOException( "Double download." );
}
if ( finScope.getStart() > dataScope.getEnd() )
{// performance optimization.. scopes are sorted...
break;
}
}
// dataScope not in fin list.. add it..
finalizationPhaseScopeList.add( dataScope );
// make sure any buffered data is removed from
// missingScopeList and blockedScopeList.
// This prevents it from getting allocated again.
// Removing from missing might be unnecessary..
// but it wont hurt.
missingScopeList.remove( dataScope );
blockedScopeList.remove( dataScope );
bufferedDataScopeList.add( dataScope );
}
finally
{
finalizationLock.unlock();
}
}
finally
{
allocationLock.unlock();
scopeConsistencyCheck();
}
assert dataScope.getLength() < Integer.MAX_VALUE;
// this must happen after releasing locks.. otherwise
// deadlock occurs in bufferedVolumne when full.
bufferedVolume.addBufferedSize( (int)dataScope.getLength() );
}
public boolean isBufferWritingRequested()
{
return isBufferWritingRequested;
}
/**
* Requests that the buffers of this MemoryFile are written to disk from the
* DownloadDataWriter thread.
*/
public void requestBufferWriting()
{
NLogger.debug( MemoryFile.class, "MemoryFile requesting buffer write." );
isBufferWritingRequested = true;
}
/**
* This method should only be called by the single DownloadDataWriter thread,
* to ensure integrity. This method is not able to handle multiple thread access
* to its data scopes.
*/
public void writeBuffersToDisk()
{
if ( bufferedDataScopeList.isEmpty() )
{
return;
}
NLogger.debug( MemoryFile.class, "MemoryFile write buffers to disk." );
isBufferWritingRequested = false;
try
{
ManagedFile destFile = downloadFile.getIncompleteDownloadFile();
List<DataDownloadScope> list;
finalizationLock.lock();
try
{
list = new ArrayList<DataDownloadScope>( bufferedDataScopeList );
}
finally
{
finalizationLock.unlock();
}
for( DataDownloadScope dataScope : list )
{
// if any part of the dataScope is already finished,
// unverified, tobeverified
destFile.write( dataScope.getDataBuffer(), dataScope.getStart() );
finalizationLock.lock();
try
{
bufferedDataScopeList.remove( dataScope );
//bufferedScopeList.remove( dataScope );
unverifiedScopeList.add( dataScope );
}
finally
{
finalizationLock.unlock();
}
assert dataScope.getLength() < Integer.MAX_VALUE;
bufferedVolume.reduceBufferedSize( (int)dataScope.getLength() );
// release scope buffer. After releasing we can use the
// DataDownloadScope like a simple DownloadScope.
dataScope.releaseDataBuffer();
}
findScopesToVerify();
scopeConsistencyCheck();
if ( !downloadFile.isFileCompletedOrMoved() && isComplete() )
{
downloadFile.setStatus( SWDownloadConstants.STATUS_FILE_COMPLETED );
downloadFile.moveToDestinationFile();
}
}
catch ( FileHandlingException exp )
{
// this exp stops the download in download file...
NLogger.error( MemoryFile.class, exp, exp );
}
catch ( ManagedFileException exp )
{
NLogger.error( MemoryFile.class, exp, exp );
}
}
private void findScopesToVerify()
{
List<DownloadScope> verifyableScopes;
finalizationLock.lock();
try
{
verifyableScopes = new ArrayList<DownloadScope>();
ThexData thexData = downloadFile.getThexVerificationData().getThexData();
if ( thexData == null )
{
if ( unverifiedScopeList.getAggregatedLength() == downloadFile.getTotalDataSize() )
{// the download has completed without having verification data available...
// move all scopes to finished...
List<DownloadScope> scopes = unverifiedScopeList.getScopeListCopy();
for ( DownloadScope scope : scopes )
{
unverifiedScopeList.remove( scope );
finishedScopeList.add( scope );
}
if ( !downloadFile.isFileCompletedOrMoved() && isComplete() )
{
downloadFile.setStatus( SWDownloadConstants.STATUS_FILE_COMPLETED );
downloadFile.moveToDestinationFile();
}
}
return;
}
long totalFileSize = downloadFile.getTotalDataSize();
int nodeSize = thexData.getNodeSize();
long lastNodeStart = totalFileSize - ( totalFileSize % nodeSize );
if ( lastNodeStart == totalFileSize )
{
lastNodeStart -= nodeSize;
}
for ( DownloadScope scope : unverifiedScopeList )
{
boolean isLastScope = scope.getEnd()+1 == totalFileSize;
if ( !isLastScope && scope.getLength() < nodeSize )
{
continue;
}
// calc start offset of thex node
long nodeStart;
if ( scope.getStart() % nodeSize == 0 )
{
nodeStart = scope.getStart();
}
else if ( isLastScope )
{// special handling for start of last node since it might not be a full nodeSize large.
nodeStart = totalFileSize - ( totalFileSize % nodeSize );
if ( nodeStart == totalFileSize )
{
nodeStart -= nodeSize;
}
}
else
{
nodeStart = scope.getStart() + nodeSize - scope.getStart() % nodeSize;
}
long nodeEnd;
if ( (scope.getEnd()+1) % nodeSize == 0 || isLastScope )
{
nodeEnd = scope.getEnd();
}
else
{
nodeEnd = scope.getEnd() - 1 - (scope.getEnd() % nodeSize);
}
if ( nodeEnd - nodeStart + 1 >= nodeSize && (nodeEnd - nodeStart+1)%nodeSize == 0 )
{
long rangeStart = nodeStart;
long rangeEnd;
do
{
rangeEnd = rangeStart + nodeSize - 1;
verifyableScopes.add( new DownloadScope( rangeStart, rangeEnd ) );
rangeStart = rangeEnd + 1;
}
while( rangeStart < nodeEnd );
}
else if ( isLastScope && scope.getStart() <= nodeStart )
{
verifyableScopes.add( new DownloadScope( nodeStart, nodeEnd ) );
}
}
if ( verifyableScopes.size() > 0 )
{
for ( DownloadScope scope : verifyableScopes )
{
unverifiedScopeList.remove( scope );
toBeVerifiedScopeList.add( scope );
downloadVerifyRunner.add(
new DownloadVerificationWorker( scope ) );
}
}
}
finally
{
finalizationLock.unlock();
scopeConsistencyCheck();
}
}
private void verifyScope( DownloadScope scope )
{
try
{
ManagedFile destFile = downloadFile.getIncompleteDownloadFile();
boolean succ = TTHashCalcUtils.verifyTigerTreeHash( downloadFile.getThexVerificationData().getThexData(),
destFile, scope.getStart(), scope.getLength() );
if ( succ )
{
finalizationLock.lock();
try
{
toBeVerifiedScopeList.remove( scope );
finishedScopeList.add( scope );
}
finally
{
finalizationLock.unlock();
}
}
else
{
allocationLock.lock();
try
{
finalizationLock.lock();
try
{
toBeVerifiedScopeList.remove( scope );
missingScopeList.add( scope );
finalizationPhaseScopeList.remove( scope );
}
finally
{
finalizationLock.unlock();
}
}
finally
{
allocationLock.unlock();
}
}
}
catch ( FileHandlingException exp )
{
// this exp should stop the download in download file...
NLogger.error( MemoryFile.class, exp, exp );
}
catch ( ManagedFileException exp )
{
NLogger.error( MemoryFile.class, exp, exp );
}
finally
{
scopeConsistencyCheck();
}
if ( !downloadFile.isFileCompletedOrMoved() && isComplete() )
{
downloadFile.setStatus( SWDownloadConstants.STATUS_FILE_COMPLETED );
downloadFile.moveToDestinationFile();
}
}
////////////////////////// XJB stuff ///////////////////////////////////////
public void createDownloadScopes( DDownloadFile dFile )
{
//clean scopes
missingScopeList.clear();
blockedScopeList.clear();
unverifiedScopeList.clear();
toBeVerifiedScopeList.clear();
finishedScopeList.clear();
setScopeSelectionStrategy( ScopeSelectionStrategyProvider.getByClassName(
dFile.getScopeSelectionStrategy() ) );
Iterator<DDownloadScope> iterator = dFile.getUnverifiedScopesList().getSubElementList().iterator();
while( iterator.hasNext() )
{
DDownloadScope dScope = iterator.next();
DownloadScope downloadScope = new DownloadScope( dScope.getStart(),
dScope.getEnd() );
unverifiedScopeList.add( downloadScope );
}
iterator = dFile.getFinishedScopesList().getSubElementList().iterator();
while( iterator.hasNext() )
{
DDownloadScope dScope = iterator.next();
DownloadScope downloadScope = new DownloadScope( dScope.getStart(),
dScope.getEnd() );
finishedScopeList.add( downloadScope );
}
// build missing scope list.
long fileSize = downloadFile.getTotalDataSize();
if ( fileSize == SWDownloadConstants.UNKNOWN_FILE_SIZE )
{
missingScopeList.add( new DownloadScope( 0, Long.MAX_VALUE ) );
}
else
{
missingScopeList.add( new DownloadScope( 0, fileSize - 1 ) );
}
// remove finished scopes...
missingScopeList.removeAll( unverifiedScopeList );
missingScopeList.removeAll( finishedScopeList );
finalizationPhaseScopeList.addAll( unverifiedScopeList );
finalizationPhaseScopeList.addAll( finishedScopeList );
scopeConsistencyCheck();
}
public void createXJBFinishedScopes( DDownloadFile dFile )
{
dFile.setScopeSelectionStrategy( scopeSelectionStrategy.getClass().getName() );
List<DDownloadScope> list = dFile.getUnverifiedScopesList().getSubElementList();
// copy scope list to prevent ConcurrentModificationException during iteration.
List<DownloadScope> unvScopeListCopy = getUnverifiedScopeListCopy();
for( DownloadScope scope : unvScopeListCopy )
{
DDownloadScope dScope = new DDownloadScope(
DDownloadScope.UNVERIFIED_SCOPE_ELEMENT_NAME );
dScope.setStart( scope.getStart() );
dScope.setEnd( scope.getEnd() );
list.add( dScope );
}
list = dFile.getFinishedScopesList().getSubElementList();
// copy finished scope list to prevent ConcurrentModificationException during iteration.
List<DownloadScope> finScopeListCopy = getFinishedScopeListCopy();
for( DownloadScope scope : finScopeListCopy )
{
DDownloadScope dScope = new DDownloadScope(
DDownloadScope.FINISHED_SCOPE_ELEMENT_NAME );
dScope.setStart( scope.getStart() );
dScope.setEnd( scope.getEnd() );
list.add( dScope );
}
}
/**
* 1) missingScope List
* gets allocated -> blockedScopeList (2)
* 2) blockedScopeList
* gets released
* missing parts -> missingScopeList (1)
* finished parts -> bufferedDataScopeList (3)
* 3) bufferedDataScopeList
* gets written to disk -> unverifiedScopeList (4)
* 4) unverifiedScopeList
* gets verified against THEX -> toBeVerifiedScopeList (5)
* download finished and no THEX -> finishedScopeList (6)
* 5) toBeVerifiedScopeList
* scopes during verification
* when verification successful -> finishedScopeList (6)
* when verification failed -> finishedScopeList (1)
* 6) finishedScopeList
* used to verify if download is complete...
*
* *) finalizationPhaseScopeList
* The finalizationPhaseScopeList aggregates all scope lists
* from bufferedDataScopeList downwards. It is used to ensure
* that double downloaded scopes don't creep into the
* finalization phase and onto the disk.
*/
private void scopeConsistencyCheck()
{
allocationLock.lock();
try
{
finalizationLock.lock();
try
{
// adding all scopes to a full file should result in a
// single scope of the full file size...
DownloadScopeList fullFile = new DownloadScopeList();
fullFile.addAll( missingScopeList );
fullFile.addAll( blockedScopeList );
for( DownloadScope scope : bufferedDataScopeList )
{
fullFile.add( scope );
}
fullFile.addAll( unverifiedScopeList );
fullFile.addAll( toBeVerifiedScopeList );
fullFile.addAll( finishedScopeList );
DownloadScope fullScope = fullFile.getScopeAt( 0 );
if ( fullScope.getStart() != 0 || fullScope.getEnd() != downloadFile.getTotalDataSize() -1 )
{
System.out.println("ouch1");
//throw new RuntimeException();
}
// missing and blocked scope length should not overlap each other.
fullFile = new DownloadScopeList();
fullFile.addAll( missingScopeList );
fullFile.addAll( blockedScopeList );
long expLength = missingScopeList.getAggregatedLength()
+ blockedScopeList.getAggregatedLength();
if ( expLength != fullFile.getAggregatedLength() )
{
System.out.println("ouch2");
}
expLength += unverifiedScopeList.getAggregatedLength();
fullFile.addAll( unverifiedScopeList );
if ( expLength != fullFile.getAggregatedLength() )
{
System.out.println("ouch3");
}
expLength += toBeVerifiedScopeList.getAggregatedLength();
fullFile.addAll( toBeVerifiedScopeList );
if ( expLength != fullFile.getAggregatedLength() )
{
System.out.println("ouch4");
}
expLength += finishedScopeList.getAggregatedLength();
fullFile.addAll( finishedScopeList );
if ( expLength != fullFile.getAggregatedLength() )
{
System.out.println("ouch5");
}
// check finalization phase aggregation
expLength = 0;
fullFile = new DownloadScopeList();
expLength += unverifiedScopeList.getAggregatedLength();
fullFile.addAll( unverifiedScopeList );
expLength += toBeVerifiedScopeList.getAggregatedLength();
fullFile.addAll( toBeVerifiedScopeList );
expLength += finishedScopeList.getAggregatedLength();
fullFile.addAll( finishedScopeList );
for( DownloadScope scope : bufferedDataScopeList )
{
fullFile.add( scope );
expLength += scope.getLength();
}
if ( expLength != fullFile.getAggregatedLength() )
{
System.out.println("ouch6");
}
if ( expLength != finalizationPhaseScopeList.getAggregatedLength() )
{
System.out.println("ouch7");
}
}
finally
{
finalizationLock.unlock();
}
}
finally
{
allocationLock.unlock();
}
}
public class DownloadVerificationWorker implements Runnable
{
private DownloadScope scope;
public DownloadVerificationWorker( DownloadScope scope )
{
this.scope = scope;
}
public void run()
{
try
{
verifyScope( scope );
}
catch ( Throwable th )
{
// this is a very bad error situation...
// it could break the download scope consistency!
NLogger.error( MemoryFile.class, "Download scope consistency in danger!" );
NLogger.error( MemoryFile.class, th, th );
}
}
}
}
The table below shows all metrics for MemoryFile.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 175.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 300.00 | Comment lines | |
| COMMENT_DENSITY | 0.52 | Comment density | |
| COMPARISONS | 90.00 | Number of comparison operators | |
| CYCLOMATIC | 114.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 29.00 | Comments in declarations | |
| DOC_COMMENT | 173.00 | Number of javadoc comment lines | |
| ELOC | 577.00 | Effective lines of code | |
| EXEC_COMMENTS | 90.00 | Comments in executable code | |
| EXITS | 81.00 | Procedure exits | |
| FUNCTIONS | 36.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 127.78 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 73.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.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 | 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 | 4.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 4.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 | 16.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 1.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 | 1.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 | 6.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 | 3.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 | 7.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 | 1336.00 | Number of lines in the source file | |
| LINE_COMMENT | 106.00 | Number of line comments | |
| LOC | 922.00 | Lines of code | |
| LOGICAL_LINES | 365.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1372.00 | Number of operands | |
| OPERATORS | 2811.00 | Number of operators | |
| PARAMS | 20.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4183.00 | Halstead program length | |
| PROGRAM_VOCAB | 363.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 53.00 | Number of return points from functions | |
| SIZE | 48630.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 306.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 114.00 | Number of whitespace lines | |