程序包 cn.taketoday.core.io

类 UrlResource

java.lang.Object

cn.taketoday.core.io.AbstractResource

cn.taketoday.core.io.AbstractFileResolvingResource

cn.taketoday.core.io.UrlResource

所有已实现的接口:

InputStreamSource, Resource, ThrowingConsumer<OutputStream>, Consumer<OutputStream>

直接已知子类:

FileUrlResource

public class UrlResource
extends AbstractFileResolvingResource

Resource implementation for java.net.URL locators. Supports resolution as a URL and also as a File in case of the "file:" protocol.

从以下版本开始:

2.1.6 2019-05-14 22:26

作者:

Harry Yang, Juergen Hoeller, Sam Brannen

另请参阅:

• URL

字段概要

字段

修饰符和类型	字段	说明
private static final String	AUTHORIZATION
private String	cleanedUrl	Cleaned URL String (with normalized path), used for comparisons.
private final URI	uri	Original URI, if available; used for URI and File access.
private final URL	url	Original URL, used for actual access.

从接口继承的字段 cn.taketoday.core.io.Resource

EMPTY_ARRAY

构造器概要

构造器

构造器	说明
UrlResource(String path)	Create a new UrlResource based on a URI path.
UrlResource(String protocol, String location)	Create a new UrlResource based on a URI specification.
UrlResource(String protocol, String location, String fragment)	Create a new UrlResource based on a URI specification.
UrlResource(URI uri)	Create a new UrlResource based on the given URI object.
UrlResource(URL url)	Create a new UrlResource based on the given URL object.

方法概要

修饰符和类型	方法	说明
UrlResource	createRelative(String relativePath)	This implementation creates a UrlResource, delegating to createRelativeURL(String) for adapting the relative path.
protected URL	createRelativeURL(String relativePath)	This delegate creates a java.net.URL, applying the given path relative to the path of the underlying URL of this resource descriptor.
protected void	customizeConnection(URLConnection con)	Customize the given URLConnection before fetching the resource.
boolean	equals(Object other)	This implementation compares the underlying URL references.
static UrlResource	from(String path)	Create a new UrlResource from the given URL path.
static UrlResource	from(URI uri)	Create a new UrlResource from the given URI.
private String	getCleanedUrl()	Lazily determine a cleaned URL for the given original URL.
File	getFile()	This implementation returns a File reference for the underlying URL/URI, provided that it refers to a file in the file system.
InputStream	getInputStream()	This implementation opens an InputStream for the given URL.
String	getName()	This implementation returns the URL-decoded name of the file that this URL refers to.
URI	getURI()	This implementation returns the underlying URI directly, if possible.
URL	getURL()	This implementation returns the underlying URL reference.
int	hashCode()	This implementation returns the hash code of the underlying URL reference.
boolean	isFile()	This implementation always returns false.
String	toString()	This implementation returns a description that includes the URL.

从类继承的方法 cn.taketoday.core.io.AbstractFileResolvingResource

checkReadable, contentLength, customizeConnection, exists, getFile, getFileForLastModifiedCheck, isFile, isReadable, lastModified, readableChannel

从类继承的方法 cn.taketoday.core.io.AbstractResource

isDirectory, isOpen, list, list

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.util.function.Consumer

andThen

从接口继承的方法 cn.taketoday.core.io.InputStreamSource

acceptWithException, getReader, getReader, transferTo

从接口继承的方法 cn.taketoday.core.io.Resource

getContentAsByteArray, getContentAsString

从接口继承的方法 cn.taketoday.util.function.ThrowingConsumer

accept, accept, throwing

字段详细资料

AUTHORIZATION

private static final String AUTHORIZATION

另请参阅:

• 常量字段值

uri

@Nullable
private final URI uri

Original URI, if available; used for URI and File access.

url

private final URL url

Original URL, used for actual access.

cleanedUrl

@Nullable
private volatile String cleanedUrl

Cleaned URL String (with normalized path), used for comparisons.

构造器详细资料

UrlResource

public UrlResource(URI uri)
            throws MalformedURLException

Create a new UrlResource based on the given URI object.

参数:

uri - a URI

抛出:

MalformedURLException - if the given URL path is not valid

从以下版本开始:

4.0

UrlResource

public UrlResource(URL url)

Create a new UrlResource based on the given URL object.

参数:

url - a URL

UrlResource

public UrlResource(String path)
            throws MalformedURLException

Create a new UrlResource based on a URI path.

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

参数:

path - a URI path

抛出:

MalformedURLException - if the given URI path is not valid

从以下版本开始:

4.0

另请参阅:

• ResourceUtils.toURI(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.

参数:

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"

抛出:

MalformedURLException - if the given URL specification is not valid

从以下版本开始:

4.0

另请参阅:

• URI(String, String, String)

UrlResource

public UrlResource(String protocol,
 String location,
 @Nullable
 String fragment)
            throws MalformedURLException

Create a new UrlResource based on a URI specification.

The given parts will automatically get encoded if necessary.

参数:

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)

抛出:

MalformedURLException - if the given URL specification is not valid

从以下版本开始:

4.0

另请参阅:

• URI(String, String, String)

方法详细资料

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.

返回:

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

抛出:

FileNotFoundException - if the underlying resource does not exist

IOException - if the content stream could not be opened

另请参阅:

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

customizeConnection

protected void customizeConnection(URLConnection con)
                            throws IOException

从类复制的说明: AbstractFileResolvingResource

Customize the given URLConnection before fetching the resource.

Calls ResourceUtils.useCachesIfNecessary(URLConnection) and delegates to AbstractFileResolvingResource.customizeConnection(HttpURLConnection) if possible. Can be overridden in subclasses.

覆盖:

customizeConnection 在类中 AbstractFileResolvingResource

参数:

con - the URLConnection to customize

抛出:

IOException - if thrown from URLConnection methods

getURL

public URL getURL()

This implementation returns the underlying URL reference.

指定者:

getURL 在接口中 Resource

覆盖:

getURL 在类中 AbstractResource

getURI

public URI getURI()
           throws IOException

This implementation returns the underlying URI directly, if possible.

指定者:

getURI 在接口中 Resource

覆盖:

getURI 在类中 AbstractResource

抛出:

IOException - if the resource cannot be resolved as URI, i.e. if the resource is not available as a 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.

指定者:

getFile 在接口中 Resource

覆盖:

getFile 在类中 AbstractFileResolvingResource

抛出:

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

另请参阅:

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

isFile

public boolean isFile()

从类复制的说明: AbstractResource

This implementation always returns false.

指定者:

isFile 在接口中 Resource

覆盖:

isFile 在类中 AbstractFileResolvingResource

另请参阅:

• Resource.getFile()

getCleanedUrl

private String getCleanedUrl()

Lazily determine a cleaned URL for the given original URL.

getName

@Nullable
public String getName()

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

指定者:

getName 在接口中 Resource

覆盖:

getName 在类中 AbstractResource

另请参阅:

• URL.getPath()
• URLDecoder.decode(String, java.nio.charset.Charset)

equals

public boolean equals(@Nullable
 Object other)

This implementation compares the underlying URL references.

覆盖:

equals 在类中 AbstractResource

hashCode

public int hashCode()

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

覆盖:

hashCode 在类中 AbstractResource

createRelative

public UrlResource createRelative(String relativePath)
                           throws IOException

This implementation creates a UrlResource, delegating to createRelativeURL(String) for adapting the relative path.

指定者:

createRelative 在接口中 Resource

覆盖:

createRelative 在类中 AbstractResource

参数:

relativePath - the relative path (relative to this resource)

返回:

the resource handle for the relative resource

抛出:

IOException - if the relative resource cannot be determined

另请参阅:

• createRelativeURL(String)

createRelativeURL

protected URL createRelativeURL(String relativePath)
                         throws MalformedURLException

This delegate creates a java.net.URL, applying the given path relative to the path of the underlying URL of this resource descriptor. A leading slash will get dropped; a "#" symbol will get encoded.

抛出:

MalformedURLException

另请参阅:

• createRelative(String)
• ResourceUtils.toRelativeURL(URL, String)

toString

public String toString()

This implementation returns a description that includes the URL.

指定者:

toString 在接口中 Resource

覆盖:

toString 在类中 AbstractResource

另请参阅:

• Object.toString()

from

public static UrlResource from(URI uri)
                        throws UncheckedIOException

Create a new UrlResource from the given URI.

This factory method is a convenience for UrlResource(URI) that catches any MalformedURLException and rethrows it wrapped in an UncheckedIOException; suitable for use in Stream and Optional APIs or other scenarios when a checked IOException is undesirable.

参数:

uri - a URI

抛出:

UncheckedIOException - if the given URL path is not valid

从以下版本开始:

4.0

另请参阅:

• UrlResource(URI)

from

public static UrlResource from(String path)
                        throws UncheckedIOException

Create a new UrlResource from the given URL path.

This factory method is a convenience for UrlResource(String) that catches any MalformedURLException and rethrows it wrapped in an UncheckedIOException; suitable for use in Stream and Optional APIs or other scenarios when a checked IOException is undesirable.

参数:

path - a URL path

抛出:

UncheckedIOException - if the given URL path is not valid

从以下版本开始:

4.0

另请参阅:

• UrlResource(String)