Field Detail

• public static final int BUFFER_SIZE

  The default buffer size used when copying bytes.

• public static final String RESOURCE_JAR_PREFIX

• public static final String RESOURCE_WAR_PREFIX

Constructor Detail

• IOUtils()

Method Detail

• static void closeQuietly(Closeable closeable)

  Closes a closeable gracefully without throwing exceptions etc.

  Parameters:

  closeable - The closeable

• static void copy(InputStream input, Writer output, String encoding)

  Copy an InputStream to the given writer with the given encoding

  Parameters:

  input - The input

  output - The writer

  encoding - The encoding

• static int copy(Resource resource, 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:

  resource - the resource to copy from

  out - the file to copy to

  Returns:

  the number of bytes copied

• static int copy(Reader reader, Writer writer)

  Copy the contents of the given Reader to the given Writer. Closes both when done.

  throws:

  IOException in case of I/O errors

  Parameters:

  reader - the Reader to copy from

  writer - the Writer to copy to

  Returns:

  the number of characters copied

• static int copy(InputStream is, OutputStream os)

  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:

  is - the stream to copy from

  os - the stream to copy to

  Returns:

  the number of bytes copied

• static String copyToString(Reader reader)

  Convert a reader to a String, reading the data from the reader

  Parameters:

  reader - The reader

  Returns:

  The string

• static String copyToString(InputStream stream, String encoding)

  Convert a stream to a String, reading the data from the stream

  Parameters:

  stream - The stream

  Returns:

  The string

• static XmlSlurper createXmlSlurper()

• @Memoized
  static String findApplicationDirectory()

  Finds the directory where the Application class is contained

  Returns:

  The application directory

• @Memoized
  static File findApplicationDirectoryFile()

• static File findApplicationDirectoryFile(Class targetClass)

  Finds the application directory for the given class

  Parameters:

  targetClass - The target class

  Returns:

  The application directory or null if it can't be found

• static URL findClassResource(Class targetClass)

  Returns the URL resource for the location on disk of the given class or null if it cannot be found

  Parameters:

  targetClass - The target class

  Returns:

  The URL to class file or null

• static File findJarFile(Class targetClass)

  Finds a JAR file for the given class

  Parameters:

  targetClass - The target class

  Returns:

  The JAR file

• static File findJarFile(Resource resource)

  Finds a JAR for the given resource

  Parameters:

  resource - The resource

  Returns:

  The JAR file or null if it can't be found

• static File findJarFile(URL resource)

  Finds a JAR for the given resource

  Parameters:

  resource - The resource

  Returns:

  The JAR file or null if it can't be found

• static URL findJarResource(Class targetClass)

  Returns the URL resource for the location on disk of the given class or null if it cannot be found

  Parameters:

  targetClass - The target class

  Returns:

  The URL to class file or null

• static URL findResourceRelativeToClass(Class targetClass, String path)

  Finds a URL within a JAR relative (from the root) to the given class @return

  Parameters:

  targetClass

  path

• static URL findRootResource(Class targetClass)

  Returns a URL that represents the root classpath resource where the given class was loaded from

  Parameters:

  targetClass - The target class

  Returns:

  The URL to class file or null

• static URL findRootResourcesURL(Class targetClass)

  This method differs from findRootResource(java.lang.Class) in that it will find the root URL where to load resources defined in src/main/resources At development time this with be build/main/resources, but in production it will be relative to the class. @return

  Parameters:

  targetClass

  path

• @Memoized
  static File findSourceFile(String className)

  Finds a source file for the given class name

  Parameters:

  className - The class name

  Returns:

  The source file

• static boolean isWithinBinary(URL url)

  Whether the given URL is within a binary like a JAR or WAR file

  Parameters:

  url - The URL

  Returns:

  True if it is

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

• static BufferedInputStream openStream(File file)

  Gracefully opens a stream for a file, throwing exceptions where appropriate. Based off the commons-io method

  Parameters:

  file - The file

  Returns:

  The stream

• @Deprecated(since: 2024.0.0, forRemoval: true)
  static String toString(Reader reader)

  Convert a reader to a String, reading the data from the reader

  deprecated:

  since 2024.0.0 in favor of copyToString(Reader)

  Parameters:

  reader - The reader

  Returns:

  The string

• @Deprecated(since: 2024.0.0, forRemoval: true)
  static String toString(InputStream stream, String encoding)

  Convert a stream to a String, reading the data from the stream

  deprecated:

  since 2024.0.0 in favor of copyToString(InputStream, String)

  Parameters:

  stream - The stream

  Returns:

  The string