程序包 cn.taketoday.core.io

类 InputStreamResource

java.lang.Object

cn.taketoday.core.io.AbstractResource

cn.taketoday.core.io.InputStreamResource

所有已实现的接口:

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

public class InputStreamResource
extends AbstractResource

Resource implementation for a given InputStream.

Should only be used if no other specific Resource implementation is applicable. In particular, prefer ByteArrayResource or any of the file-based Resource implementations where possible.

In contrast to other Resource implementations, this is a descriptor for an already opened resource. Do not use an InputStreamResource if you need to keep the resource descriptor somewhere, or if you need to read from a stream multiple times.

从以下版本开始:

3.0

作者:

Juergen Hoeller, Sam Brannen, TODAY 2021/3/7 11:18

另请参阅:

• ByteArrayResource
• ClassPathResource
• FileSystemResource
• UrlResource

字段概要

字段

修饰符和类型	字段	说明
private final String	description
private final InputStream	inputStream
private boolean	read

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

EMPTY_ARRAY

构造器概要

构造器

构造器	说明
InputStreamResource(InputStream inputStream)	Create a new InputStreamResource.
InputStreamResource(InputStream inputStream, String description)	Create a new InputStreamResource.

方法概要

修饰符和类型	方法	说明
boolean	equals(Object other)	This implementation compares the underlying InputStream.
boolean	exists()	This implementation always returns true.
InputStream	getInputStream()	This implementation throws IllegalStateException if attempting to read the underlying stream multiple times.
int	hashCode()	This implementation returns the hash code of the underlying InputStream.
boolean	isOpen()	This implementation always returns true.
String	toString()	This implementation returns a description that includes the passed-in description, if any.

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

contentLength, createRelative, customizeConnection, customizeConnection, getFile, getFileForLastModifiedCheck, getName, getURI, getURL, isDirectory, isFile, isReadable, lastModified, 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, readableChannel, transferTo

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

getContentAsByteArray, getContentAsString

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

accept, accept, throwing

字段详细资料

read

private boolean read

description

private final String description

inputStream

private final InputStream inputStream

构造器详细资料

InputStreamResource

public InputStreamResource(InputStream inputStream)

Create a new InputStreamResource.

参数:

inputStream - the InputStream to use

InputStreamResource

public InputStreamResource(InputStream inputStream,
 String description)

Create a new InputStreamResource.

参数:

inputStream - the InputStream to use

description - where the InputStream comes from

方法详细资料

exists

public boolean exists()

This implementation always returns true.

指定者:

exists 在接口中 Resource

覆盖:

exists 在类中 AbstractResource

isOpen

public boolean isOpen()

This implementation always returns true.

指定者:

isOpen 在接口中 Resource

覆盖:

isOpen 在类中 AbstractResource

getInputStream

public InputStream getInputStream()
                           throws IOException,
IllegalStateException

This implementation throws IllegalStateException if attempting to read the underlying stream multiple times.

返回:

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

IllegalStateException

另请参阅:

• Resource.isReadable()

toString

public String toString()

This implementation returns a description that includes the passed-in description, if any.

指定者:

toString 在接口中 Resource

覆盖:

toString 在类中 AbstractResource

另请参阅:

• Object.toString()

equals

public boolean equals(Object other)

This implementation compares the underlying InputStream.

覆盖:

equals 在类中 AbstractResource

hashCode

public int hashCode()

This implementation returns the hash code of the underlying InputStream.

覆盖:

hashCode 在类中 AbstractResource