Package com.google.common.io

Class Resources

java.lang.Object
com.google.common.io.Resources
@Beta @Deprecated(since="2022-12-01") public final class Resources extends Object
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
Provides utility methods for working with resources in the classpath. Note that even though these methods use URL parameters, they are usually not appropriate for HTTP or other non-classpath resources.

All method parameters must be non-null unless documented otherwise.

Since:
1.0

  • Method Details

    • newInputStreamSupplier

      public static InputSupplier<InputStream> newInputStreamSupplier(URL url)
      Deprecated.
      Returns a factory that will supply instances of InputStream that read from the given URL.
      Parameters:
      url - the URL to read from
      Returns:
      the factory

    • asByteSource

      public static ByteSource asByteSource(URL url)
      Deprecated.
      Returns a ByteSource that reads from the given URL.
      Since:
      14.0

    • newReaderSupplier

      public static InputSupplier<InputStreamReader> newReaderSupplier(URL url, Charset charset)
      Deprecated.
      Returns a factory that will supply instances of InputStreamReader that read a URL using the given character set.
      Parameters:
      url - the URL to read from
      charset - the charset used to decode the input stream; see Charsets for helpful predefined constants
      Returns:
      the factory

    • asCharSource

      public static CharSource asCharSource(URL url, Charset charset)
      Deprecated.
      Returns a CharSource that reads from the given URL using the given character set.
      Since:
      14.0

    • toByteArray

      public static byte[] toByteArray(URL url) throws IOException
      Deprecated.
      Reads all bytes from a URL into a byte array.
      Parameters:
      url - the URL to read from
      Returns:
      a byte array containing all the bytes from the URL
      Throws:
      IOException - if an I/O error occurs

    • toString

      public static String toString(URL url, Charset charset) throws IOException
      Deprecated.
      Reads all characters from a URL into a String, using the given character set.
      Parameters:
      url - the URL to read from
      charset - the charset used to decode the input stream; see Charsets for helpful predefined constants
      Returns:
      a string containing all the characters from the URL
      Throws:
      IOException - if an I/O error occurs.

    • readLines

      public static <T> T readLines(URL url, Charset charset, LineProcessor<T> callback) throws IOException
      Deprecated.
      Streams lines from a URL, stopping when our callback returns false, or we have read all of the lines.
      Parameters:
      url - the URL to read from
      charset - the charset used to decode the input stream; see Charsets for helpful predefined constants
      callback - the LineProcessor to use to handle the lines
      Returns:
      the output of processing the lines
      Throws:
      IOException - if an I/O error occurs

    • readLines

      public static List<String> readLines(URL url, Charset charset) throws IOException
      Deprecated.
      Reads all of the lines from a URL. The lines do not include line-termination characters, but do include other leading and trailing whitespace.

      This method returns a mutable List. For an ImmutableList, use Resources.asCharSource(url, charset).readLines().

      Parameters:
      url - the URL to read from
      charset - the charset used to decode the input stream; see Charsets for helpful predefined constants
      Returns:
      a mutable List containing all the lines
      Throws:
      IOException - if an I/O error occurs

    • copy

      public static void copy(URL from, OutputStream to) throws IOException
      Deprecated.
      Copies all bytes from a URL to an output stream.
      Parameters:
      from - the URL to read from
      to - the output stream
      Throws:
      IOException - if an I/O error occurs

    • getResource

      public static URL getResource(String resourceName)
      Deprecated.
      Returns a URL pointing to resourceName if the resource is found using the context class loader. In simple environments, the context class loader will find resources from the class path. In environments where different threads can have different class loaders, for example app servers, the context class loader will typically have been set to an appropriate loader for the current thread.

      In the unusual case where the context class loader is null, the class loader that loaded this class (Resources) will be used instead.

      Throws:
      IllegalArgumentException - if the resource is not found

    • getResource

      public static URL getResource(Class<?> contextClass, String resourceName)
      Deprecated.
      Given a resourceName that is relative to contextClass, returns a URL pointing to the named resource.
      Throws:
      IllegalArgumentException - if the resource is not found