IOUtilities.java
| Index Score | ||
|---|---|---|
 |
 |
util.io |
 |
 |
TV-Browser |
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 | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| INTERFACE_COMPLEXITY | Interface complexity | |
| COMMENTS | Comment lines | |
| PARAMS | Number of formal parameter declarations | |
| RETURNS | Number of return points from functions | |
| DECL_COMMENTS | Comments in declarations | |
| SIZE | Size of the file in bytes | |
| LINES | Number of lines in the source file | |
| BLOCKS | Number of blocks | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| EXITS | Procedure exits | |
| COMPARISONS | Number of comparison operators | |
| JAVA0008 | JAVA0008 Empty catch block | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| CYCLOMATIC | Cyclomatic complexity | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0076 | JAVA0076 Use of magic number | |
| OPERATORS | Number of operators | |
| LOOPS | Number of loops | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| OPERANDS | Number of operands | |
| LINE_COMMENT | Number of line comments | |
| LOC | Lines of code | |
| LOGICAL_LINES | Number of statements | |
| ELOC | Effective lines of code | |
| FUNCTIONS | Number of function declarations | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* TV-Browser
* Copyright (C) 04-2003 Martin Oberhauser (martin_oat@yahoo.de)
*
* 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.
*
* CVS information:
* $RCSfile$
* $Source$
* $Date: 2007-07-28 13:00:01 -0400 (Sat, 28 Jul 2007) $
* $Author: bananeweizen $
* $Revision: 3552 $
*/
package util.io;
import tvbrowser.core.Settings;
import util.ui.TimeFormatter;
import java.awt.Graphics2D;
import java.awt.image.BufferedImage;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.util.Calendar;
import java.util.zip.GZIPInputStream;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import javax.imageio.ImageIO;
import javax.swing.ImageIcon;
import org.apache.commons.codec.binary.Base64;
/**
* A utilities class for I/O stuff. It constists of serveral static
* methods that perform some usefull things.
*
* @author Til Schneider, www.murfman.de
*/
public class IOUtilities {
/** The logger for this class. */
private static java.util.logging.Logger mLog
= java.util.logging.Logger.getLogger(IOUtilities.class.getName());
/** A Calendar for time stuff */
private static final Calendar CALENDAR = Calendar.getInstance();
/** Formatting the Time */
private static final TimeFormatter TIME_FORMATTER = new TimeFormatter();
/**
* Downloads a file from a HTTP server.
*
* @param url The URL of the file to download.
* @param targetFile The file where to store the downloaded data.
* @throws IOException When download or saving failed.
* @see #loadFileFromHttpServer(URL)
*/
public static void download(URL url, File targetFile) throws IOException {
mLog.info("Downloading '" + url + "' to '"
+ targetFile.getAbsolutePath() + "'");
InputStream stream = null;
try {
stream = new BufferedInputStream(getStream(url), 0x4000);
if (stream == null) {
throw new IOException("Can't connect to '" + url + "'!");
}
saveStream(stream, targetFile);
}
finally {
try {
if (stream != null) stream.close();
} catch (IOException exc) {}
}
}
/**
* Saves the data from an InputStream into a file.
*
* @param stream The stream to read the data from.
* @param targetFile The file where to store the data.
* @throws IOException When saving failed or when the InputStream throws an
* IOException.
*/
public static void saveStream(InputStream stream, File targetFile)
throws IOException
{
BufferedOutputStream out = null;
try {
out = new BufferedOutputStream(new FileOutputStream(targetFile), 0x4000);
pipeStreams(stream, out);
}
finally {
try {
if (out != null) out.close();
} catch (IOException exc) {}
}
}
/**
* Gets an InputStream to the given URL.
* <p>
* The connection has the Settings.propDefaultNetworkConnectionTimeout
* as connection timeout.
*
* @param page The page to get the stream to.
* @param followRedirects If the stream should be also established if the page not exists
* at the location but contains a redirect to an other location.
* @return The stream to the page.
* @throws IOException Thrown if something goes wrong.
*/
public static InputStream getStream(URL page, boolean followRedirects) throws IOException {
return getStream(page, followRedirects, Settings.propDefaultNetworkConnectionTimeout.getInt());
}
/**
* Originally copied from javax.swing.JEditorPane.
* <p>
* Fetches a stream for the given URL, which is about to
* be loaded by the <code>setPage</code> method. By
* default, this simply opens the URL and returns the
* stream. This can be reimplemented to do useful things
* like fetch the stream from a cache, monitor the progress
* of the stream, etc.
* <p>
* This method is expected to have the the side effect of
* establishing the content type, and therefore setting the
* appropriate <code>EditorKit</code> to use for loading the stream.
* <p>
* If this the stream was an http connection, redirects
* will be followed and the resulting URL will be set as
* the <code>Document.StreamDescriptionProperty</code> so that relative
* URL's can be properly resolved.
*
* @param page the URL of the page
* @param followRedirects Follow redirects.
* @param timeout The read timeout.
* @throws IOException if something went wrong.
* @return a stream reading data from the specified URL.
*/
public static InputStream getStream(URL page, boolean followRedirects, int timeout) throws IOException {
return getStream(page, followRedirects, timeout, null, null);
}
/**
* Originally copied from javax.swing.JEditorPane.
* <p>
* Fetches a stream for the given URL, which is about to
* be loaded by the <code>setPage</code> method. By
* default, this simply opens the URL and returns the
* stream. This can be reimplemented to do useful things
* like fetch the stream from a cache, monitor the progress
* of the stream, etc.
* <p>
* This method is expected to have the the side effect of
* establishing the content type, and therefore setting the
* appropriate <code>EditorKit</code> to use for loading the stream.
* <p>
* If this the stream was an http connection, redirects
* will be followed and the resulting URL will be set as
* the <code>Document.StreamDescriptionProperty</code> so that relative
* URL's can be properly resolved.
*
* @param page the URL of the page
* @param followRedirects Follow redirects.
* @param timeout The read timeout.
* @param userName The user name to use for the connection.
* @param userPassword The password to use for the connection.
* @throws IOException if something went wrong.
* @return a stream reading data from the specified URL.
*/
public static InputStream getStream(URL page, boolean followRedirects, int timeout, String userName, String userPassword)
throws IOException
{
URLConnection conn = page.openConnection();
if(userName != null && userPassword != null) {
String password = userName + ":" + userPassword;
String encodedPassword = new String(Base64.encodeBase64(password.getBytes()));
conn.setRequestProperty ("Authorization", "Basic " + encodedPassword);
}
if (timeout > 0) {
conn.setReadTimeout(timeout);
}
if (followRedirects && (conn instanceof HttpURLConnection)) {
HttpURLConnection hconn = (HttpURLConnection) conn;
hconn.setInstanceFollowRedirects(false);
int response = hconn.getResponseCode();
boolean redirect = (response >= 300 && response <= 399);
// In the case of a redirect, we want to actually change the URL
// that was input to the new, redirected URL
if (redirect) {
String loc = conn.getHeaderField("Location");
if (loc == null) {
throw new FileNotFoundException("URL points to a redirect without "
+ "target location: " + page);
}
if (loc.startsWith("http")) {
page = new URL(loc);
} else {
page = new URL(page, loc);
}
return getStream(page, followRedirects, timeout, userName, userPassword);
}
}
InputStream in = conn.getInputStream();
return in;
}
/**
* Gets an InputStream to the given URL.
* <p>
* The connection has the Settings.propDefaultNetworkConnectionTimeout
* as connection timeout.
*
* @param page The page to get the stream to.
* @return The stream to the page.
* @throws IOException Thrown if something goes wrong.
*/
public static InputStream getStream(URL page)
throws IOException
{
return getStream(page, true, Settings.propDefaultNetworkConnectionTimeout.getInt());
}
/**
* Gets an InputStream to the given URL.
* <p>
* The connection has the given timeout
* as connection timeout.
*
* @param page The page to get the stream to.
* @param timeout The timeout for the connection, use 0 for no timeout.
* @return The stream to the page.
* @throws IOException Thrown if something goes wrong.
*/
public static InputStream getStream(URL page, int timeout)
throws IOException
{
return getStream(page, true, timeout);
}
/**
* Loads a file from a Http server.
* <p>
* The connection has the Settings.propDefaultNetworkConnectionTimeout
* as connection timeout.
*
* @param url The URL of the file
* @return The content of the file
* @throws IOException When the download failed
* @see #download(URL, File)
*/
public static byte[] loadFileFromHttpServer(URL url) throws IOException {
return loadFileFromHttpServer(url, Settings.propDefaultNetworkConnectionTimeout.getInt());
}
/**
* Loads a file from a Http server with the given
* read timeout.
*
* @param url The URL of the file
* @param timeout The read timeout for the connection.
* @return The content of the file
* @throws IOException When the download failed
* @see #download(URL, File)
*/
public static byte[] loadFileFromHttpServer(URL url, int timeout) throws IOException {
InputStream in = null;
try {
in = IOUtilities.getStream(url, timeout);
ByteArrayOutputStream out = new ByteArrayOutputStream();
pipeStreams(in, out);
out.close();
return out.toByteArray();
}
finally {
if (in != null) {
try { in.close(); } catch (IOException exc) {}
}
}
}
/**
* Pipes all data from the specified InputStream to the specified OutputStream,
* until the InputStream has no more data.
* <p>
* Note: None of the streams is closed! You have to do that for yourself!
*
* @param from The stream to read the data from.
* @param to The stream to write the data to.
* @throws IOException Thrown if something goes wrong.
*/
public static void pipeStreams(InputStream from, OutputStream to)
throws IOException
{
int len;
byte[] buffer = new byte[10240];
while ((len = (from.read(buffer))) != -1) {
to.write(buffer, 0, len);
}
}
/**
* Pipes all data from the specified Reader to the specified Writer,
* until the Reader has no more data.
* <p>
* Note: The Reader and the Writer are not closed! You have to do that for
* yourself!
*
* @param reader The Reader to read the data from.
* @param writer The Writer to write the data to.
* @throws IOException Thrown if something goes wrong.
*/
public static void pipe(Reader reader, Writer writer) throws IOException {
int len;
char[] buffer = new char[10240];
while ((len = (reader.read(buffer))) != -1) {
writer.write(buffer, 0, len);
}
}
private static void copyFile(File src, File targetDir, boolean onlyNew) throws IOException {
File destFile = new File(targetDir, src.getName());
copy(src, destFile, onlyNew);
}
private static File createDirectory(File targetDir, String dirName) throws IOException {
File f = new File(targetDir.getAbsolutePath()+"/"+dirName);
if (!f.exists()) {
if (!f.mkdirs()) {
throw new IOException("Could not create directory '"+f.getAbsolutePath()+"'");
}
}
return f;
}
/**
* Copies files given in source to the target directory.
*
* @param src The files to copy.
* @param targetDir The target dir of the files.
* @throws IOException Thrown if something goes wrong.
*/
public static void copy(File[] src, File targetDir) throws IOException {
copy(src, targetDir, false);
}
/**
* Copies files given in source to the target directory.
*
* @param src The files to copy.
* @param targetDir The target dir of the files.
* @param onlyNew Overwrite only older files.
* @throws IOException Thrown if something goes wrong.
* @since 2.2.2/2.5.1
*/
public static void copy(File[] src, File targetDir, boolean onlyNew) throws IOException {
copy(targetDir,src,targetDir, onlyNew);
}
private static void copy(File firstTargetDir, File[] src, File targetDir, boolean onlyNew) throws IOException {
// src might be null, if listFiles wasn't able to read the directory
if (src == null) {
return;
}
for (int i=0; i<src.length; i++) {
if (src[i].isDirectory() && !src[i].equals(targetDir) && !src[i].equals(firstTargetDir)) {
File newDir = createDirectory(targetDir, src[i].getName());
copy(firstTargetDir,src[i].listFiles(), newDir, onlyNew);
}
else {
copyFile(src[i], targetDir, onlyNew);
}
}
}
/**
* Copies a file.
*
* @param src The file to read from
* @param target The file to write to
* @throws IOException If copying failed
*/
public static void copy(File src, File target) throws IOException {
copy(src, target, false);
}
/**
* Copies a file.
*
* @param src The file to read from
* @param target The file to write to
* @param onlyNew Overwrite only older files.
* @throws IOException If copying failed
* @since 2.2.2/2.5.1
*/
public static void copy(File src, File target, boolean onlyNew) throws IOException {
BufferedInputStream in = null;
BufferedOutputStream out = null;
try {
FileOutputStream outFile = new FileOutputStream(target);
in = new BufferedInputStream(new FileInputStream(src), 0x4000);
out = new BufferedOutputStream(outFile, 0x4000);
if(!onlyNew || target.length() < 1 || (src.lastModified() > target.lastModified())) {
outFile.getChannel().truncate(0);
pipeStreams(in, out);
}
in.close();
out.close();
}
finally {
if (in != null) {
try { in.close(); } catch (IOException exc) {}
}
if (out != null) {
try { out.close(); } catch (IOException exc) {}
}
}
}
/**
* Deletes a directory with all its files and subdirectories.
*
* @param dir The directory to delete.
* @throws IOException Thrown if something goes wrong.
*/
public static void deleteDirectory(File dir) throws IOException {
if (! dir.exists()) {
// Nothing to do
return;
}
if (! dir.isDirectory()) {
throw new IOException("File is not a directory: " + dir.getAbsolutePath());
}
// Delete all the files and subdirectories
File[] fileArr = dir.listFiles();
if (fileArr != null) {
for (int i = 0; i < fileArr.length; i++) {
if (fileArr[i].isDirectory()) {
deleteDirectory(fileArr[i]);
} else {
if (! fileArr[i].delete()) {
throw new IOException("Can't delete file: " + fileArr[i].getAbsolutePath());
}
}
}
}
// Delete the directory
if (! dir.delete()) {
throw new IOException("Can't delete directory: " + dir.getAbsolutePath());
}
}
/**
* LÔøΩdt eine Datei aus einem Jar-File und gibt sie zurÔøΩck.
* <P>
* Ist keine Datei mit diesem Namen im Jar-File, so wird versucht, sie vom
* Dateisystem zu laden.
*
* @param fileName Der Name der Datei. (Ist case-sensitive!).
* @param srcClass Eine Klasse, aus deren Jar-File das Image geladen werden soll.
* @return The file loaded from the jar file as byte array.
*
* @throws IOException Wenn ein Fehler beim Laden der Datei auftrat.
*/
public static byte[] loadFileFromJar(String fileName, Class srcClass)
throws IOException
{
if (fileName == null) throw new IllegalArgumentException("fileName == null");
if (fileName.length() == 0) throw new IllegalArgumentException("fileName is empty");
// if (srcClass == null) srcClass = IOUtilities.class;
// Der Dateiname muss mit einem '/' anfangen, sonst wird er nicht gefunden.
InputStream in;
if (srcClass==null) {
in=new java.io.FileInputStream(fileName);
}
else {
if ((fileName.charAt(0) != '/') && (fileName.charAt(0) != '\\')) {
fileName = "/" + fileName;
}
in = srcClass.getResourceAsStream(fileName);
}
if (in == null) {
throw new IOException("Resource not found: '" + fileName + "'");
}
byte[] buffer = new byte[10240];
byte[] data = new byte[0];
int len;
while ((len = in.read(buffer)) != -1) {
// data Array vergrÔøΩÔøΩern
byte[] oldData = data;
data = new byte[oldData.length + len];
System.arraycopy(oldData, 0, data, 0, oldData.length);
// Gerade gelesene Daten anhÔøΩngen
System.arraycopy(buffer, 0, data, oldData.length, len);
}
return data;
}
/**
* Unzips a file from a ZIP-Archive (.zip, .jar).
* <p>
* Currently not used.
*
* @param srcFile The ZIP-File to read the data from.
* @param entryName The name of the file in the ZIP-archive to unzip.
* @param targetFile The file where to store the data.
* @throws IOException Thrown if something goes wrong.
*/
public static void unzip(File srcFile, String entryName, File targetFile)
throws IOException
{
mLog.info("Unzipping '" + entryName + "' from '"
+ srcFile.getAbsolutePath() + "' to '" + targetFile.getAbsolutePath() + "'");
InputStream stream = null;
try {
ZipFile zipFile = new ZipFile(srcFile);
ZipEntry entry = new ZipEntry(entryName);
stream = zipFile.getInputStream(entry);
if (stream == null) {
throw new IOException("Can't unzip '" + entryName + "' from '"
+ srcFile.getAbsolutePath() + "'!");
}
saveStream(stream, targetFile);
}
finally {
try {
if (stream != null) stream.close();
} catch (IOException exc) {}
}
}
/**
* Unzips a GZIP-file (.gz).
*
* @param srcFile The GZIP-File to unzip
* @param targetFile The file where to store the data.
* @throws IOException Thrown if something goes wrong.
*/
public static void ungzip(File srcFile, File targetFile)
throws IOException
{
mLog.info("Ungzipping '" + srcFile.getAbsolutePath() +
"' to '" + targetFile.getAbsolutePath() + "'");
InputStream stream = null;
GZIPInputStream gzipStream = null;
try {
stream = new BufferedInputStream(new FileInputStream(srcFile), 0x4000);
gzipStream = new GZIPInputStream(stream);
saveStream(gzipStream, targetFile);
}
finally {
try {
if (gzipStream != null) gzipStream.close();
if (stream != null) stream.close();
} catch (IOException exc) {}
}
}
/**
* Appends an integer to a StringBuffer. If the length of the integer's
* String representation is smaller than minChars, the missing chars will be
* filled as nulls ('0') as postfix.
*
* @param buffer The buffer where to append the integer.
* @param number The integer to append.
* @param minChars The minimum number of chars.
*/
public static void append(StringBuffer buffer, int number, int minChars) {
String asString = Integer.toString(number);
for (int i = asString.length(); i < minChars; i++) {
buffer.append('0');
}
buffer.append(asString);
}
/**
* Replaces a substring in the specified String.
*
* @param original The String to replace the substring in.
* @param pattern The pattern to replace.
* @param str The String to replace. This string may contain the pattern.
* @return The result.
*/
public static String replace(String original, String pattern, String str) {
StringBuffer buffer = new StringBuffer(original);
replace(buffer, pattern, str);
return buffer.toString();
}
/**
* Replaces in <code>buffer</code> the <code>pattern</code> by <code>str</code>.
*
* @param buffer The buffer to replace in.
* @param pattern The pattern to replace.
* @param str The str that should replace the pattern.
*/
public static void replace(StringBuffer buffer, String pattern, String str) {
int offset = 0;
int patternIdx;
do {
patternIdx = buffer.indexOf(pattern, offset);
if (patternIdx != -1) {
buffer.replace(patternIdx, patternIdx + pattern.length(), str);
}
offset = patternIdx + str.length();
} while (patternIdx != -1);
}
/**
* Clears an StringBuffer
*
* @param buffer The buffer to clear
*/
public static void clear(StringBuffer buffer) {
buffer.delete(0, buffer.length());
}
/**
* Gets the number of minutes since midnight
* <p>
* This method does not create any objects.
*
* @return The number of minutes since midnight as integer
*/
public static int getMinutesAfterMidnight() {
synchronized(CALENDAR) {
CALENDAR.setTimeInMillis(System.currentTimeMillis());
return CALENDAR.get(Calendar.HOUR_OF_DAY) * 60 + CALENDAR.get(Calendar.MINUTE);
}
}
/**
* Gets a String representation in the format h:mm for a time in minutes after
* midnight.
*
* @param minutesAfterMidnight The time to get the String for
* @return A String for the time
*/
public static String timeToString(int minutesAfterMidnight) {
minutesAfterMidnight = minutesAfterMidnight % (24*60);
int hours = minutesAfterMidnight / 60;
int minutes = minutesAfterMidnight % 60;
return TIME_FORMATTER.formatTime(hours, minutes);
}
/**
* Gets the number of days since 1st Jan 1970.
* <p>
* This method does not create any objects.
*
* @deprecated
*/
public static int getDaysSince1970() {
synchronized(CALENDAR) {
// System.currentTimeMillis() deliveres the GMT, so we have to add the
// time zone offset.
int zoneOffset = CALENDAR.get(Calendar.ZONE_OFFSET);
int daylight = CALENDAR.get(Calendar.DST_OFFSET);
long millis = System.currentTimeMillis() + zoneOffset + daylight;
return (int) (millis / 1000L / 60L / 60L / 24L);
//return (int)(System.currentTimeMillis()/86400000L);
}
}
/**
* Encodes the specified String using a simple XOR encryption.
*
* @param text The text to encode
* @param seed The seed of the Random object to use for getting the keys
* @return The encoded String
*/
public static String xorEncode(String text, long seed) {
java.util.Random rnd = new java.util.Random(seed);
char[] charArr = new char[text.length()];
for (int i = 0; i < charArr.length; i++) {
charArr[i] = (char)(text.charAt(i) ^ rnd.nextInt()); // XOR
}
return new String(charArr);
}
/**
* Decodes the specified String using a simple XOR encryption.
*
* @param text The text to encode
* @param seed The seed of the Random object to use for getting the keys
* @return The decoded String
*/
public static String xorDecode(String text, long seed) {
// We use XOR encoding -> encoding and decoding are the same
return xorEncode(text, seed);
}
/**
* Reads a number of bytes into an array.
*
* @param stream The stream to read from
* @param length The number of bytes to read
* @return An array containing the read bytes
* @throws IOException When the end of the stream has been reached or
* reading failed
*/
public static byte[] readBinaryData(InputStream stream, int length)
throws IOException
{
byte[] data = new byte[length];
int offset = 0;
while (offset < length) {
int len = stream.read(data, offset, length - offset);
if (len == -1) {
throw new IOException("Unexpected end of stream");
}
offset += len;
}
return data;
}
/**
* Reads all Bytes from a File into an byte array
*
* @param file Read Bytes from this File
* @return Byte-Array or NULL if too large
* @throws IOException Read-Exception
*
* @since 2.5
*/
public static byte[] getBytesFromFile(File file) throws IOException {
InputStream is = new FileInputStream(file);
// Get the size of the file
long length = file.length();
// You cannot create an array using a long type.
// It needs to be an int type.
// Before converting to an int type, check
// to ensure that file is not larger than Integer.MAX_VALUE.
if (length > Integer.MAX_VALUE) {
return null;
}
// Create the byte array to hold the data
byte[] bytes = new byte[(int) length];
// Read in the bytes
int offset = 0;
int numRead = 0;
while (offset < bytes.length
&& (numRead = is.read(bytes, offset, bytes.length - offset)) >= 0) {
offset += numRead;
}
// Ensure all the bytes have been read in
if (offset < bytes.length) {
throw new IOException("Could not completely read file " + file.getName());
}
// Close the input stream and return bytes
is.close();
return bytes;
}
/**
* Writes the given image icon to the given file in the given imageType.
*
* @param icon The icon to write.
* @param imageType The image type.
* @param targetFile The file to write the image to.
*
* @return <code>True</code> if the file could be written, <code>false</code> if something went wrong.
* @since 2.6
*/
public static boolean writeImageIconToFile(ImageIcon icon, String imageType, File targetFile) {
try {
BufferedImage iconimage = new BufferedImage(icon.getIconWidth(),icon.getIconWidth(), BufferedImage.TYPE_INT_ARGB);
Graphics2D g2 = iconimage.createGraphics();
icon.paintIcon(null, g2, 0, 0);
g2.dispose();
ImageIO.write(iconimage, imageType , targetFile);
}catch(Exception e) {
return false;
}
return true;
}
/**
* Read the image from the given file to an icon image.
*
* @param srcFile The file to read from.
*
* @return The read icon image or <code>null</code> if something went wrong.
* @since 2.6
*/
public static ImageIcon readImageIconFromFile(File srcFile) {
try {
return new ImageIcon(ImageIO.read(srcFile));
}catch(Exception e) {}
return null;
}
}
The table below shows all metrics for IOUtilities.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 110.00 | Number of blocks | |
| BLOCK_COMMENT | 25.00 | Number of block comment lines | |
| COMMENTS | 367.00 | Comment lines | |
| COMMENT_DENSITY | 1.19 | Comment density | |
| COMPARISONS | 71.00 | Number of comparison operators | |
| CYCLOMATIC | 97.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 37.00 | Comments in declarations | |
| DOC_COMMENT | 319.00 | Number of javadoc comment lines | |
| ELOC | 308.00 | Effective lines of code | |
| EXEC_COMMENTS | 18.00 | Comments in executable code | |
| EXITS | 77.00 | Procedure exits | |
| FUNCTIONS | 35.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 85.42 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 164.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 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 8.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 | 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 | 7.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 | 14.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 | 1.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 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.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 | 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 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 30.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 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 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 | 5.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 | 1.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 898.00 | Number of lines in the source file | |
| LINE_COMMENT | 23.00 | Number of line comments | |
| LOC | 408.00 | Lines of code | |
| LOGICAL_LINES | 195.00 | Number of statements | |
| LOOPS | 10.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1025.00 | Number of operands | |
| OPERATORS | 1983.00 | Number of operators | |
| PARAMS | 73.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3008.00 | Halstead program length | |
| PROGRAM_VOCAB | 399.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 91.00 | Number of return points from functions | |
| SIZE | 27534.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 342.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 123.00 | Number of whitespace lines | |