IOUtils (Technia Value Components (2024.5.0) API Documentation

java.lang.Object
- com.technia.tvc.core.io.IOUtils

```
public class IOUtils
extends java.lang.Object
```
Contains utility methods related to IO operations

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`closeQuietly(java.io.InputStream in)` Calls `IOUtils.closeQuietly(InputStream)`
`static void`	`closeQuietly(java.io.OutputStream out)` Calls `IOUtils.closeQuietly(OutputStream)`
`static void`	`closeQuietly(java.io.Reader reader)` Calls `IOUtils.closeQuietly(Reader)`
`static void`	`closeQuietly(java.io.Writer w)` Calls `IOUtils.closeQuietly(Writer)`
`static void`	`copy(java.io.Reader reader, java.io.Writer writer)`
`static void`	`copyFile(java.io.File src, java.io.File dest)`
`static void`	`copyStream(java.io.InputStream in, java.io.OutputStream out)` Copies the content of the `InputStream` into the `OutputStream`
`static void`	`copyStream(java.io.InputStream in, java.io.OutputStream out, boolean close)` Copies the content of the `InputStream` into the `OutputStream`
`static void`	`copyStream(java.io.InputStream in, java.io.OutputStream out, long bytesToCopy)`
`static java.io.OutputStream`	`deflate(java.io.OutputStream out)` Deflate the bytes in this stream.
`static boolean`	`deleteTree(java.io.File file)` Recursively deletes directories and files.
`static byte[]`	`getBytes(java.io.InputStream in)`
`static byte[]`	`getBytes(java.net.URL url)` Reads the data from the URL and returns the bytes read.
`static java.util.Date`	`getLastModified(java.net.URL url)` Gets the last modified timestamp from the URL connection.
`static java.io.InputStream`	`inflate(java.io.InputStream in)` Inflate the bytes in this stream if it is deflated.
`static boolean`	`isGZipped(java.io.PushbackInputStream in)` Returns true if the given input stream is gzipped.
`static boolean`	`isZipped(java.io.PushbackInputStream in)` Deprecated.
`static java.io.File`	`newTempDir()` Creates a temporary directory in the TVC temp folder.
`static java.lang.String`	`read(java.net.URL u)` Reads the data from the URL and returns it as a string.
`static boolean`	`startsWith(java.io.PushbackInputStream in, byte[] header)` Checks if the first bytes in the inputstream equals the supplied bytes.

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

- Method Detail
  - copyStream
```
public static void copyStream(java.io.InputStream in,
                              java.io.OutputStream out)
                       throws java.io.IOException
```
    Copies the content of the InputStream into the OutputStream
    Calling this method is the same as performing:
```
 IOUtils.copyStream(in, out, false);
 
```
    Throws:
    
    java.io.IOException - upon I/O errors
  - copyStream
```
public static void copyStream(java.io.InputStream in,
                              java.io.OutputStream out,
                              boolean close)
                       throws java.io.IOException
```
    Copies the content of the InputStream into the OutputStream
    
    Parameters:
    
    in - The inputstream to read data from
    
    out - The outputstream to write to
    
    close - If true, the input stream and output stream is closed.
    
    Throws:
    
    java.io.IOException - upon I/O errors
  - copyStream
```
public static void copyStream(java.io.InputStream in,
                              java.io.OutputStream out,
                              long bytesToCopy)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - copy
```
public static void copy(java.io.Reader reader,
                        java.io.Writer writer)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getBytes
```
public static byte[] getBytes(java.io.InputStream in)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newTempDir
```
public static java.io.File newTempDir()
                               throws java.io.IOException
```
    Creates a temporary directory in the TVC temp folder.
    
    Returns:
    
    The temporary directory.
    
    Throws:
    
    java.io.IOException - If unable to create the directory.
    
    Since:
    
    5.2.2
  - deleteTree
```
public static boolean deleteTree(java.io.File file)
```
    Recursively deletes directories and files.
    
    Parameters:
    
    file - The file or directory to delete.
    
    Returns:
    
    Whether everything was deleted.
    
    Since:
    
    5.2.2
  - copyFile
```
public static void copyFile(java.io.File src,
                            java.io.File dest)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getBytes
```
public static byte[] getBytes(java.net.URL url)
```
    Reads the data from the URL and returns the bytes read.
    
    Parameters:
    
    url - The URL to read from.
    
    Returns:
    
    The bytes read (or null if nothing could be read).
    
    Since:
    
    2012.2.0
  - getLastModified
```
public static java.util.Date getLastModified(java.net.URL url)
```
    Gets the last modified timestamp from the URL connection. If an IO exception occurs while opening the connection, null will be returned.
    
    Parameters:
    
    url - The URL
    
    Returns:
    
    The modified timestamp (last modified), or null if unable to get that information.
    
    Since:
    
    2013.1.0
  - read
```
public static java.lang.String read(java.net.URL u)
```
    Reads the data from the URL and returns it as a string.
    
    Parameters:
    
    u - The URL to read from.
    
    Returns:
    
    A string
    
    Since:
    
    2009.1.0
  - startsWith
```
public static boolean startsWith(java.io.PushbackInputStream in,
                                 byte[] header)
                          throws java.io.IOException
```
    Checks if the first bytes in the inputstream equals the supplied bytes.
    
    Parameters:
    
    in - The inputstream.
    
    header - The header bytes. If the first bytes equals the bytes in the header this method returns true. Note that the PushbackInputStream must have a pushback buffer big enough for the number of bytes in the header.
    
    Returns:
    
    True if the first bytes in the inputstream equals the header.
    
    Throws:
    
    java.io.IOException - If unable to read/unread.
    
    Since:
    
    2009.3
  - isZipped
```
@Deprecated
public static boolean isZipped(java.io.PushbackInputStream in)
                                    throws java.io.IOException
```
    Deprecated.
    
    Returns true if the given input stream is zipped.
    
    Parameters:
    
    in - The inputstream, needs a pushback buffer of size 4 or more.
    
    Returns:
    
    True if the content in the stream is zipped.
    
    Throws:
    
    java.io.IOException - If unable to read/unread
    
    Since:
    
    2011.3.0
    
    See Also:
    
    ZipUtils.isZipped(PushbackInputStream)
  - isGZipped
```
public static boolean isGZipped(java.io.PushbackInputStream in)
                         throws java.io.IOException
```
    Returns true if the given input stream is gzipped.
    
    Parameters:
    
    in - The inputstream, needs a pushback buffer of size 2 or more.
    
    Returns:
    
    True if the content in the stream is gzipped.
    
    Throws:
    
    java.io.IOException - If unable to read/unread.
    
    Since:
    
    2009.3
  - inflate
```
public static java.io.InputStream inflate(java.io.InputStream in)
                                   throws java.io.IOException
```
    Inflate the bytes in this stream if it is deflated. This method will detect if the bytes in the given stream is GZIP'd and wrap the InputStream in a GZIPInputStream.
    
    Parameters:
    
    in - An InputStream.
    
    Returns:
    
    A new InputStream that will inflate the bytes in the supplied InputStream, if it is deflated.
    
    Throws:
    
    java.io.IOException - If unable to read from the InputStream.
    
    Since:
    
    2009.3
  - deflate
```
public static java.io.OutputStream deflate(java.io.OutputStream out)
                                    throws java.io.IOException
```
    Deflate the bytes in this stream. The supplied stream is wrapped inside a GZIPOutputStream.
    
    Parameters:
    
    out - An OutputStream.
    
    Returns:
    
    A GZIPOutputStream.
    
    Throws:
    
    java.io.IOException - If unable to create a GZIPOutputStream.
    
    Since:
    
    2009.3
  - closeQuietly
```
public static void closeQuietly(java.io.InputStream in)
```
    Calls IOUtils.closeQuietly(InputStream)
    
    Parameters:
    
    in -
    
    Since:
    
    2013.2.0
  - closeQuietly
```
public static void closeQuietly(java.io.Reader reader)
```
    Calls IOUtils.closeQuietly(Reader)
    
    Parameters:
    
    reader - The reader.
    
    Since:
    
    2013.2.0
  - closeQuietly
```
public static void closeQuietly(java.io.OutputStream out)
```
    Calls IOUtils.closeQuietly(OutputStream)
    
    Parameters:
    
    out - The output stream
    
    Since:
    
    2013.2.0
  - closeQuietly
```
public static void closeQuietly(java.io.Writer w)
```
    Calls IOUtils.closeQuietly(Writer)
    
    Parameters:
    
    w - The writer
    
    Since:
    
    2013.2.0

Class IOUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copyStream

copyStream

copyStream

copy

getBytes

newTempDir

deleteTree

copyFile

getBytes

getLastModified

read

startsWith

isZipped

isGZipped

inflate

deflate

closeQuietly

closeQuietly

closeQuietly

closeQuietly