程序包 cn.taketoday.core.io

类 ByteArrayResource

java.lang.Object

cn.taketoday.core.io.AbstractResource

cn.taketoday.core.io.ByteArrayResource

所有已实现的接口:

InputStreamSource, Resource

public class ByteArrayResource
extends AbstractResource

Resource implementation for a given byte array.

Creates a ByteArrayInputStream for the given byte array.

Useful for loading content from any given byte array, without having to resort to a single-use InputStreamResource. Particularly useful for creating mail attachments from local content, where JavaMail needs to be able to read the stream multiple times.

从以下版本开始:

3.0

作者:

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

另请参阅:

• ByteArrayInputStream
• InputStreamResource

字段概要

字段

修饰符和类型	字段	说明
private final byte[]	byteArray
private final String	description

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

EMPTY_ARRAY

构造器概要

构造器

构造器	说明
ByteArrayResource(byte[] byteArray)	Create a new ByteArrayResource.
ByteArrayResource(byte[] byteArray, String description)	Create a new ByteArrayResource with a description.

方法概要

修饰符和类型	方法	说明
long	contentLength()	This implementation returns the length of the underlying byte array.
boolean	equals(Object other)	This implementation compares the underlying byte array.
boolean	exists()	This implementation always returns true.
final byte[]	getByteArray()	Return the underlying byte array.
byte[]	getContentAsByteArray()	Return the contents of this resource as a byte array.
String	getContentAsString(Charset charset)	Returns the contents of this resource as a string, using the specified charset.
InputStream	getInputStream()	This implementation returns a ByteArrayInputStream for the underlying byte array.
int	hashCode()	This implementation returns the hash code based on the underlying byte array.
boolean	isReadable()	This implementation always returns true for a resource that exists (revised as of 5.1).
String	toString()	This implementation returns a description that includes the passed-in description, if any.

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

createRelative, customizeConnection, customizeConnection, getFile, getFileForLastModifiedCheck, getName, getURI, getURL, isDirectory, isFile, isOpen, lastModified, list, list

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

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

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

getReader, getReader, readableChannel

字段详细资料

byteArray

private final byte[] byteArray

description

private final String description

构造器详细资料

ByteArrayResource

public ByteArrayResource(byte[] byteArray)

Create a new ByteArrayResource.

参数:

byteArray - the byte array to wrap

ByteArrayResource

public ByteArrayResource(byte[] byteArray,
 String description)

Create a new ByteArrayResource with a description.

参数:

byteArray - the byte array to wrap

description - where the byte array comes from

方法详细资料

getByteArray

public final byte[] getByteArray()

Return the underlying byte array.

isReadable

public boolean isReadable()

从类复制的说明: AbstractResource

This implementation always returns true for a resource that exists (revised as of 5.1).

指定者:

isReadable 在接口中 Resource

覆盖:

isReadable 在类中 AbstractResource

另请参阅:

• InputStreamSource.getInputStream()
• Resource.exists()

exists

public boolean exists()

This implementation always returns true.

指定者:

exists 在接口中 Resource

覆盖:

exists 在类中 AbstractResource

contentLength

public long contentLength()

This implementation returns the length of the underlying byte array.

指定者:

contentLength 在接口中 Resource

覆盖:

contentLength 在类中 AbstractResource

另请参阅:

• InputStreamSource.getInputStream()

getInputStream

public InputStream getInputStream()
                           throws IOException

This implementation returns a ByteArrayInputStream for the underlying byte array.

返回:

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

另请参阅:

• ByteArrayInputStream

getContentAsByteArray

public byte[] getContentAsByteArray()
                             throws IOException

从接口复制的说明: Resource

Return the contents of this resource as a byte array.

返回:

the contents of this resource as byte array

抛出:

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

getContentAsString

public String getContentAsString(Charset charset)
                          throws IOException

从接口复制的说明: Resource

Returns the contents of this resource as a string, using the specified charset.

参数:

charset - the charset to use for decoding

返回:

the contents of this resource as a String

抛出:

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

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 byte array.

覆盖:

equals 在类中 AbstractResource

另请参阅:

• Arrays.equals(byte[], byte[])

hashCode

public int hashCode()

This implementation returns the hash code based on the underlying byte array.

覆盖:

hashCode 在类中 AbstractResource