IOUtil.java

Index Score
		phex.utils
		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
JAVA0034	JAVA0034 Missing braces in if statement
JAVA0076	JAVA0076 Use of magic number
RETURNS	Number of return points from functions
INTERFACE_COMPLEXITY	Interface complexity
CYCLOMATIC	Cyclomatic complexity
COMPARISONS	Number of comparison operators
JAVA0031	JAVA0031 Case statement not properly closed
JAVA0108	JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
OPERATORS	Number of operators
JAVA0177	JAVA0177 Variable declaration missing initializer
SIZE	Size of the file in bytes
LOC	Lines of code
PARAMS	Number of formal parameter declarations
PROGRAM_LENGTH	Halstead program length
LINES	Number of lines in the source file
ELOC	Effective lines of code
LOGICAL_LINES	Number of statements
DECL_COMMENTS	Comments in declarations
BLOCKS	Number of blocks
JAVA0115	JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
OPERANDS	Number of operands
JAVA0110	JAVA0110 Incorrect javadoc: no @return tag
JAVA0008	JAVA0008 Empty catch block
FUNCTIONS	Number of function declarations
UNIQUE_OPERANDS	Number of unique operands
PROGRAM_VOCAB	Halstead program vocabulary
DOC_COMMENT	Number of javadoc comment lines
EXEC_COMMENTS	Comments in executable code
JAVA0117	JAVA0117 Missing javadoc: method 'method'
COMMENTS	Comment lines
JAVA0109	JAVA0109 Incorrect javadoc: no parameter 'parameter'
LOOPS	Number of loops
NEST_DEPTH	Maximum nesting depth
UNIQUE_OPERATORS	Number of unique operators
LINE_COMMENT	Number of line comments
JAVA0270	JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
PROGRAM_VOLUME	Halstead program volume
JAVA0136	JAVA0136 N methods defined in class (maximum: M)
JAVA0145	JAVA0145 Tab character used in source file

/* * PHEX - The pure-java Gnutella-servent. * Copyright (C) 2001 - 2007 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: IOUtil.java 4231 2008-07-15 16:01:10Z gregork $ */ package phex.utils; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.io.RandomAccessFile; import java.io.Reader; import java.io.Writer; import java.net.InetAddress; import java.net.Socket; import java.util.zip.DataFormatException; import java.util.zip.DeflaterOutputStream; import java.util.zip.Inflater; import edu.umd.cs.findbugs.annotations.SuppressWarnings; import phex.common.file.ManagedFile; import phex.common.file.ManagedFileException; import phex.common.file.ReadOnlyManagedFile; import phex.common.log.NLogger; import phex.net.repres.SocketFacade; public class IOUtil { public static final byte[] EMPTY_BYTE_ARRAY = new byte[0]; public static int serializeIntLE(int value, byte[] outbuf, int offset) { outbuf[offset++] = (byte)(value); outbuf[offset++] = (byte)(value >> 8); outbuf[offset++] = (byte)(value >> 16); outbuf[offset++] = (byte)(value >> 24); // Return next offset. return offset; } /** * Converts a int to a little-endian byte representation and writes it to the * given stream. */ public static void serializeIntLE( int value, OutputStream outStream ) throws IOException { outStream.write( (byte)(value) ); outStream.write( (byte)(value >> 8) ); outStream.write( (byte)(value >> 16) ); outStream.write( (byte)(value >> 24) ); } public static int deserializeIntLE(byte[] inbuf, int offset) { return (inbuf[offset + 3] ) << 24 | (inbuf[offset + 2] &0xff) << 16 | (inbuf[offset + 1] &0xff) << 8 | (inbuf[offset] &0xff); } @SuppressWarnings( value="SF_SWITCH_FALLTHROUGH" ) public static int deserializeIntLE(byte[] inbuf, int offset, int length) { int a,b,c,d; b = c = d = 0x00; switch ( length ) { case 4: d = (inbuf[offset + 3] ) << 24; // nobreak case 3: c = (inbuf[offset + 2] &0xff) << 16; // nobreak case 2: b = (inbuf[offset + 1] &0xff) << 8; // nobreak case 1: a = (inbuf[offset] &0xff); break; default: throw new IllegalArgumentException( "Wrong length: " + length); } return d|c|b|a; } @SuppressWarnings( value="SF_SWITCH_FALLTHROUGH" ) public static long deserializeLongLE(byte[] inbuf, int offset, int length) { long a,b,c,d,e,f,g,h; b = c = d = e = f = g = h = 0x00; switch ( length ) { case 8: h = (inbuf[offset + 7]&0xFFL) << 56; // nobreak case 7: g = (inbuf[offset + 6]&0xFFL ) << 48; // nobreak case 6: f = (inbuf[offset + 5]&0xFFL ) << 40; // nobreak case 5: e = (inbuf[offset + 4]&0xFFL ) << 32; // nobreak case 4: d = (inbuf[offset + 3]&0xFFL ) << 24; // nobreak case 3: c = (inbuf[offset + 2]&0xFFL ) << 16; // nobreak case 2: b = (inbuf[offset + 1]&0xFFL ) << 8; // nobreak case 1: a = (inbuf[offset] &0xFFL ); break; default: throw new IllegalArgumentException( "Wrong length: " + length); } return h|g|f|e|d|c|b|a; } /** * Returns the minimum bytes needed for the given value to encoded it in * little-endian format. Value must be positive. * @param value * @return */ public static byte[] serializeInt2MinLE( int value ) { if ( value < 0 ) { throw new IllegalArgumentException( "Negative input value" ); } ByteArrayOutputStream byteStream = new ByteArrayOutputStream( 4 ); do { byteStream.write( value & 0xFF); value >>= 8; } while ( value !=0 ); return byteStream.toByteArray(); } /** * Returns the minimum bytes needed for the given value to encoded it in * little-endian format. Value must be positive. * @param value * @return */ public static byte[] serializeInt2MinLE( long value ) { if ( value <= 0xFFFF ) { if ( value <= 0xFF ) { if ( value < 0 ) { throw new IllegalArgumentException( "Negative input value" ); } return new byte[] { (byte) value }; } return new byte[] { (byte) value, (byte) (value >> 8) }; } if ( value <= 0xFFFFFF ) { return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16) }; } return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16), (byte) (value >> 24) }; } /** * Returns the minimum number of bytes needed to encode it in little-endian * format. Value must be positive. * @param value */ public static byte[] serializeLong2MinLE( long value ) { if ( value <= 0xFFFFFFFFFFFFFFL ) { if ( value <= 0xFFFFFFFFFFFFL ) { if ( value <= 0xFFFFFFFFFFL ) { if ( value <= 0xFFFFFFFFL ) { if ( value <= 0xFFFFFFL ) { if ( value <= 0xFFFFL ) { if ( value <= 0xFFL ) { if ( value < 0 ) { throw new IllegalArgumentException( "value negative" ); } return new byte[] { (byte) value }; } return new byte[] { (byte) value, (byte) (value >> 8) }; } return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16) }; } return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16), (byte) (value >> 24) }; } return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16), (byte) (value >> 24), (byte) (value >> 32) }; } return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16), (byte) (value >> 24), (byte) (value >> 32), (byte) (value >> 40) }; } return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16), (byte) (value >> 24), (byte) (value >> 32), (byte) (value >> 40), (byte) (value >> 48) }; } return new byte[] { (byte) value, (byte) (value >> 8), (byte) (value >> 16), (byte) (value >> 24), (byte) (value >> 32), (byte) (value >> 40), (byte) (value >> 48), (byte) (value >> 56) }; } public static int deserializeInt( byte[] inbuf, int offset ) { return (inbuf[offset] ) << 24 | (inbuf[offset + 1] &0xff) << 16 | (inbuf[offset + 2] &0xff) << 8 | (inbuf[offset + 3] &0xff); } /** * Serialize a short, and convert it to little endian in the process * * @param value * @param outbuf * @param offset * @return int indicating the next offset */ public static int serializeShortLE(short value, byte[] outbuf, int offset) { outbuf[offset++] = (byte)(value); outbuf[offset++] = (byte)(value >> 8); // Return next offset. return offset; } /** * Converts a short to a little-endian byte representation and writes it to the * given stream. */ public static void serializeShortLE( short value, OutputStream outStream ) throws IOException { outStream.write( (byte)(value&0xFF) ); outStream.write( (byte)((value >> 8) &0xFF) ); } /** * Serialize a short, but do not convert it to little endian in the process * * @param value * @param outbuf * @param offset * @return int indicating the next offset */ public static int serializeShort(short value, byte[] outbuf, int offset) { outbuf[offset++] = (byte)(value >> 8); outbuf[offset++] = (byte)(value); // Return next offset. return offset; } /** * Serialize a short, but do not convert it to little endian in the process * given stream. */ public static void serializeShort( short value, OutputStream outStream ) throws IOException { outStream.write( (byte)((value >> 8) &0xFF) ); outStream.write( (byte)(value&0xFF) ); } /** * Deserialize a short, but do not convert it from little endian in the process * @param inbuf * @param offset * @return short */ public static short deserializeShort(byte[] inbuf, int offset) { return (short) ((inbuf[offset] &0xff) << 8 | (inbuf[offset + 1] &0xff)); } /** * Deserialize a short, but do not convert it from little endian in the process * @param inStream * @return short */ public static short deserializeShort( InputStream inStream ) throws IOException { int a = (inStream.read() & 0xFF) <<8; int b = inStream.read() & 0xFF; return (short) ( a | b ); } /** * Deserialize a short, and convert it from little endian in the process * @param inbuf * @param offset * @return short */ public static short deserializeShortLE(byte[] inbuf, int offset) { return (short) ((inbuf[offset + 1] &0xff) << 8 | (inbuf[offset] &0xff)); } /** * Deserialize a short, and convert it from little endian in the process * @param inbuf * @param offset * @return short */ public static short deserializeShortLE( InputStream inStream ) throws IOException { int a = inStream.read() & 0xFF; int b = (inStream.read() & 0xFF) <<8; return (short) ( b | a ); } public static int unsignedByte2int( byte x ) { return x & 0xFF; } public static int unsignedShort2Int( short x ) { return x & 0xFFFF; } public static long unsignedInt2Long( int x ) { return x & 0xFFFFFFFFL; } public static int castLong2Int( long x ) { if ( x >= Integer.MAX_VALUE) { return Integer.MAX_VALUE; } else if ( x <= Integer.MIN_VALUE) { return Integer.MIN_VALUE; } return (int)x; } public static int serializeString(String str, byte[] outbuf, int offset) { char[] chars = str.toCharArray(); // Strip off the hi-byte of the char. No good. for (int i = 0; i < chars.length; i++) { outbuf[offset] = (byte)chars[i]; offset++; } return offset; } public static int deserializeString(byte[] inbuf, int offset, StringBuffer outbuf) { int begin = offset; int maxLen = inbuf.length; while (offset < maxLen) { if (inbuf[offset] == 0) { // Note that the terminating 0 is not added in the returning offset. break; } offset++; } if (offset-begin > 0) outbuf.append(new String(inbuf, begin, offset-begin)); return offset; } public static int serializeIP(String ip, byte[] outbuf, int offset) { InetAddress inet = null; byte[] addrBuf; try { inet = InetAddress.getByName(ip); addrBuf = inet.getAddress(); } catch (Exception e) { addrBuf = new byte[4]; addrBuf[0] = (byte)'\0'; addrBuf[1] = (byte)'\0'; addrBuf[2] = (byte)'\0'; addrBuf[3] = (byte)'\0'; } outbuf[offset++] = addrBuf[0]; outbuf[offset++] = addrBuf[1]; outbuf[offset++] = addrBuf[2]; outbuf[offset++] = addrBuf[3]; return offset; } /** * */ public static byte serializeGUESSVersionFormat(int majorVersion, int minorVersion) throws IllegalArgumentException { if ( majorVersion < 0 || majorVersion >= 16 || minorVersion < 0 || minorVersion >= 16 ) { throw new IllegalArgumentException( "Version out of range."); } int guessVersion = majorVersion << 4; guessVersion |= minorVersion; return (byte)guessVersion; } /** * Reads the bytes of the stream till a byte has the value 0. * @param inStream * @return * @throws IOException */ public static byte[] readBytesToNull( InputStream inStream ) throws IOException { ByteArrayOutputStream outStream = new ByteArrayOutputStream(); int b; while( inStream.available() > 0 && (b=inStream.read())!=0 ) { outStream.write( b ); } return outStream.toByteArray(); } /** * Get the contents of an <code>InputStream</code> as a <code>byte[]</code>. * <p> * This method buffers the input internally, so there is no need to use a * <code>BufferedInputStream</code>. * * @param input the <code>InputStream</code> to read from * @return the requested byte array * @throws NullPointerException if the input is null * @throws IOException if an I/O error occurs */ public static byte[] toByteArray( InputStream input ) throws IOException { ByteArrayOutputStream output = new ByteArrayOutputStream(); copy( input, output ); return output.toByteArray(); } /** * Copy bytes from an <code>InputStream</code> to an * <code>OutputStream</code>. * <p> * This method buffers the input internally, so there is no need to use a * <code>BufferedInputStream</code>. * * @param input the <code>InputStream</code> to read from * @param output the <code>OutputStream</code> to write to * @return the number of bytes copied * @throws NullPointerException if the input or output is null * @throws IOException if an I/O error occurs * @since 1.1 */ public static int copy( InputStream input, OutputStream output ) throws IOException { byte[] buffer = new byte[4 * 1024]; int count = 0; int n = 0; while ( -1 != (n = input.read( buffer )) ) { output.write( buffer, 0, n ); count += n; } return count; } /** * Returns the logarithm to the based 2 of value. * @param num the number to determine the log2 of. This is expceted to be a * power of 2 */ public static byte calculateCeilLog2( int value ) { if (value <= 0x10000) if (value <= 0x100) if (value <= 0x10) if (value <= 0x4) if (value <= 0x2) if (value <= 0x1) return 0; else return 1; else return 2; else if (value <= 0x8) return 3; else return 4; else if (value <= 0x40) if (value <= 0x20) return 5; else return 6; else if (value <= 0x80) return 7; else return 8; else if (value <= 0x1000) if (value <= 0x400) if (value <= 0x200) return 9; else return 10; else if (value <= 0x800) return 11; else return 12; else if (value <= 0x4000) if (value <= 0x2000) return 13; else return 14; else if (value <= 0x8000) return 15; else return 16; else if (value <= 0x1000000) if (value <= 0x100000) if (value <= 0x40000) if (value <= 0x20000) return 17; else return 18; else if (value <= 0x80000) return 19; else return 20; else if (value <= 0x400000) if (value <= 0x200000) return 21; else return 22; else if (value <= 0x800000) return 23; else return 24; else if (value <= 0x10000000) if (value <= 0x4000000) if (value <= 0x2000000) return 25; else return 26; else if (value <= 0x8000000) return 27; else return 28; else if (value <= 0x40000000) if (value <= 0x20000000) return 29; else return 30; else return 31; } /** * Returns the logarithm to the based 2 of value. * @param num the number to determine the log2 of. This is expceted to be a * power of 2 */ public static byte calculateLog2( int value ) { if (value < 0x10000) if (value < 0x100) if (value < 0x10) if (value < 0x4) if (value < 0x2) return 0; else return 1; else if (value < 0x8) return 2; else return 3; else if (value < 0x40) if (value < 0x20) return 4; else return 5; else if (value < 0x80) return 6; else return 7; else if (value < 0x1000) if (value < 0x400) if (value < 0x200) return 8; else return 9; else if (value < 0x800) return 10; else return 11; else if (value < 0x4000) if (value < 0x2000) return 12; else return 13; else if (value < 0x8000) return 14; else return 15; else if (value < 0x1000000) if (value < 0x100000) if (value < 0x40000) if (value < 0x20000) return 16; else return 17; else if (value < 0x80000) return 18; else return 19; else if (value < 0x400000) if (value < 0x200000) return 20; else return 21; else if (value < 0x800000) return 22; else return 23; else if (value < 0x10000000) if (value < 0x4000000) if (value < 0x2000000) return 24; else return 25; else if (value < 0x8000000) return 26; else return 27; else if (value < 0x40000000) if (value < 0x20000000) return 28; else return 29; else return 30; } /** * Returns the number of significant bits of num. * @param num the number to determine the significant number of bits from. */ public static int determineBitCount( int num ) { if ( num < 0 ) { return 32; } if (num < 0x10000) if (num < 0x100) if (num < 0x10) if (num < 0x4) if (num < 0x2) if ( num == 0x0 ) return 0; else return 1; else return 2; else if (num < 0x8) return 3; else return 4; else if (num < 0x40) if (num < 0x20) return 5; else return 6; else if (num < 0x80) return 7; else return 8; else if (num < 0x1000) if (num < 0x400) if (num < 0x200) return 9; else return 10; else if (num < 0x800) return 11; else return 12; else if (num < 0x4000) if (num < 0x2000) return 13; else return 14; else if (num < 0x8000) return 15; else return 16; else if (num < 0x1000000) if (num < 0x100000) if (num < 0x40000) if (num < 0x20000) return 17; else return 18; else if (num < 0x80000) return 19; else return 20; else if (num < 0x400000) if (num < 0x200000) return 21; else return 22; else if (num < 0x800000) return 23; else return 24; else if (num < 0x10000000) if (num < 0x4000000) if (num < 0x2000000) return 25; else return 26; else if (num < 0x8000000) return 27; else return 28; else if (num < 0x40000000) if (num < 0x20000000) return 29; else return 30; else return 31; } /** * Uses a zip compression to compress a given data array. */ public static byte[] deflate( byte[] data ) { try { ByteArrayOutputStream outStream = new ByteArrayOutputStream(); DeflaterOutputStream compressor = new DeflaterOutputStream( outStream ); compressor.write( data, 0, data.length ); compressor.close(); return outStream.toByteArray(); } catch ( IOException exp ) { NLogger.error( IOUtil.class , exp, exp ); // this should never occur... throw new RuntimeException( exp ); } } /** * Uses a zlib compression to decompress a given data array. */ public static byte[] inflate( Inflater inflater, byte[] data ) throws DataFormatException { // The use of InflaterInputStream causes an error when inflating data. //InflaterInputStream inflaterStream = new InflaterInputStream( // new ByteArrayInputStream( data ), inflater ); ByteArrayOutputStream outStream = new ByteArrayOutputStream(); inflater.setInput( data ); byte[] buffer = new byte[1024]; int lengthRead = 0; do { lengthRead = inflater.inflate( buffer ); if ( lengthRead > 0 ) { outStream.write( buffer, 0, lengthRead ); } } while ( lengthRead > 0 ); return outStream.toByteArray(); } /** * Uses a zlib compression to decompress a given data array. */ public static byte[] inflate( byte[] data ) throws DataFormatException { return inflate( new Inflater(), data ); } /** * Use COBS to encode a byte array. * The eliminated byte value is 0x00 * http://www.acm.org/sigcomm/sigcomm97/papers/p062.pdf */ public static byte[] cobsEncode( byte[] data ) { try { ByteArrayOutputStream outStream = new ByteArrayOutputStream(); ByteArrayOutputStream tempBuffer = new ByteArrayOutputStream(); int code = 0x01; for ( int i = 0; i < data.length; i++ ) { if ( data[ i ] == 0x00 ) { outStream.write( code ); outStream.write( tempBuffer.toByteArray() ); tempBuffer.reset(); code = (byte) 0x01; } else { tempBuffer.write( data[ i ] ); code++; if (code == 0xFF) { outStream.write( code ); outStream.write( tempBuffer.toByteArray() ); tempBuffer.reset(); code = (byte) 0x01; } } } outStream.write( code ); outStream.write( tempBuffer.toByteArray() ); return outStream.toByteArray(); } catch ( IOException exp ) { NLogger.error( IOUtil.class , exp, exp ); // this should never occur... throw new RuntimeException( exp ); } } /** * Use COBS to decode a COBS-encoded byte array. * The eliminated byte value is 0x00 * http://www.acm.org/sigcomm/sigcomm97/papers/p062.pdf * @return the decoded byte array.. * @throws IOException */ public static byte[] cobsDecode( byte[] data ) throws IOException { ByteArrayOutputStream outStream = new ByteArrayOutputStream(); int index = 0; int code = 0x00; while ( index < data.length ) { code = unsignedByte2int( data[ index++ ] ); if ( ( index + ( code-2 ) ) >= data.length ) { if ( NLogger.isWarnEnabled( IOUtil.class ) ) { NLogger.warn( IOUtil.class, "Invalid COBS InputData: " + HexConverter.toHexString(data) ); } throw new IOException("Invalid COBS InputData" ); } for (int i = 1; i < code; i++) { outStream.write( (int)data[index++] ); } if (code < 0xFF && index < data.length) { outStream.write( 0 ); } } return outStream.toByteArray(); } /** * Unconditionally close an <code>OutputStream</code>. * Equivalent to {@link OutputStream#close()}, except any exceptions will be ignored. * @param output A (possibly null) OutputStream */ public static void closeQuietly( OutputStream output ) { if( output == null ) { return; } try { output.close(); } catch( IOException ioe ) { } } /** * Unconditionally close a <code>Socket</code>. * Equivalent to {@link Socket#close()}, except any exceptions will be ignored. * @param socket A (possibly null) Socket */ public static void closeQuietly( Socket socket ) { if( socket == null ) { return; } try { socket.close(); } catch( IOException ioe ) { } } /** * Unconditionally close a <code>Socket</code>. * Equivalent to {@link Socket#close()}, except any exceptions will be ignored. * @param socket A (possibly null) Socket */ public static void closeQuietly( SocketFacade socket ) { if( socket == null ) { return; } try { socket.close(); } catch( IOException ioe ) { } } /** * Unconditionally close an <code>InputStream</code>. * Equivalent to {@link InputStream#close()}, except any exceptions will be ignored. * @param input A (possibly null) InputStream */ public static void closeQuietly( InputStream input ) { if( input == null ) { return; } try { input.close(); } catch( IOException ioe ) { } } /** * Unconditionally close an <code>Writer</code>. * Equivalent to {@link Writer#close()}, except any exceptions will be ignored. * @param writer A (possibly null) Writer */ public static void closeQuietly( Writer writer ) { if( writer == null ) { return; } try { writer.close(); } catch( IOException ioe ) { } } /** * Unconditionally close an <code>Reader</code>. * Equivalent to {@link Reader#close()}, except any exceptions will be ignored. * @param reader A (possibly null) Reader */ public static void closeQuietly( Reader reader ) { if( reader == null ) { return; } try { reader.close(); } catch( IOException ioe ) { } } /** * Unconditionally close an <code>InputStream</code>. * Equivalent to {@link InputStream#close()}, except any exceptions will be ignored. * @param input A (possibly null) InputStream */ public static void closeQuietly( RandomAccessFile raf ) { if( raf == null ) { return; } try { raf.close(); } catch( IOException ioe ) { } } /** * Unconditionally close a <code>ManagedFile</code>. * Equivalent to {@link ManagedFile#closeFile()}, except any exceptions will be ignored. * @param input A (possibly null) InputStream */ public static void closeQuietly( ManagedFile file ) { if( file == null ) { return; } try { file.closeFile(); } catch( ManagedFileException exp ) { } } /** * Unconditionally close a <code>ManagedFile</code>. * Equivalent to {@link ManagedFile#closeFile()}, except any exceptions will be ignored. * @param input A (possibly null) InputStream */ public static void closeQuietly( ReadOnlyManagedFile file ) { if( file == null ) { return; } try { file.closeFile(); } catch( ManagedFileException exp ) { } } }

The table below shows all metrics for IOUtil.java.

Metric	Value	Description
BLOCKS	112.00	Number of blocks
BLOCK_COMMENT	21.00	Number of block comment lines
COMMENTS	223.00	Comment lines
COMMENT_DENSITY	0.45	Comment density
COMPARISONS	145.00	Number of comparison operators
CYCLOMATIC	209.00	Cyclomatic complexity
DECL_COMMENTS	34.00	Comments in declarations
DOC_COMMENT	182.00	Number of javadoc comment lines
ELOC	494.00	Effective lines of code
EXEC_COMMENTS	18.00	Comments in executable code
EXITS	34.00	Procedure exits
FUNCTIONS	45.00	Number of function declarations
HALSTEAD_DIFFICULTY	109.99	Halstead difficulty
HALSTEAD_EFFORT	0.00	Halstead effort
INTERFACE_COMPLEXITY	258.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	9.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	1.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	10.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	143.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	1.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	288.00	JAVA0076 Use of magic number
JAVA0077	0.00	JAVA0077 Private field not used in declaring class
JAVA0078	0.00	JAVA0078 Floating point values compared with ==
JAVA0079	0.00	JAVA0079 Use of instance to reference static member
JAVA0080	0.00	JAVA0080 Import declaration not used
JAVA0081	0.00	JAVA0081 Boolean literal in comparison
JAVA0082	0.00	JAVA0082 Unnecessary widening cast
JAVA0083	0.00	JAVA0083 Unnecessary instanceof test
JAVA0084	0.00	JAVA0084 Should use compound assignment operator
JAVA0085	0.00	JAVA0085 Use of sun.* class
JAVA0087	0.00	JAVA0087 Use of Thread.sleep()
JAVA0089	0.00	JAVA0089 Use of restricted package
JAVA0092	0.00	JAVA0092 Use of restricted type
JAVA0093	0.00	JAVA0093 Redundant assignment
JAVA0094	0.00	JAVA0094 Field hides a superclass field
JAVA0095	0.00	JAVA0095 Uninitialized private field
JAVA0096	0.00	JAVA0096 Field in nested class hides outer field
JAVA0098	0.00	JAVA0098 Minimize use of implicit field initializers
JAVA0100	0.00	JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101	0.00	JAVA0101 Unnecessary modifier for field in interface
JAVA0102	0.00	JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103	0.00	JAVA0103 Explicit call to finalize()
JAVA0104	0.00	JAVA0104 finalize() only calls super.finalize()
JAVA0105	0.00	JAVA0105 Duplicate import declaration
JAVA0106	0.00	JAVA0106 Unnecessary import from current package
JAVA0108	20.00	JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109	7.00	JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110	9.00	JAVA0110 Incorrect javadoc: no @return tag
JAVA0111	0.00	JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112	0.00	JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113	0.00	JAVA0113 Incorrect javadoc: no @author tag
JAVA0114	0.00	JAVA0114 Incorrect javadoc: no @version tag
JAVA0115	8.00	JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116	1.00	JAVA0116 Missing javadoc: field 'field'
JAVA0117	12.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	1.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	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	1.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	14.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	2.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	1028.00	Number of lines in the source file
LINE_COMMENT	20.00	Number of line comments
LOC	723.00	Lines of code
LOGICAL_LINES	301.00	Number of statements
LOOPS	9.00	Number of loops
NEST_DEPTH	9.00	Maximum nesting depth
OPERANDS	1264.00	Number of operands
OPERATORS	3073.00	Number of operators
PARAMS	71.00	Number of formal parameter declarations
PROGRAM_LENGTH	4337.00	Halstead program length
PROGRAM_VOCAB	398.00	Halstead program vocabulary
PROGRAM_VOLUME	0.00	Halstead program volume
RETURNS	187.00	Number of return points from functions
SIZE	32323.00	Size of the file in bytes
UNIQUE_OPERANDS	339.00	Number of unique operands
UNIQUE_OPERATORS	59.00	Number of unique operators
WHITESPACE	82.00	Number of whitespace lines

Enerjy

Explore.

IOUtil.java