IOUtilities (API documentation for TV-Browser 2.7.6)

java.lang.Object
- util.io.IOUtilities

```
public class IOUtilities
extends Object
```
A utilities class for I/O stuff. It constists of serveral static methods that perform some usefull things.

Author:

Til Schneider, www.murfman.de

Constructor Summary

Constructors
Constructor and Description

IOUtilities()

Constructors
Constructor and Description
`IOUtilities()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`append(StringBuffer buffer, int number, int minChars)` Appends an integer to a StringBuffer.
`static void`	`clear(StringBuffer buffer)` Clears an StringBuffer
`static void`	`copy(File[] src, File targetDir)` Copies files given in source to the target directory.
`static void`	`copy(File[] src, File targetDir, boolean onlyNew)` Copies files given in source to the target directory.
`static void`	`copy(File src, File target)` Copies a file.
`static void`	`copy(File src, File target, boolean onlyNew)` Copies a file.
`static void`	`deleteDirectory(File dir)` Deletes a directory with all its files and subdirectories.
`static void`	`download(URL url, File targetFile)` Downloads a file from a HTTP server.
`static byte[]`	`getBytesFromFile(File file)` Reads all Bytes from a File into an byte array
`static int`	`getDaysSince1970()` Deprecated.
`static int`	`getMinutesAfterMidnight()` Gets the number of minutes since midnight This method does not create any objects.
`static InputStream`	`getStream(URL page)` Gets an InputStream to the given URL.
`static InputStream`	`getStream(URL page, boolean followRedirects)` Gets an InputStream to the given URL.
`static InputStream`	`getStream(URL page, boolean followRedirects, int timeout)` Originally copied from javax.swing.JEditorPane.
`static InputStream`	`getStream(URL page, boolean followRedirects, int timeout, String userName, String userPassword)` Originally copied from javax.swing.JEditorPane.
`static InputStream`	`getStream(URL page, int timeout)` Gets an InputStream to the given URL.
`static byte[]`	`loadFileFromHttpServer(URL url)` Loads a file from a Http server.
`static byte[]`	`loadFileFromHttpServer(URL url, int timeout)` Loads a file from a Http server with the given read timeout.
`static byte[]`	`loadFileFromJar(String fileName, Class srcClass)` L�dt eine Datei aus einem Jar-File und gibt sie zur�ck.
`static void`	`pipe(Reader reader, Writer writer)` Pipes all data from the specified Reader to the specified Writer, until the Reader has no more data.
`static void`	`pipeStreams(InputStream from, OutputStream to)` Pipes all data from the specified InputStream to the specified OutputStream, until the InputStream has no more data.
`static byte[]`	`readBinaryData(InputStream stream, int length)` Reads a number of bytes into an array.
`static ImageIcon`	`readImageIconFromFile(File srcFile)` Read the image from the given file to an icon image.
`static void`	`replace(StringBuffer buffer, String pattern, String str)` Replaces in `buffer` the `pattern` by `str`.
`static String`	`replace(String original, String pattern, String str)` Replaces a substring in the specified String.
`static void`	`saveStream(InputStream stream, File targetFile)` Saves the data from an InputStream into a file.
`static String`	`timeToString(int minutesAfterMidnight)` Gets a String representation in the format h:mm for a time in minutes after midnight.
`static void`	`ungzip(File srcFile, File targetFile)` Unzips a GZIP-file (.gz).
`static void`	`unzip(File srcFile, String entryName, File targetFile)` Unzips a file from a ZIP-Archive (.zip, .jar).
`static boolean`	`writeImageIconToFile(ImageIcon icon, String imageType, File targetFile)` Writes the given image icon to the given file in the given imageType.
`static String`	`xorDecode(String text, long seed)` Decodes the specified String using a simple XOR encryption.
`static String`	`xorEncode(String text, long seed)` Encodes the specified String using a simple XOR encryption.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IOUtilities
```
public IOUtilities()
```
- Method Detail
  - download
```
public static void download(URL url,
            File targetFile)
                     throws IOException
```
    Downloads a file from a HTTP server.
    
    Parameters:
    url - The URL of the file to download.
    targetFile - The file where to store the downloaded data.
    
    Throws:
    
    IOException - When download or saving failed.
    See Also:
    loadFileFromHttpServer(URL)
  - saveStream
```
public static void saveStream(InputStream stream,
              File targetFile)
                       throws IOException
```
    Saves the data from an InputStream into a file.
    
    Parameters:
    stream - The stream to read the data from.
    targetFile - The file where to store the data.
    
    Throws:
    
    IOException - When saving failed or when the InputStream throws an IOException.
  - getStream
```
public static InputStream getStream(URL page,
                    boolean followRedirects)
                             throws IOException
```
    Gets an InputStream to the given URL.
    The connection has the Settings.propDefaultNetworkConnectionTimeout as connection timeout.
    
    Parameters:
    page - The page to get the stream to.
    followRedirects - If the stream should be also established if the page not exists at the location but contains a redirect to an other location.
    
    Returns:
    The stream to the page.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - getStream
```
public static InputStream getStream(URL page,
                    boolean followRedirects,
                    int timeout)
                             throws IOException
```
    Originally copied from javax.swing.JEditorPane.
    Fetches a stream for the given URL, which is about to be loaded by the setPage 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.
    This method is expected to have the the side effect of establishing the content type, and therefore setting the appropriate EditorKit to use for loading the stream.
    If this the stream was an http connection, redirects will be followed and the resulting URL will be set as the Document.StreamDescriptionProperty so that relative URL's can be properly resolved.
    
    Parameters:
    page - the URL of the page
    followRedirects - Follow redirects.
    timeout - The read timeout.
    
    Returns:
    a stream reading data from the specified URL.
    
    Throws:
    
    IOException - if something went wrong.
  - getStream
```
public static InputStream getStream(URL page,
                    boolean followRedirects,
                    int timeout,
                    String userName,
                    String userPassword)
                             throws IOException
```
    Originally copied from javax.swing.JEditorPane.
    Fetches a stream for the given URL, which is about to be loaded by the setPage 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.
    This method is expected to have the the side effect of establishing the content type, and therefore setting the appropriate EditorKit to use for loading the stream.
    If this the stream was an http connection, redirects will be followed and the resulting URL will be set as the Document.StreamDescriptionProperty so that relative URL's can be properly resolved.
    
    Parameters:
    page - the URL of the page
    followRedirects - Follow redirects.
    timeout - The read timeout.
    userName - The user name to use for the connection.
    userPassword - The password to use for the connection.
    
    Returns:
    a stream reading data from the specified URL.
    
    Throws:
    
    IOException - if something went wrong.
  - getStream
```
public static InputStream getStream(URL page)
                             throws IOException
```
    Gets an InputStream to the given URL.
    The connection has the Settings.propDefaultNetworkConnectionTimeout as connection timeout.
    
    Parameters:
    page - The page to get the stream to.
    
    Returns:
    The stream to the page.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - getStream
```
public static InputStream getStream(URL page,
                    int timeout)
                             throws IOException
```
    Gets an InputStream to the given URL.
    The connection has the given timeout as connection timeout.
    
    Parameters:
    page - The page to get the stream to.
    timeout - The timeout for the connection, use 0 for no timeout.
    
    Returns:
    The stream to the page.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - loadFileFromHttpServer
```
public static byte[] loadFileFromHttpServer(URL url)
                                     throws IOException
```
    Loads a file from a Http server.
    The connection has the Settings.propDefaultNetworkConnectionTimeout as connection timeout.
    
    Parameters:
    url - The URL of the file
    
    Returns:
    The content of the file
    
    Throws:
    
    IOException - When the download failed
    See Also:
    download(URL, File)
  - loadFileFromHttpServer
```
public static byte[] loadFileFromHttpServer(URL url,
                            int timeout)
                                     throws IOException
```
    Loads a file from a Http server with the given read timeout.
    
    Parameters:
    url - The URL of the file
    timeout - The read timeout for the connection.
    
    Returns:
    The content of the file
    
    Throws:
    
    IOException - When the download failed
    See Also:
    download(URL, File)
  - pipeStreams
```
public static void pipeStreams(InputStream from,
               OutputStream to)
                        throws IOException
```
    Pipes all data from the specified InputStream to the specified OutputStream, until the InputStream has no more data.
    Note: None of the streams is closed! You have to do that for yourself!
    
    Parameters:
    from - The stream to read the data from.
    to - The stream to write the data to.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - pipe
```
public static void pipe(Reader reader,
        Writer writer)
                 throws IOException
```
    Pipes all data from the specified Reader to the specified Writer, until the Reader has no more data.
    Note: The Reader and the Writer are not closed! You have to do that for yourself!
    
    Parameters:
    reader - The Reader to read the data from.
    writer - The Writer to write the data to.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - copy
```
public static void copy(File[] src,
        File targetDir)
                 throws IOException
```
    Copies files given in source to the target directory.
    
    Parameters:
    src - The files to copy.
    targetDir - The target dir of the files.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - copy
```
public static void copy(File[] src,
        File targetDir,
        boolean onlyNew)
                 throws IOException
```
    Copies files given in source to the target directory.
    
    Parameters:
    src - The files to copy.
    targetDir - The target dir of the files.
    onlyNew - Overwrite only older files.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
    Since:
    
    2.2.2/2.5.1
  - copy
```
public static void copy(File src,
        File target)
                 throws IOException
```
    Copies a file.
    
    Parameters:
    src - The file to read from
    target - The file to write to
    
    Throws:
    
    IOException - If copying failed
  - copy
```
public static void copy(File src,
        File target,
        boolean onlyNew)
                 throws IOException
```
    Copies a file.
    
    Parameters:
    src - The file to read from
    target - The file to write to
    onlyNew - Overwrite only older files.
    
    Throws:
    
    IOException - If copying failed
    Since:
    
    2.2.2/2.5.1
  - deleteDirectory
```
public static void deleteDirectory(File dir)
                            throws IOException
```
    Deletes a directory with all its files and subdirectories.
    
    Parameters:
    dir - The directory to delete.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - loadFileFromJar
```
public static byte[] loadFileFromJar(String fileName,
                     Class srcClass)
                              throws IOException
```
    L�dt eine Datei aus einem Jar-File und gibt sie zur�ck.
    Ist keine Datei mit diesem Namen im Jar-File, so wird versucht, sie vom Dateisystem zu laden.
    
    Parameters:
    fileName - Der Name der Datei. (Ist case-sensitive!).
    srcClass - Eine Klasse, aus deren Jar-File das Image geladen werden soll.
    
    Returns:
    The file loaded from the jar file as byte array.
    
    Throws:
    
    IOException - Wenn ein Fehler beim Laden der Datei auftrat.
  - unzip
```
public static void unzip(File srcFile,
         String entryName,
         File targetFile)
                  throws IOException
```
    Unzips a file from a ZIP-Archive (.zip, .jar).
    Currently not used.
    
    Parameters:
    srcFile - The ZIP-File to read the data from.
    entryName - The name of the file in the ZIP-archive to unzip.
    targetFile - The file where to store the data.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - ungzip
```
public static void ungzip(File srcFile,
          File targetFile)
                   throws IOException
```
    Unzips a GZIP-file (.gz).
    
    Parameters:
    srcFile - The GZIP-File to unzip
    targetFile - The file where to store the data.
    
    Throws:
    
    IOException - Thrown if something goes wrong.
  - append
```
public static void append(StringBuffer buffer,
          int number,
          int minChars)
```
    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.
    
    Parameters:
    buffer - The buffer where to append the integer.
    number - The integer to append.
    minChars - The minimum number of chars.
  - replace
```
public static String replace(String original,
             String pattern,
             String str)
```
    Replaces a substring in the specified String.
    
    Parameters:
    original - The String to replace the substring in.
    pattern - The pattern to replace.
    str - The String to replace. This string may contain the pattern.
    
    Returns:
    The result.
  - replace
```
public static void replace(StringBuffer buffer,
           String pattern,
           String str)
```
    Replaces in buffer the pattern by str.
    
    Parameters:
    buffer - The buffer to replace in.
    pattern - The pattern to replace.
    str - The str that should replace the pattern.
  - clear
```
public static void clear(StringBuffer buffer)
```
    Clears an StringBuffer
    
    Parameters:
    buffer - The buffer to clear
  - getMinutesAfterMidnight
```
public static int getMinutesAfterMidnight()
```
    Gets the number of minutes since midnight
    This method does not create any objects.
    
    Returns:
    The number of minutes since midnight as integer
  - timeToString
```
public static String timeToString(int minutesAfterMidnight)
```
    Gets a String representation in the format h:mm for a time in minutes after midnight.
    
    Parameters:
    minutesAfterMidnight - The time to get the String for
    
    Returns:
    A String for the time
  - getDaysSince1970
```
public static int getDaysSince1970()
```
    Deprecated.
    
    Gets the number of days since 1st Jan 1970.
    This method does not create any objects.
  - xorEncode
```
public static String xorEncode(String text,
               long seed)
```
    Encodes the specified String using a simple XOR encryption.
    
    Parameters:
    text - The text to encode
    seed - The seed of the Random object to use for getting the keys
    
    Returns:
    The encoded String
  - xorDecode
```
public static String xorDecode(String text,
               long seed)
```
    Decodes the specified String using a simple XOR encryption.
    
    Parameters:
    text - The text to encode
    seed - The seed of the Random object to use for getting the keys
    
    Returns:
    The decoded String
  - readBinaryData
```
public static byte[] readBinaryData(InputStream stream,
                    int length)
                             throws IOException
```
    Reads a number of bytes into an array.
    
    Parameters:
    stream - The stream to read from
    length - The number of bytes to read
    
    Returns:
    An array containing the read bytes
    
    Throws:
    
    IOException - When the end of the stream has been reached or reading failed
  - getBytesFromFile
```
public static byte[] getBytesFromFile(File file)
                               throws IOException
```
    Reads all Bytes from a File into an byte array
    
    Parameters:
    file - Read Bytes from this File
    
    Returns:
    Byte-Array or NULL if too large
    
    Throws:
    
    IOException - Read-Exception
    Since:
    
    2.5
  - writeImageIconToFile
```
public static boolean writeImageIconToFile(ImageIcon icon,
                           String imageType,
                           File targetFile)
```
    Writes the given image icon to the given file in the given imageType.
    
    Parameters:
    icon - The icon to write.
    imageType - The image type.
    targetFile - The file to write the image to.
    
    Returns:
    True if the file could be written, false if something went wrong.
    Since:
    
    2.6
  - readImageIconFromFile
```
public static ImageIcon readImageIconFromFile(File srcFile)
```
    Read the image from the given file to an icon image.
    
    Parameters:
    srcFile - The file to read from.
    
    Returns:
    The read icon image or null if something went wrong.
    Since:
    
    2.6

Class IOUtilities

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IOUtilities

Method Detail

download

saveStream

getStream

getStream

getStream

getStream

getStream

loadFileFromHttpServer

loadFileFromHttpServer

pipeStreams

pipe

copy

copy

copy

copy

deleteDirectory

loadFileFromJar

unzip

ungzip

append

replace

replace

clear

getMinutesAfterMidnight

timeToString

getDaysSince1970

xorEncode

xorDecode

readBinaryData

getBytesFromFile

writeImageIconToFile

readImageIconFromFile