net.bluemind.core.api

Interface Stream

All Known Implementing Classes:

LogStream, VertxStream.LocalPathStream, VertxStream.ReadStreamStream, VertxStreamConsumer, VertxStreamProducer

public interface Stream

Marker interface used to model binary streams

Method Summary

Modifier and Type	Method and Description
default java.util.Optional<java.lang.String>	charset() A non empty Optional will alter the Content-Type header when the Stream is sent over http
default java.util.Optional<java.lang.String>	fileName() A non empty Optional will add a content-disposition filename header when the Stream is sent over http.
default java.util.Optional<java.lang.String>	mime() A non empty Optional will alter the Content-Type header when the Stream is sent over http

Method Detail

charset

default java.util.Optional<java.lang.String> charset()

A non empty Optional will alter the Content-Type header when the Stream is sent over http

Returns:

an optional charset name (eg. UTF-8)

mime

default java.util.Optional<java.lang.String> mime()

A non empty Optional will alter the Content-Type header when the Stream is sent over http

Returns:

an optional mime type (eg. text/html)

fileName

default java.util.Optional<java.lang.String> fileName()

A non empty Optional will add a content-disposition filename header when the Stream is sent over http. Only ascii chars will be preserved when the filename is sent.

Returns:

an optional filename