com.vaadin.flow.server.communication.streaming

Class StreamingStartEventImpl

java.lang.Object

com.vaadin.flow.server.communication.streaming.StreamingStartEventImpl

All Implemented Interfaces:

StreamVariable.StreamingEvent, StreamVariable.StreamingStartEvent, Serializable

public final class StreamingStartEventImpl
extends Object
implements StreamVariable.StreamingStartEvent

Implementation for StreamVariable.StreamingStartEvent.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StreamingStartEventImpl(String filename, String type, long contentLength) Streaming start event constructor.

Method Summary

Modifier and Type	Method and Description
void	disposeStreamVariable() The owner of the StreamVariable can call this method to inform the implementation that this StreamVariable will not be used to accept more post.
long	getBytesReceived() Get the number of bytes streamed.
long	getContentLength() Get the content length.
String	getFileName() Get the file name for the stream.
String	getMimeType() Get the mime type for the stream.
boolean	isDisposed() Get if stream resource should be unregistered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.server.StreamVariable.StreamingEvent

getBytesReceived, getContentLength, getFileName, getMimeType

Constructor Detail

StreamingStartEventImpl

public StreamingStartEventImpl(String filename,
                               String type,
                               long contentLength)

Streaming start event constructor.

Parameters:

filename - filename

type - file type

contentLength - content length

Method Detail

disposeStreamVariable

public void disposeStreamVariable()

Description copied from interface: StreamVariable.StreamingStartEvent

The owner of the StreamVariable can call this method to inform the implementation that this StreamVariable will not be used to accept more post.

Specified by:

disposeStreamVariable in interface StreamVariable.StreamingStartEvent

isDisposed

public boolean isDisposed()

Get if stream resource should be unregistered.

Returns:

true if stream variable should be unregistered

getFileName

public final String getFileName()

Description copied from interface: StreamVariable.StreamingEvent

Get the file name for the stream.

Specified by:

getFileName in interface StreamVariable.StreamingEvent

Returns:

the file name of the streamed file if known

getMimeType

public final String getMimeType()

Description copied from interface: StreamVariable.StreamingEvent

Get the mime type for the stream.

Specified by:

getMimeType in interface StreamVariable.StreamingEvent

Returns:

the mime type of the streamed file if known

getContentLength

public final long getContentLength()

Description copied from interface: StreamVariable.StreamingEvent

Get the content length.

Specified by:

getContentLength in interface StreamVariable.StreamingEvent

Returns:

the length of the stream (in bytes) if known, else -1

getBytesReceived

public final long getBytesReceived()

Description copied from interface: StreamVariable.StreamingEvent

Get the number of bytes streamed.

Specified by:

getBytesReceived in interface StreamVariable.StreamingEvent

Returns:

then number of bytes streamed to StreamVariable