xdev.io.IOUtils Maven / Gradle / Ivy
/*
* XDEV Application Framework - XDEV Application Framework
* Copyright © 2003 XDEV Software (https://xdev.software)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see IOUtils provides utility methods for IO related tasks.
*
* @since 2.0
* @author XDEV Software
*
*/
@LibraryMember
public final class IOUtils
{
private IOUtils()
{
}
/**
* Growing byte array
*/
private static class ByteBuffer
{
private byte[] data;
private int offset;
public ByteBuffer(final int initialCapacity)
{
this.data = new byte[initialCapacity];
this.offset = 0;
}
public void add(final byte[] b, final int length)
{
if(this.offset + length >= this.data.length)
{
final byte[] newData = new byte[(this.data.length + length) * 2];
System.arraycopy(this.data, 0, newData, 0, this.offset);
this.data = newData;
}
System.arraycopy(b, 0, this.data, this.offset, length);
this.offset += length;
}
public byte[] get()
{
final byte[] b = new byte[this.offset];
System.arraycopy(this.data, 0, b, 0, this.offset);
return b;
}
}
/**
* the operating system specific line separator.
*/
public static final String LINE_SEPARATOR = System.getProperty("line.separator");
/**
* an empty byte array.
*/
public final static byte[] EMPTY_BYTE_ARRAY = new byte[0];
/**
* one megabyte.
*/
public final static long ONE_MEGABYTE = 1024 * 1024;
/**
* the Default buffer size.
*/
public final static int DEFAULT_BUFFER_SIZE = 1024 * 4;
private static boolean isWindows;
private static boolean isWindows9x;
private static boolean isMac;
private static boolean isLinux;
private static boolean isSolaris;
private static FileSystemView fileSystemView;
private static NumberFormat numberFormat;
static
{
isWindows = isWindows9x = isMac = isLinux = isSolaris = false;
final String system = System.getProperty("os.name").toLowerCase();
if(system.indexOf("windows") >= 0)
{
isWindows = true;
if(system.indexOf("95") >= 0 || system.indexOf("98") >= 0)
{
isWindows9x = true;
}
}
else if(system.indexOf("macintosh") >= 0 || system.indexOf("mac os") >= 0)
{
isMac = true;
}
else if(system.indexOf("solaris") >= 0
|| system.indexOf("sun os") >= 0
|| system.indexOf("sunos") >= 0)
{
isSolaris = true;
}
else
{
isLinux = true;
}
numberFormat = NumberFormat.getNumberInstance();
numberFormat.setMaximumFractionDigits(2);
numberFormat.setMinimumFractionDigits(0);
}
/**
* @return true, if operating system is Windows
*/
public static boolean isWindows()
{
return isWindows;
}
/**
* @return true, if operating system is Windows9x
*/
public static boolean isWindows9x()
{
return isWindows9x;
}
/**
* @return true, if operating system is Mac OS
*/
public static boolean isMac()
{
return isMac;
}
/**
* @return true, if operating system is Linux
*/
public static boolean isLinux()
{
return isLinux;
}
/**
* @return true, if operating system is Solaris
*/
public static boolean isSolaris()
{
return isSolaris;
}
/**
* Int-Identifier for a Windows Operating System.
*/
public final static int WINDOWS = 0;
/**
* Int-Identifier for a Mac Operating System.
*/
public final static int MAC = 1;
/**
* Int Identifier for a Unix Operating System.
*/
public final static int UNIX = 2;
/**
* Returns the type of operating system this application is running on.
*
* @return Int-Identifier for the operating system
* @see IOUtils#WINDOWS
* @see IOUtils#MAC
* @see IOUtils#UNIX
*/
public final static int getOS()
{
final String os = System.getProperty("os.name").toUpperCase();
if(os.indexOf("WINDOWS") >= 0)
{
return WINDOWS;
}
else if(os.indexOf("MACINTOSH") >= 0)
{
return MAC;
}
else
{
return UNIX;
}
}
/**
* Reads from a {@link InputStream} and returns the results as a byte array.
*
* @param in
* {@link InputStream} to read from
*
* @return byte array of read data
*
* @throws IOException
* if an I/O error occurs
*
* @see #readData(InputStream, int)
*/
public static byte[] readData(final InputStream in) throws IOException
{
try
{
final ByteBuffer bb = new ByteBuffer(1024);
final byte[] b = new byte[1024];
int read = in.read(b, 0, 1024);
bb.add(b, read);
while(read >= 0)
{
read = in.read(b, 0, 1024);
if(read >= 0)
{
bb.add(b, read);
}
}
return bb.get();
}
catch(final IOException e)
{
throw new IOException(e);
}
}
/**
* Reads from a {@link InputStream} and returns the results as a byte array.
*
* @param in
* stream to read from
* @param len
* the number of bytes read from the stream at once
*
* @return byte array of read data
*
* @throws IOException
* if an I/O error occurs
*/
public static byte[] readData(final InputStream in, final int len) throws IOException
{
try
{
final ByteBuffer bb = new ByteBuffer(len);
final byte[] b = new byte[len];
int read = in.read(b, 0, len);
bb.add(b, read);
while(read < len)
{
final int i = in.read(b, 0, len - read);
if(i >= 0)
{
bb.add(b, i);
read += i;
}
}
return bb.get();
}
catch(final IOException e)
{
throw new IOException(e);
}
}
/**
* Reads the contents of the file f into a byte array.
*
* @param f
* The file to be read
* @return The file's content as a byte array.
* @throws IOException
* if an I/O error occurs
*
* @since 3.1
*/
public static byte[] readData(final File f) throws IOException
{
final FileInputStream in = new FileInputStream(f);
try
{
return readData(in, (int)f.length());
}
finally
{
closeSilent(in);
}
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* string.
* The stream gets closed afterwards.
* This method is a alias for
* IOUtils.readString(InputStream is, boolean close)
*
* @param is
* a implementation of the interface {@link InputStream}
*
* @return a string containing the read characters.
*
* @throws IOException
* if an I/O error occurs
*
* @see #readString(InputStream, boolean)
*/
public static String readString(final InputStream is) throws IOException
{
return readString(is, true);
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* string.
* This method is a alias for
* IOUtils.readString(Reader r, boolean close)
*
* @param is
* a implementation of the interface {@link InputStream}
* @param close
* if true stream gets closed afterwards
*
* @return a string containing the read characters.
*
* @throws IOException
* if an I/O error occurs
*
* @see #readString(Reader, boolean)
*/
public static String readString(final InputStream is, final boolean close) throws IOException
{
return readString(new InputStreamReader(is), close);
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* string.
* The stream gets closed afterwards.
* This method is a alias for
* IOUtils.readString(Reader r, boolean close)
*
* @param is
* a implementation of the interface {@link InputStream}
* @param charsetName
* a name of a character set to use
*
* @return a string containing the read characters.
*
* @throws IOException
* if an I/O error occurs
*
* @see #readString(Reader, boolean)
*/
public static String readString(final InputStream is, final String charsetName) throws IOException
{
return readString(is, charsetName, true);
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* string.
* This method is a alias for
* IOUtils.readString(Reader r, boolean close)
*
* @param is
* a implementation of the interface {@link InputStream}
* @param charsetName
* a name of a character set to use
* @param close
* if true, reader gets closed afterwards.
* @return a string containing the read characters.
* @throws IOException
* if an I/O error occurs
* @see #readString(InputStream, boolean)
*/
public static String readString(final InputStream is, final String charsetName, final boolean close)
throws IOException
{
return readString(new InputStreamReader(is, charsetName), close);
}
/**
* Reads from a specified {@link File} and stores results in a string. The
* reader gets closed afterwards.
* This method is a alias for IOUtils.readString(Reader r)
*
* @param f
* a {@link File} to read from
*
* @return a string containing the read characters.
*
* @throws IOException
* if an I/O error occurs
*
* @see #readString(Reader)
*/
public static String readString(final File f) throws IOException
{
return readString(new FileReader(f));
}
/**
* Reads from a specified reader and stores results in a string. The reader
* gets closed afterwards.
* This method is a alias for
* IOUtils.readString(Reader r, boolean close)
*
* @param in
* a implementation of the interface {@link Reader}
*
* @return a string containing the read characters.
*
* @throws IOException
* if an I/O error occurs
*
* @see #readString(Reader, boolean)
*/
public static String readString(final Reader in) throws IOException
{
return readString(in, true);
}
/**
* Reads from a specified reader and stores results in a string.
*
*
*
* FileReader reader = new FileReader("customer.txt");
* String result = IOUtils.readString(
* reader,
* false);
*
*
* Creates a new FileReader reader, then the file is read and
* its contents are stored in result.
*
*
* @param in
* a implementation of the interface {@link Reader}
* @param close
* if true, reader gets closed afterwards.
* @return a string containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static String readString(final Reader in, final boolean close) throws IOException
{
final CharArrayWriter out = new CharArrayWriter(DEFAULT_BUFFER_SIZE);
copy(in, out, close);
return out.toString();
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* character array. Stream is closed afterwards.
* This method is a alias for
* IOUtils.readChars(InputStream is, boolean close)
*
* @param is
* a implementation of the interface {@link InputStream}
* @return a char[] containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static char[] readChars(final InputStream is) throws IOException
{
return readChars(is, true);
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* character array.
* This method is a alias for
* IOUtils.readChars(Reader r, boolean close)
*
* @param is
* a implementation of the interface {@link InputStream}
* @param close
* if true, reader gets closed afterwards.
* @return a char[] containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static char[] readChars(final InputStream is, final boolean close) throws IOException
{
return readChars(new InputStreamReader(is), close);
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* character array.
* The stream gets closed afterwards.
* This method is a alias for
* IOUtils.readChars(is,charsetName,true)
*
* @param is
* a implementation of the interface {@link InputStream}
* @param charsetName
* the name of the character set to use
* @return a char[] containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static char[] readChars(final InputStream is, final String charsetName) throws IOException
{
return readChars(is, charsetName, true);
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* character array.
* This method is a alias for
* IOUtils.readChars(Reader in, boolean close)
*
* @param is
* a implementation of the interface {@link InputStream}
* @param charsetName
* the name of the character set to use
* @param close
* if true, reader gets closed afterwards.
* @return a char[] containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static char[] readChars(final InputStream is, final String charsetName, final boolean close)
throws IOException
{
return readChars(new InputStreamReader(is, charsetName), close);
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* character array. The reader gets closed afterwards.
* This method is a alias for IOUtils.readChars(Reader r).
*
* @param f
* a {@link File} to read from
* @return a char[] containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static char[] readChars(final File f) throws IOException
{
return readChars(new FileReader(f));
}
/**
* Reads from a specified {@link InputStream} and stores results in a
* character array. The reader gets closed afterwards.
* This method is a alias for
* IOUtils.readChars(Reader r, boolean close)
*
* @param in
* a implementation of the interface {@link Reader}
* @return a char[] containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static char[] readChars(final Reader in) throws IOException
{
return readChars(in, true);
}
/**
* Reads from a specified reader and stores results in a character array.
*
*
*
* FileReader reader = new FileReader("customer.txt");
* char[] result = IOUtils.readChars(
* reader,
* false);
*
*
* Creates a new FileReader reader and
*
*
* @param in
* a implementation of the interface {@link Reader}
* @param close
* if true, reader gets closed afterwards.
* @return a char[] containing the read characters.
* @throws IOException
* if an I/O error occurs
*/
public static char[] readChars(final Reader in, final boolean close) throws IOException
{
final CharArrayWriter out = new CharArrayWriter(DEFAULT_BUFFER_SIZE);
copy(in, out, close);
return out.toCharArray();
}
/**
* Copies in to out and closes both writers.
*
* This method is a alias for IOUtils.copy(in,out,true);
*
*
* @param in
* the {@link Reader} to read from
* @param out
* the {@link Writer} to write to
* @return the number of bytes written
* @throws IOException
* if an I/O error occurs
*/
public static int copy(final Reader in, final Writer out) throws IOException
{
return copy(in, out, true);
}
/**
* Copies in to out and closes both reader and writer if close
* is true.
*
* @param in
* the {@link Reader} to read from
* @param out
* the {@link Writer} to write to
* @param close
* if true reader in and writer out get closed
* @return the number of bytes written
* @throws IOException
* if an I/O error occurs
*/
public static int copy(final Reader in, final Writer out, final boolean close) throws IOException
{
try
{
final char[] buffer = new char[DEFAULT_BUFFER_SIZE];
int count = 0;
int n = 0;
while(-1 != (n = in.read(buffer)))
{
out.write(buffer, 0, n);
count += n;
}
return count;
}
finally
{
if(close)
{
closeSilent(in);
closeSilent(out);
}
}
}
/**
* Copies in to out and closes both streams.
*
* This method is a alias for IOUtils.copy(in,out,true);
*
*
* @param in
* the {@link InputStream} to read from
* @param out
* the {@link OutputStream} to write to
* @return the number of bytes written
* @throws IOException
* if an I/O error occurs
* @since 3.1
*/
public static int copy(final InputStream in, final OutputStream out) throws IOException
{
return copy(in, out, true);
}
/**
* Copies in to out and closes both streams if close is
* true.
*
* @param in
* the {@link InputStream} to read from
* @param out
* the {@link OutputStream} to write to
* @param close
* if true streams will be closed
* @return the number of bytes written
* @throws IOException
* if an I/O error occurs
* @since 3.1
*/
public static int copy(final InputStream in, final OutputStream out, final boolean close) throws IOException
{
try
{
final byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
int count = 0;
int n = 0;
while(-1 != (n = in.read(buffer)))
{
out.write(buffer, 0, n);
count += n;
}
return count;
}
finally
{
if(close)
{
closeSilent(in);
closeSilent(out);
}
}
}
/**
* Copies src to dest.
*
* If src is a directory:
*
* dest has to be a directory or an IOExeption
* is thrown- a new directory with
src's name is created in
* dest and src's content is copied to the new
* directory
*
* else if src is a file:
*
* - if
dest is a directory, src is copied to
* dest to a file with the same name
* - else if
dest is a file, dest is overwritten
* with src's content
*
*
* @param src
* the source file or directory
* @param dest
* the destination file or directory
* @return the destination file
* @throws IOException
* if an I/O error occurs
*
* @since 3.1
*/
public static File copy(final File src, File dest) throws IOException
{
if(src.isDirectory())
{
ensureDir(dest);
dest = new File(dest, src.getName());
ensureDir(dest);
final File[] children = src.listFiles();
if(children != null)
{
for(final File child : children)
{
copy(child, dest);
}
}
}
else
{
if(dest.isDirectory())
{
dest = new File(dest, src.getName());
}
FileInputStream in = null;
FileOutputStream out = null;
try
{
in = new FileInputStream(src);
out = new FileOutputStream(dest);
final FileChannel inChannel = in.getChannel();
final FileChannel outChannel = out.getChannel();
inChannel.transferTo(0, inChannel.size(), outChannel);
}
finally
{
closeSilent(in);
closeSilent(out);
}
dest.setLastModified(src.lastModified());
}
return dest;
}
/**
* Ensures that dir is a existing directory, it will be created
* if it doesn't exist.
*
* @param dir
* @throws IOException
* if dir exists and is not a directoy or if the
* directory could not be created
*
* @since 3.1
*/
public static void ensureDir(final File dir) throws IOException
{
if(!dir.exists())
{
if(!dir.mkdirs())
{
throw new IOException(
"directory \""
+ dir.getAbsolutePath()
+ "\" could not be created");
}
}
else if(!dir.isDirectory())
{
throw new IOException("\"" + dir.getAbsolutePath() + "\" is not a directory");
}
}
/**
* Creates a hash value for a {@link String} object using the specified
* algorithm.
*
* @param str
* the {@link String} to create the hash value for.
* @param algorithm
* the name of the hash algorithm to use. See Appendix A in the
* Java Cryptography Architecture API Specification &
* Reference for information about standard algorithm names.
* @return a 32 charaters long hexadecimal {@link String}.
* @throws NoSuchAlgorithmException
* if an invalid algorithm was specified
*/
public static String createHash(@NotNull final String str, final String algorithm)
throws NoSuchAlgorithmException, NullPointerException
{
try
{
return createHash(str.getBytes("UTF8"), algorithm);
}
catch(final UnsupportedEncodingException e)
{
return createHash(str.getBytes(), algorithm);
}
}
/**
* Creates a hash value for an array of bytes using the
* specified algorithm.
*
* @param data
* the byte array to create the hash value for.
* @param algorithm
* the name of the hash algorithm to use. See Appendix A in the
* Java Cryptography Architecture API Specification &
* Reference for information about standard algorithm names.
* @return a 32 charaters long hexadecimal {@link String}.
* @throws NoSuchAlgorithmException
* if an invalid algorithm was specified
*/
public static String createHash(final byte[] data, final String algorithm) throws NoSuchAlgorithmException
{
return toHashString(MessageDigest.getInstance(algorithm).digest(data), algorithm);
}
/**
* Creates a hash value an {@link InputStream} using the specified
* algorithm.
*
* @param in
* the {@link InputStream} to build the hash value for.
* @param algorithm
* the name of the hash algorithm to use. See Appendix A in the
* Java Cryptography Architecture API Specification &
* Reference for information about standard algorithm names.
* @return a 32 charaters long hexadecimal {@link String}.
* @throws NoSuchAlgorithmException
* if an invalid algorithm was specified
*/
public static String createHash(final InputStream in, final String algorithm)
throws NoSuchAlgorithmException, IOException
{
final MessageDigest md = MessageDigest.getInstance(algorithm);
final byte[] buffer = new byte[1024];
int read = in.read(buffer);
while(read != -1)
{
md.update(buffer, 0, read);
read = in.read(buffer);
}
return toHashString(md.digest(), algorithm);
}
/**
* Converts the digest into a proper hash string.
*
* @param digest
* the fingerprint
* @param algorithm
* e.g. SHA, MD5, ...
* @return The hash string for the specified digest.
*/
public static String toHashString(final byte[] digest, final String algorithm)
{
if(algorithm.equalsIgnoreCase("MD5"))
{
return String.format("%1$032x", new BigInteger(1, digest));
}
else if(algorithm.equalsIgnoreCase("SHA") || algorithm.startsWith("SHA-"))
{
final StringBuffer sb = new StringBuffer();
for(int i = 0, c = digest.length; i < c; i++)
{
sb.append(Integer.toString((digest[i] & 0xff) + 0x100, 16).substring(1));
}
return sb.toString();
}
else
{
return new BigInteger(1, digest).toString(16);
}
}
/**
* Returns all root files on this system.
*
*
*
* XdevFile[] roots = IOUtils.getSystemRoots();
*
*
*
*
* This is a synonym for {@link XdevFile#getSystemRoots()}
*
* @return all root files on this system. The values are dependent of the
* operating system.
*/
public static XdevFile[] getSystemRoots()
{
return XdevFile.getSystemRoots();
}
/**
* Returns a string from the system clipboard.
*
*
* String string = getClipboardString();
*
*
* @return the {@link String} from the system clipboard or NULL if no
* {@link String} is present
*
* @see #getClipboardFileList()
* @see #getClipboardImage()
* @see #putClipboardString(String)
*/
public static String getClipboardString()
{
try
{
final Object o = getSysClipboardContent(DataFlavor.stringFlavor);
if(o != null)
{
return o.toString();
}
}
catch(final Exception e)
{}
return null;
}
/**
* Returns a image from the system clipboard.
*
*
* XdevImage img = getClipboardImage();
*
*
* @return the {@link XdevImage} from the system clipboard or NULL if no
* image is present
* @see #getClipboardFileList()
* @see #getClipboardString()
* @see #putClipboardImage(Image)
*/
public static XdevImage getClipboardImage()
{
try
{
final Object o = getSysClipboardContent(DataFlavor.imageFlavor);
if(o != null)
{
if(o instanceof XdevImage)
{
return (XdevImage)o;
}
else if(o instanceof Image)
{
return new XdevImage((Image)o);
}
}
}
catch(final Exception e)
{}
return null;
}
/**
* Returns the file list from the system clipboard
*
*
* XdevFile[] files = getClipboardFileList();
*
*
* @see #getClipboardFileList()
* @see #getClipboardString()
* @see #putClipboardFileList(java.util.List)
*/
public static XdevFile[] getClipboardFileList()
{
try
{
final Object o = getSysClipboardContent(DataFlavor.javaFileListFlavor);
if(o != null && o instanceof java.util.List)
{
final List files = (List)o;
final int c = files.size();
final List list = new ArrayList(c);
for(int i = 0; i < c; i++)
{
list.add(new XdevFile((File)files.get(i)));
}
return list.toArray(new XdevFile[list.size()]);
}
}
catch(final Exception e)
{}
return null;
}
private static Object getSysClipboardContent(final DataFlavor flavor) throws Exception
{
final Clipboard cp = Toolkit.getDefaultToolkit().getSystemClipboard();
return cp.getContents(Application.getContainer()).getTransferData(flavor);
}
/**
* Store a string in the system clipboard.
*
*
*
* boolean success = IOUtils.putClipboardString("store me");
*
*
* A string is stored in the clipboard.
*
*
* @param str
* a string to be stored in the clipboard
*
* @return true if, string str was successfully stored in the clipboard
*
* @see #getClipboardFileList()
* @see #putClipboardFileList(List)
* @see #putClipboardString(String)
*/
public static boolean putClipboardString(final String str)
{
return putSystemClipboardContent(str, DataFlavor.stringFlavor);
}
/**
* Store a {@link Image} in the system clipboard.
*
*
*
* ArrayList fileList = createList();
* Image image = createImage();
* boolean success = IOUtils.putClipboardImage(image);
*
*
* A image is created and stored in the clipboard.
*
*
* @param image
* a {@link Image} to be stored in the clipboard
*
* @return true if, image was successfully stored in the clipboard
*
* @see #getClipboardFileList()
* @see #putClipboardFileList(List)
* @see #putClipboardString(String)
*/
public static boolean putClipboardImage(final Image image)
{
return putSystemClipboardContent(image, DataFlavor.imageFlavor);
}
/**
* Store a list of files in the system clipboard.
*
* Hint!
* It won't be verified, if the files-objects reference existing files.
*
*
* Image img = createImage();
* boolean success = IOUtils.putClipboardImage(img)
*
*
* Stores the image img in the system clipboard.
*
*
* @param files
* a @link {@link List} of files with containing filepath entries
* @return true if, list of files was successfully stored in the clipboard
* @see #getClipboardFileList()
* @see #putClipboardImage(Image)
* @see #putClipboardString(String)
*/
public static boolean putClipboardFileList(final List files)
{
boolean success = false;
if(files.size() > 0)
{
success = putSystemClipboardContent(files, DataFlavor.javaFileListFlavor);
}
return success;
}
private static boolean putSystemClipboardContent(final Object data, final DataFlavor flavor)
{
try
{
final Clipboard cp = Toolkit.getDefaultToolkit().getSystemClipboard();
final DataFlavor[] flavors = new DataFlavor[]{flavor};
cp.setContents(new Transferable()
{
@Override
public Object getTransferData(final DataFlavor flavor) throws UnsupportedFlavorException,
IOException
{
return data;
}
@Override
public DataFlavor[] getTransferDataFlavors()
{
return flavors;
}
@Override
public boolean isDataFlavorSupported(final DataFlavor df)
{
return flavor.equals(df);
}
}, new ClipboardOwner()
{
@Override
public void lostOwnership(final Clipboard clipboard, final Transferable contents)
{
}
});
return true;
}
catch(final Exception e)
{
return false;
}
}
/**
* Extracts the name of a file from a path.
*
*
*
* String path = "c:\\one\two\\filename.txt";
* String filename = IOUtils.getFileName(path);
*
*
* Variable filename contains "filename.txt" after the call.
*
*
* @param path
* the path to extract the filename from
*
* @return the file name
*
* @throws NullPointerException
* if path is null
*/
public static String getFileName(@NotNull String path) throws NullPointerException
{
if(path.length() == 1)
{
return path;
}
int i = path.lastIndexOf('/');
if(i >= 0)
{
if(i == path.length() - 1)
{
path = path.substring(0, i - 1);
i = path.lastIndexOf('/');
}
return path.substring(i + 1);
}
i = path.lastIndexOf('\\');
if(i >= 0)
{
if(i == path.length() - 1)
{
path = path.substring(0, i - 1);
i = path.lastIndexOf('\\');
}
return path.substring(i + 1);
}
return path;
}
/**
* Returns the prefix of a filename (filename without extension) of a
* specified file.
*
* This method is a alias for getPrefix(file.getName())
*
*
* @param file
* the file to get the prefix of the name
*
* @return the prefix of the name
*
* @throws NullPointerException
* if file is null
*/
public static String getPrefix(@NotNull final File file) throws NullPointerException
{
return getPrefix(file.getName());
}
/**
* Returns the prefix of a filename (filename without
* extension).
*
*
* String filename = "filename.txt";
* String prefix = IOUtils.getPrefix(filename);
*
*
*
*
* prefix contains "filename" after the call.
*
*
* @param fileName
* name of the file as String
*
* @return the prefix of the name
*
* @throws NullPointerException
* if filename is null
*/
public static String getPrefix(final String fileName) throws NullPointerException
{
final int i = fileName.lastIndexOf('.');
if(i >= 0)
{
return fileName.substring(0, i);
}
return fileName;
}
/**
* Returns the suffix of a filename (Extension without filename) of a
* specified file.
*
* This method is an alias getSuffix(String fileName).
*
*
* @param file
* the file to get the suffix of the name
* @return the suffix of the name
* @throws NullPointerException
* if file is null
*/
public static String getSuffix(@NotNull final File file) throws NullPointerException
{
return getSuffix(file.getName());
}
/**
* Returns the suffix of a filename (Extension without
* filename).
*
*
*
* String filename = "filename.txt";
* String suffix = IOUtils.getSuffix(filename);
*
*
* suffix contains ".txt" after the call.
*
*
* @param fileName
* name of the file as String
* @return the prefix of the name
* @throws NullPointerException
* if filename is null
*/
public static String getSuffix(@NotNull final String fileName) throws NullPointerException
{
final int i = fileName.lastIndexOf('.');
if(i >= 0)
{
return fileName.substring(i);
}
return fileName;
}
/**
* The human readable file size for the file f.
*
* @return The human readable file size for the file f.
* If f is a directory an empty String is returned.
*
* @param f
* the file to retrieve the filesize from
*
* @see #getFileSize(long)
*/
public static String getFileSize(final File f)
{
if(!f.isDirectory() && !getFileSystemView().isDrive(f))
{
return getFileSize(f.length());
}
return "";
}
/**
* Parses a filesize into a human readable form.
*
* @param n
* The file size in bytes
* @return The human readable file size for n bytes
* E.g: n=1024 -> 1 KB
*/
public static String getFileSize(final long n)
{
try
{
double d = 0;
if(n < 1024)
{
return numberFormat.format(n).concat(" Bytes");
}
else
{
d = n / 1024d;
if(d < 1024d)
{
return numberFormat.format(d).concat(" KB");
}
else
{
d /= 1024d;
if(d < 1024d)
{
return numberFormat.format(d).concat(" MB");
}
else
{
d /= 1024d;
return numberFormat.format(d).concat(" GB");
}
}
}
}
catch(final Exception e)
{
return "" + n;
}
}
/**
* Closes c silently, throws no exception whether
* c is null nor if an error occurs.
*
* @param c
* The {@link Closeable} to be closed
*/
public static void closeSilent(final Closeable c)
{
if(c != null)
{
try
{
c.close();
}
catch(final IOException e)
{}
}
}
/**
* Closes s silently, throws no exception whether
* s is null nor if an error occurs.
*
* @param s
* The {@link Socket} to be closed
*/
public static void closeSilent(final ServerSocket s)
{
if(s != null)
{
try
{
s.close();
}
catch(final IOException e)
{}
}
}
/**
* Closes s silently, throws no exception whether
* s is null nor if an error occurs.
*
* @param s
* The {@link Socket} to be closed
*/
public static void closeSilent(final Socket s)
{
if(s != null)
{
try
{
s.close();
}
catch(final IOException e)
{}
}
}
/**
* Closes zf silently, throws no exception whether
* s is null nor if an error occurs.
*
* @param zf
* The {@link ZipFile} to be closed
*/
public static void closeSilent(final ZipFile zf)
{
if(zf != null)
{
try
{
zf.close();
}
catch(final IOException e)
{}
}
}
/**
* Searches for a resource in the application's classpath and the
* filesystem.
*
* If the resource is found an {@link InputStream} is returned to read from
* the resource.
* If no resource is found an {@link FileNotFoundException} is thrown.
*
* @param relativePath
* The relative path of the resource, e.g. 'res/pics/splash.png'
* @return An {@link InputStream} to read from the resource
* @throws IOException
* if an IO-error occurs
* @throws FileNotFoundException
* if the resource cannot be found
* @deprecated typo, use {@link #findResource(String)}
*/
@Deprecated
public static InputStream findRessource(final String relativePath) throws IOException,
FileNotFoundException
{
return findResource(relativePath);
}
/**
* Searches for a resource in the application's classpath and the
* filesystem.
*
* If the resource is found an {@link InputStream} is returned to read from
* the resource.
* If no resource is found an {@link FileNotFoundException} is thrown.
*
* @param relativePath
* The relative path of the resource, e.g. 'res/pics/splash.png'
* @return An {@link InputStream} to read from the resource
* @throws IOException
* if an IO-error occurs
* @throws FileNotFoundException
* if the resource cannot be found
* @since 3.1
*/
public static InputStream findResource(String relativePath) throws IOException,
FileNotFoundException
{
relativePath = relativePath.replace('\\', '/');
final ClassLoader classLoader = IOUtils.class.getClassLoader();
InputStream in = classLoader.getResourceAsStream(relativePath);
if(in == null)
{
if(relativePath.startsWith("/"))
{
in = classLoader.getResourceAsStream(relativePath.substring(1));
}
else
{
in = classLoader.getResourceAsStream("/" + relativePath);
}
}
if(in != null)
{
return in;
}
File f = new File(relativePath).getAbsoluteFile();
if(f.exists())
{
return new FileInputStream(f);
}
final String projectHome = System.getProperty("project.home", null);
if(projectHome != null)
{
final StringBuilder path = new StringBuilder();
if(projectHome.endsWith("/"))
{
path.append(projectHome, 0, projectHome.length() - 1);
}
else
{
path.append(projectHome);
}
if(!relativePath.startsWith("/"))
{
path.append("/");
}
path.append(relativePath);
f = new File(path.toString()).getAbsoluteFile();
if(f.exists())
{
return new FileInputStream(f);
}
}
throw new FileNotFoundException(relativePath);
}
// ===============================================================================
// -------------------------------------------------------------------------------
// Deprecated and moved stuff
// -------------------------------------------------------------------------------
// ===============================================================================
/**
* Opens the url in the currently running browser if the Application is an
* Applet, otherwise the system's default browser will be used.
*
* @deprecated use {@link Application#showDocument(URL,String)} or
* {@link DesktopUtils#browse(String)}
*/
@Deprecated
public static void showURL(final String url, String target) throws IOException
{
if(target == null)
{
target = "";
}
if(Application.isApplet())
{
showDocument(url, target);
}
else
{
launchBrowser(url);
}
}
/**
* Opens the url in the currently running browser if the Application is an
* Applet, otherwise the system's default browser will be used.
*
* @deprecated use {@link Application#showDocument(URL)} or
* {@link DesktopUtils#browse(String)}
*/
@Deprecated
public static void launchBrowser(final String url) throws IOException
{
if(Application.isApplet())
{
showDocument(url, "_blank");
}
else
{
DesktopUtils.browse_noError(url);
}
}
/**
* @deprecated use {@link Application#showDocument(URL, String)}
*/
@Deprecated
public static void showDocument(String url, final String target) throws IOException
{
try
{
url = createURLString(url);
URL u = null;
if(url.startsWith("http://"))
{
u = new URL(url);
}
else
{
u = new URL(Application.getContainer().getCodeBase(), url);
}
if(target != null && target.length() > 0)
{
Application.getContainer().showDocument(u, target);
}
else
{
Application.getContainer().showDocument(u);
}
}
catch(final IOException ioe)
{
throw ioe;
}
catch(final Exception e)
{
throw new IOException(e.getMessage());
}
}
/**
* Creates a url encoded representation of the specified string.
*
*
*
* String input = "hello hello";
* String urlString = IOUtils.createURLString(input);
*
*
* the input string "hello hello" get url encoded, which results in
* "hello+hello"
*
*
* @param s
* the string to encode
* @return the encoded string
* @deprecated Use {@link NetUtils#encodeURLString(String)}
*/
@Deprecated
public static String createURLString(final String s)
{
return NetUtils.encodeURLString(s);
}
/**
* @deprecated use {@link NetUtils#getSessionID()}
*/
@Deprecated
public static String getSessionID()
{
return NetUtils.getSessionID();
}
/**
* @deprecated
*/
@Deprecated
public static void renewSessionID()
{
NetUtils.renewSessionID();
}
/**
* @deprecated use {@link NetUtils#setCookie(String, String)}
*/
@Deprecated
public static boolean setCookie(final String name, final String value) throws IOException
{
return false;
}
/**
* @deprecated use {@link NetUtils#getCookie(String)}
*/
@Deprecated
public static String getCookie(final String name) throws IOException
{
return null;
}
/**
* @deprecated use {@link NetUtils#sendMail(String, String, String, String)}
*/
@Deprecated
public static boolean mail(final String receiver, final String subject, final String message) throws IOException
{
return NetUtils.sendMail(receiver, subject, message);
}
/**
* @deprecated use {@link NetUtils#sendMail(String, String, String, String)}
*/
@Deprecated
public static boolean mail(
final String receiver,
final String subject,
final String message,
final String additionalHeaders) throws IOException
{
return NetUtils.sendMail(receiver, subject, message, additionalHeaders);
}
/**
* @deprecated use {@link NetUtils#uploadFile(String, String, long, String)}
*/
@Deprecated
public static void uploadFile(
final String destFolder,
final String destFileName,
final long maxSize,
final String dialogTitle) throws IOException
{
NetUtils.uploadFile(destFolder, destFileName, maxSize, dialogTitle);
}
/**
* Lazy init of fileSystemView to prevent spawning an UI Thread prematurely
*
* @return {@link FileSystemView}
*/
private static FileSystemView getFileSystemView()
{
if(fileSystemView == null)
{
fileSystemView = FileSystemView.getFileSystemView();
}
return fileSystemView;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy