SpringIOUtils (Grails 8.0.0)

org.grails.io.support.SpringIOUtils

```
@java.lang.SuppressWarnings("unchecked")
public class SpringIOUtils
extends java.lang.Object
```
Simple utility methods for file and stream copying. All copy methods use a block size of 4096 bytes, and close all affected streams when done.
Mainly for use within the framework, but also useful for application code.
Authors:
Juergen Hoeller
Graeme Rocher
Since:
06.10.2003

Field Summary

Fields
Modifiers	Name	Description
`static int`	`BUFFER_SIZE`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static java.lang.Object[]`	`addAll(java.lang.Object[] array1, java.lang.Object[] array2)` Adds the contents of 1 array to another
	`public static java.lang.String`	`byteArrayToHexString(byte[] in)` Convert a byte[] array to readable string format.
	`public static void`	`closeQuietly(java.io.Closeable closeable)` Closes a closeable gracefully without throwing exceptions etc.
	`public static java.lang.String`	`computeChecksum(java.io.File f, java.lang.String algorithm)`
	`public static int`	`copy(java.io.File in, java.io.File out)` Copy the contents of the given input File to the given output File.
	`public static int`	`copy(Resource in, java.io.File out)` Copy the contents of the given input File to the given output File.
	`public static void`	`copy(byte[] in, java.io.File out)` Copy the contents of the given byte array to the given output File.
	`public static int`	`copy(java.io.InputStream in, java.io.OutputStream out)` Copy the contents of the given InputStream to the given OutputStream.
	`public static void`	`copy(byte[] in, java.io.OutputStream out)` Copy the contents of the given byte array to the given OutputStream.
	`public static int`	`copy(java.io.Reader in, java.io.Writer out)` Copy the contents of the given Reader to the given Writer.
	`public static void`	`copy(java.lang.String in, java.io.Writer out)` Copy the contents of the given String to the given output Writer.
	`public static void`	`copyAll(Resource base, Resource[] resources, java.io.File targetDir)` Copies all the resources for the given target directory.
	`public static byte[]`	`copyToByteArray(java.io.File in)` Copy the contents of the given input File into a new byte array.
	`public static byte[]`	`copyToByteArray(java.io.InputStream in)` Copy the contents of the given InputStream into a new byte array.
	`public static java.lang.String`	`copyToString(java.io.Reader in)` Copy the contents of the given Reader into a String.
	`public static XmlSlurper`	`createXmlSlurper()` Creates an XmlSlurper for untrusted documents such as HTTP request bodies.
	`public static XmlSlurper`	`createXmlSlurper(boolean allowDocTypeDeclaration)` Creates an XmlSlurper, optionally tolerating a `DOCTYPE` declaration.
	`public static javax.xml.parsers.SAXParser`	`newSAXParser()` Creates a javax.xml.parsers.SAXParser for untrusted documents such as HTTP request bodies.
	`public static javax.xml.parsers.SAXParser`	`newSAXParser(boolean allowDocTypeDeclaration)` Creates a javax.xml.parsers.SAXParser, optionally tolerating a `DOCTYPE` declaration.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Field Detail
  - public static final int BUFFER_SIZE
- Method Detail
  - public static java.lang.Object[] addAll(java.lang.Object[] array1, java.lang.Object[] array2)
    
    Adds the contents of 1 array to another
    Parameters:
    array1 - The target array
    array2 - The source array
    Returns:
    The new array
  - public static java.lang.String byteArrayToHexString(byte[] in)
    
    Convert a byte[] array to readable string format. This makes the "hex" readable!
    Returns:
    result in String format
    Parameters:
    in - byte[] buffer to convert to string format
  - public static void closeQuietly(java.io.Closeable closeable)
    
    Closes a closeable gracefully without throwing exceptions etc.
    Parameters:
    closeable - The closeable
  - public static java.lang.String computeChecksum(java.io.File f, java.lang.String algorithm)
  - public static int copy(java.io.File in, java.io.File out)
    
    Copy the contents of the given input File to the given output File.
    throws:
    java.io.IOException in case of I/O errors
    
    Parameters:
    in - the file to copy from
    out - the file to copy to
    Returns:
    the number of bytes copied
  - public static int copy(Resource in, java.io.File out)
    
    Copy the contents of the given input File to the given output File.
    throws:
    java.io.IOException in case of I/O errors
    
    Parameters:
    in - the file to copy from
    out - the file to copy to
    Returns:
    the number of bytes copied
  - public static void copy(byte[] in, java.io.File out)
    
    Copy the contents of the given byte array to the given output File.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the byte array to copy from
    out - the file to copy to
  - public static int copy(java.io.InputStream in, java.io.OutputStream out)
    
    Copy the contents of the given InputStream to the given OutputStream. Closes both streams when done.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the stream to copy from
    out - the stream to copy to
    Returns:
    the number of bytes copied
  - public static void copy(byte[] in, java.io.OutputStream out)
    
    Copy the contents of the given byte array to the given OutputStream. Closes the stream when done.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the byte array to copy from
    out - the OutputStream to copy to
  - public static int copy(java.io.Reader in, java.io.Writer out)
    
    Copy the contents of the given Reader to the given Writer. Closes both when done.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the Reader to copy from
    out - the Writer to copy to
    Returns:
    the number of characters copied
  - public static void copy(java.lang.String in, java.io.Writer out)
    
    Copy the contents of the given String to the given output Writer. Closes the write when done.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the String to copy from
    out - the Writer to copy to
  - public static void copyAll(Resource base, Resource[] resources, java.io.File targetDir)
    
    Copies all the resources for the given target directory. The base resource serves to calculate the relative path such that the directory structure is maintained
    Parameters:
    base - The base resource
    resources - The resources to copy
    targetDir - The target directory
  - public static byte[] copyToByteArray(java.io.File in)
    
    Copy the contents of the given input File into a new byte array.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the file to copy from
    Returns:
    the new byte array that has been copied to
  - public static byte[] copyToByteArray(java.io.InputStream in)
    
    Copy the contents of the given InputStream into a new byte array. Closes the stream when done.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the stream to copy from
    Returns:
    the new byte array that has been copied to
  - public static java.lang.String copyToString(java.io.Reader in)
    
    Copy the contents of the given Reader into a String. Closes the reader when done.
    throws:
    IOException in case of I/O errors
    
    Parameters:
    in - the reader to copy from
    Returns:
    the String that has been copied to
  - public static XmlSlurper createXmlSlurper()
    
    Creates an XmlSlurper for untrusted documents such as HTTP request bodies.
    The parser refuses a DOCTYPE declaration outright, on top of the entity and DTD hardening every parser handed out by this class applies. Readers of trusted descriptors that declare one use createXmlSlurper(boolean) with true instead.
    Returns:
    a namespace-aware, non-validating slurper that rejects DOCTYPE declarations
  - public static XmlSlurper createXmlSlurper(boolean allowDocTypeDeclaration)
    
    Creates an XmlSlurper, optionally tolerating a DOCTYPE declaration.
    Documents parsed through this class fall into two trust levels, and each level gets its own parser. Request bodies are untrusted and are refused if they declare a DOCTYPE; that is the false form and the default. Descriptors read from the application classpath, such as JSP tag library descriptors and web.xml, are trusted and routinely declare one, so their readers pass true.
    Tolerating the declaration does not reopen the XXE vector. External general entities, external parameter entities, DTD grammar loading and external DTD retrieval stay off on both parsers, so an entity that points at a file on disk contributes nothing and the DTD a document names is skipped rather than fetched.
    Parameters:
    allowDocTypeDeclaration - true to parse documents that declare a DOCTYPE
    Returns:
    a namespace-aware, non-validating slurper with the hardening described above
    Since:
    8.0.0
  - public static javax.xml.parsers.SAXParser newSAXParser()
    
    Creates a javax.xml.parsers.SAXParser for untrusted documents such as HTTP request bodies.
    The parser refuses a DOCTYPE declaration outright; see createXmlSlurper(boolean) for the two trust levels.
    Returns:
    a namespace-aware, non-validating parser that rejects DOCTYPE declarations
  - public static javax.xml.parsers.SAXParser newSAXParser(boolean allowDocTypeDeclaration)
    
    Creates a javax.xml.parsers.SAXParser, optionally tolerating a DOCTYPE declaration.
    Applies the same hardening as createXmlSlurper(boolean).
    Parameters:
    allowDocTypeDeclaration - true to parse documents that declare a DOCTYPE
    Returns:
    a namespace-aware, non-validating parser
    Since:
    8.0.0

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class SpringIOUtils

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final int BUFFER_SIZE

Method Detail

public static java.lang.Object[] addAll(java.lang.Object[] array1, java.lang.Object[] array2)

public static java.lang.String byteArrayToHexString(byte[] in)

public static void closeQuietly(java.io.Closeable closeable)

public static java.lang.String computeChecksum(java.io.File f, java.lang.String algorithm)

public static int copy(java.io.File in, java.io.File out)

public static int copy(Resource in, java.io.File out)

public static void copy(byte[] in, java.io.File out)

public static int copy(java.io.InputStream in, java.io.OutputStream out)

public static void copy(byte[] in, java.io.OutputStream out)

public static int copy(java.io.Reader in, java.io.Writer out)

public static void copy(java.lang.String in, java.io.Writer out)

public static void copyAll(Resource base, Resource[] resources, java.io.File targetDir)

public static byte[] copyToByteArray(java.io.File in)

public static byte[] copyToByteArray(java.io.InputStream in)

public static java.lang.String copyToString(java.io.Reader in)

public static XmlSlurper createXmlSlurper()

public static XmlSlurper createXmlSlurper(boolean allowDocTypeDeclaration)

public static javax.xml.parsers.SAXParser newSAXParser()

public static javax.xml.parsers.SAXParser newSAXParser(boolean allowDocTypeDeclaration)