Spring Framework 6.1.4 · org.springframework.core.io.WritableResource

Method Summary

Modifier and Type	Method and Description
public OutputStream	getOutputStream() Return an `OutputStream` for the underlying resource, allowing to (over-)write its content.
public default boolean	isWritable() Indicate whether the contents of this resource can be written via `getOutputStream()`.
public default WritableByteChannel	Returns: the byte channel for the underlying resource (must not be `null`) writableChannel() Return a `WritableByteChannel`.

Inherited from org.springframework.core.io.Resource:: contentLength createRelative exists getContentAsByteArray getContentAsString getDescription getFile getFilename getURI getURL isFile isOpen isReadable lastModified readableChannel

Method Detail

getOutputStream back to summary

getOutputStream	back to summary
public OutputStream getOutputStream() throws IOException Return an `OutputStream` for the underlying resource, allowing to (over-)write its content. Exceptions IOException: if the stream could not be opened See Also `getInputStream()`

public OutputStream getOutputStream() throws IOException

Return an OutputStream for the underlying resource, allowing to (over-)write its content.

Exceptions

IOException:: if the stream could not be opened

See Also

getInputStream()

isWritable back to summary

isWritable	back to summary
public default boolean isWritable() Indicate whether the contents of this resource can be written via `getOutputStream()`. Will be `true` for typical resource descriptors; note that actual content writing may still fail when attempted. However, a value of `false` is a definitive indication that the resource content cannot be modified. See Also `getOutputStream()`, `isReadable()`

public default boolean isWritable()

Indicate whether the contents of this resource can be written via getOutputStream().

Will be true for typical resource descriptors; note that actual content writing may still fail when attempted. However, a value of false is a definitive indication that the resource content cannot be modified.

See Also: getOutputStream(), isReadable()

writableChannel back to summary

writableChannel	back to summary
public default WritableByteChannel writableChannel() throws IOException Return a `WritableByteChannel`. It is expected that each call creates a fresh channel. The default implementation returns `Channels#newChannel(OutputStream)` with the result of `getOutputStream()`. Returns:WritableByteChannel the byte channel for the underlying resource (must not be `null`) Exceptions IOException: if the content channel could not be opened FileNotFoundException: if the underlying resource doesn't exist Since 5.0 See Also `getOutputStream()`

public default WritableByteChannel writableChannel() throws IOException

Return a WritableByteChannel.

It is expected that each call creates a fresh channel.

The default implementation returns Channels#newChannel(OutputStream) with the result of getOutputStream().

Returns:WritableByteChannel

the byte channel for the underlying resource (must not be null)

Exceptions

IOException:: if the content channel could not be opened
FileNotFoundException:: if the underlying resource doesn't exist

Since

5.0

See Also

getOutputStream()

public Interface WritableResource

Method Summary

Method Detail