Package nl.vpro.domain.image.backend

Class ImageStream

java.lang.Object

nl.vpro.domain.image.backend.ImageStream

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ReusableImageStream

public class ImageStream
extends Object
implements AutoCloseable

An image stream represents the actual blob data for an image.

This contains an InputStream plus some information that may be provided by the backing implementation like getLength() and getEtag()

The ReusableImageStream specialization will allow for repeated calls on getStream() resulting a stream that can be used over and over again.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageStream.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	closed
protected String	contentType
protected String	etag
protected Instant	lastModified
protected long	length
protected org.meeuw.functional.ThrowingRunnable<IOException>	onClose
protected InputStream	stream
protected URI	url

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ImageStream(@NonNull InputStream stream, @javax.validation.constraints.Min(0L) long length, @Nullable Instant lastModified, @Nullable String contentType, @Nullable String etag, @Nullable URI url, @Nullable org.meeuw.functional.ThrowingRunnable<IOException> onClose)
	ImageStream(InputStream stream, long length, Instant lastModified)
protected	ImageStream(InputStream stream, Instant lastModified)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(@Nullable Object other)
void	close()
boolean	equals(@Nullable Object o)
String	getContentType()
String	getEtag()
Instant	getLastModified()
long	getLength()
org.meeuw.functional.ThrowingRunnable<IOException>	getOnClose()
InputStream	getStream()
URI	getUrl()
int	hashCode()
static @NonNull ImageStream.Builder	imageStreamBuilder()
boolean	isClosed()
static ReusableImageStream	of(byte[] bytes)
static ImageStream	of(File file)
static ImageStream	of(InputStream stream)
static ImageStream	of(InputStream stream, Instant lastModified)
static ImageStream	of(URL url)
static ImageStream	of(Path file)
void	setClosed(boolean closed)
void	setContentType(String contentType)
void	setEtag(String etag)
void	setOnClose(org.meeuw.functional.ThrowingRunnable<IOException> onClose)
void	setUrl(URI url)
@NonNull String	toString()
ImageStream	withMetaData(BackendImageMetadata<?> metaData)

Methods inherited from class java.lang.Object

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

Field Detail

stream

protected InputStream stream

length

protected final long length

lastModified

protected final Instant lastModified

contentType

protected String contentType

etag

protected String etag

url

protected URI url

onClose

protected org.meeuw.functional.ThrowingRunnable<IOException> onClose

closed

protected boolean closed

Constructor Detail

ImageStream

protected ImageStream(InputStream stream,
                      Instant lastModified)

ImageStream

public ImageStream(InputStream stream,
                   long length,
                   Instant lastModified)

ImageStream

protected ImageStream(@NonNull InputStream stream,
                      @Min(0L)
                      @javax.validation.constraints.Min(0L) long length,
                      @Nullable Instant lastModified,
                      @Nullable String contentType,
                      @Nullable String etag,
                      @Nullable URI url,
                      @Nullable org.meeuw.functional.ThrowingRunnable<IOException> onClose)

Method Detail

of

public static ImageStream of(InputStream stream,
                             Instant lastModified)

of

public static ImageStream of(InputStream stream)

of

public static ImageStream of(File file)
                      throws IOException

Throws:

IOException

of

public static ImageStream of(Path file)
                      throws IOException

Throws:

IOException

of

public static ImageStream of(URL url)
                      throws IOException

Throws:

IOException

of

public static ReusableImageStream of(byte[] bytes)
                              throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

getStream

public InputStream getStream()
                      throws IOException

Throws:

IOException - if the stream could not be produces because closed.

withMetaData

public ImageStream withMetaData(BackendImageMetadata<?> metaData)

imageStreamBuilder

public static @NonNull ImageStream.Builder imageStreamBuilder()

getLength

public long getLength()

getLastModified

public Instant getLastModified()

getContentType

public String getContentType()

getEtag

public String getEtag()

getUrl

public URI getUrl()

getOnClose

public org.meeuw.functional.ThrowingRunnable<IOException> getOnClose()

isClosed

public boolean isClosed()

setContentType

public void setContentType(String contentType)

setEtag

public void setEtag(String etag)

setUrl

public void setUrl(URI url)

setOnClose

public void setOnClose(org.meeuw.functional.ThrowingRunnable<IOException> onClose)

setClosed

public void setClosed(boolean closed)

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public @NonNull String toString()

Overrides:

toString in class Object