Class UrlResource

Constructor Detail

• UrlResource

  public UrlResource​(URI uri)
              throws MalformedURLException

  Create a new UrlResource based on the given URI object.

  Parameters:

  uri - a URI

  Throws:

  MalformedURLException - if the given URL path is not valid

  Since:

  2.5

• UrlResource

  public UrlResource​(URL url)

  Create a new UrlResource based on the given URL object.

  Parameters:

  url - a URL

• UrlResource

  public UrlResource​(String path)
              throws MalformedURLException

  Create a new UrlResource based on a URL path.

  Note: The given path needs to be pre-encoded if necessary.

  Parameters:

  path - a URL path

  Throws:

  MalformedURLException - if the given URL path is not valid

  See Also:

  URL(String)

• UrlResource

  public UrlResource​(String protocol,
                     String location)
              throws MalformedURLException

  Create a new UrlResource based on a URI specification.

  The given parts will automatically get encoded if necessary.

  Parameters:

  protocol - the URL protocol to use (e.g. "jar" or "file" - without colon); also known as "scheme"

  location - the location (e.g. the file path within that protocol); also known as "scheme-specific part"

  Throws:

  MalformedURLException - if the given URL specification is not valid

  See Also:

  URI(String, String, String)

• UrlResource

  public UrlResource​(String protocol,
                     String location,
                     String fragment)
              throws MalformedURLException

  Create a new UrlResource based on a URI specification.

  The given parts will automatically get encoded if necessary.

  Parameters:

  protocol - the URL protocol to use (e.g. "jar" or "file" - without colon); also known as "scheme"

  location - the location (e.g. the file path within that protocol); also known as "scheme-specific part"

  fragment - the fragment within that location (e.g. anchor on an HTML page, as following after a "#" separator)

  Throws:

  MalformedURLException - if the given URL specification is not valid

  See Also:

  URI(String, String, String)

Method Detail

• getInputStream

  public InputStream getInputStream()
                             throws IOException

  This implementation opens an InputStream for the given URL.

  It sets the useCaches flag to false, mainly to avoid jar file locking on Windows.

  Returns:

  the input stream for the underlying resource (must not be null)

  Throws:

  FileNotFoundException - if the underlying resource doesn't exist

  IOException - if the content stream could not be opened

  See Also:

  URL.openConnection(), URLConnection.setUseCaches(boolean), URLConnection.getInputStream()

• getURL

  public URL getURL()
             throws IOException

  This implementation returns the underlying URL reference.

  Specified by:

  getURL in interface Resource

  Overrides:

  getURL in class AbstractResource

  Throws:

  IOException - if the resource cannot be resolved as URL, i.e. if the resource is not available as descriptor

• getURI

  public URI getURI()
             throws IOException

  This implementation returns the underlying URI directly, if possible.

  Specified by:

  getURI in interface Resource

  Overrides:

  getURI in class AbstractResource

  Throws:

  IOException - if the resource cannot be resolved as URI, i.e. if the resource is not available as descriptor

• getFile

  public File getFile()
               throws IOException

  This implementation returns a File reference for the underlying URL/URI, provided that it refers to a file in the file system.

  Specified by:

  getFile in interface Resource

  Overrides:

  getFile in class AbstractFileResolvingResource

  Throws:

  FileNotFoundException - if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file system

  IOException - in case of general resolution/reading failures

  See Also:

  ResourceUtils.getFile(java.net.URL, String)

• createRelative

  public Resource createRelative​(String relativePath)
                          throws MalformedURLException

  This implementation creates a UrlResource, applying the given path relative to the path of the underlying URL of this resource descriptor.

  Specified by:

  createRelative in interface Resource

  Overrides:

  createRelative in class AbstractResource

  Parameters:

  relativePath - the relative path (relative to this resource)

  Returns:

  the resource handle for the relative resource

  Throws:

  MalformedURLException

  See Also:

  URL(java.net.URL, String)

• getFilename

  public String getFilename()

  This implementation returns the name of the file that this URL refers to.

  Specified by:

  getFilename in interface Resource

  Overrides:

  getFilename in class AbstractResource

  See Also:

  URL.getPath()

• getDescription

  public String getDescription()

  This implementation returns a description that includes the URL.

  See Also:

  Object.toString()

• equals

  public boolean equals​(Object obj)

  This implementation compares the underlying URL references.

  Overrides:

  equals in class AbstractResource

  See Also:

  Resource.getDescription()

• hashCode

  public int hashCode()

  This implementation returns the hash code of the underlying URL reference.

  Overrides:

  hashCode in class AbstractResource

  See Also:

  Resource.getDescription()