Class UrlResourceDescriptor

    • Constructor Detail

      • UrlResourceDescriptor

        public UrlResourceDescriptor​(URL url,
                                     Charset charset)
                              throws URISyntaxException
        Creates a new resource descriptor that reads the data from the given URL.
        Parameters:
        url - URL pointing to the data. Must be an absolute URL.
        charset - Charset for plain text resources. Use NullPointerException for binary resources.
        Throws:
        URISyntaxException - When the URL is invalid.
        IllegalArgumentException - When the URL is not absolute.
      • UrlResourceDescriptor

        public UrlResourceDescriptor​(URL url,
                                     URI uri,
                                     Charset charset)
                              throws URISyntaxException
        Creates a new resource descriptor that reads the data from the given URL.
        Parameters:
        url - URL pointing to the data. Must be an absolute URL.
        uri - URI identifying to the resource, which may be different from the URL.
        charset - Charset for plain text resources. Use NullPointerException for binary resources.
        Throws:
        URISyntaxException - When the URL is invalid.
        IllegalArgumentException - When the URL is not absolute.
    • Method Detail

      • getCharset

        public Charset getCharset()
        Specified by:
        getCharset in interface IResourceDescriptor
        Returns:
        When this resource is a plain text resource: the charset or encoding of the text. Defaults to UTF_8.
      • forClasspathResource

        public static IResourceDescriptor forClasspathResource​(Class<?> clazz,
                                                               String path,
                                                               Charset charset)
                                                        throws URISyntaxException
        Creates a new resource descriptor that reads the data from the given classpath.
        Parameters:
        clazz - Class with a class loader for reading the resource.
        path - Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.
        charset - Charset for plain text files. null for binary files.
        Returns:
        A new resource descriptor that reads the data from the given classpath.
        Throws:
        URISyntaxException - When no URI was given and the URL obtained from the class loader cannot be converted to a URI.
        IllegalArgumentException - When the path cannot be loaded by the class loader.
      • forClasspathResource

        public static IResourceDescriptor forClasspathResource​(ClassLoader loader,
                                                               String path,
                                                               Charset charset)
                                                        throws URISyntaxException
        Creates a new resource descriptor that reads the data from the given classpath.
        Parameters:
        loader - Class loader for reading the resource.
        path - Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.
        charset - Charset for plain text files. null for binary files.
        Returns:
        A new resource descriptor that reads the data from the given classpath.
        Throws:
        URISyntaxException - When no URI was given and the URL obtained from the class loader cannot be converted to a URI.
        IllegalArgumentException - When the path cannot be loaded by the class loader.
      • forClasspathResource

        public static IResourceDescriptor forClasspathResource​(Class<?> clazz,
                                                               String path,
                                                               URI uri,
                                                               Charset charset)
                                                        throws URISyntaxException
        Creates a new resource descriptor that reads the data from the given classpath.
        Parameters:
        clazz - Class with a class loader for reading the resource.
        path - Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.
        uri - Identifier of the resource.
        charset - Charset for plain text files. null for binary files.
        Returns:
        A new resource descriptor that reads the data from the given classpath.
        Throws:
        URISyntaxException - When no URI was given and the URL obtained from the class loader cannot be converted to a URI.
        IllegalArgumentException - When the path cannot be loaded by the class loader.
      • forClasspathResource

        public static IResourceDescriptor forClasspathResource​(ClassLoader loader,
                                                               String path,
                                                               URI uri,
                                                               Charset charset)
                                                        throws URISyntaxException
        Creates a new resource descriptor that reads the data from the given classpath.
        Parameters:
        loader - Class loader for reading the resource.
        path - Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.
        uri - Identifier of the resource.
        charset - Charset for plain text files. null for binary files.
        Returns:
        A new resource descriptor that reads the data from the given classpath.
        Throws:
        URISyntaxException - When no URI was given and the URL obtained from the class loader cannot be converted to a URI.
        IllegalArgumentException - When the path cannot be loaded by the class loader.