Package com.storedobject.core

Interface HasStreamData

All Superinterfaces:

ContentType

All Known Implementing Classes:

AccountDocument, BusinessDocument, Document, FileData, MediaFile, MemoAttachment, PersonalDocument, StreamData, VirtualFileData

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HasStreamData
extends ContentType

The HasStreamData functional interface represents entities that provide access to an instance of StreamData. Implementing this interface allows classes to encapsulate functionality for retrieving stream data associated with them. This can be used in scenarios where the handling, processing, or transformation of stream-based data is needed.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default String	getContentType()
default String	getFileName()	Determines the file name based on the name provided by the implementing entity and the file extension associated with its StreamData.
default String	getName()	Retrieves the name associated with the implementing entity.
StreamData	getStreamData()	Retrieves an instance of StreamData.

Methods inherited from interface com.storedobject.core.ContentType

getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Method Details

getStreamData

StreamData getStreamData()

Retrieves an instance of StreamData.

Returns:

a StreamData object, representing the stream data associated with the implementing entity.

getContentType

default String getContentType()

Specified by:

getContentType in interface ContentType

getName

default String getName()

Retrieves the name associated with the implementing entity.

Returns:

a String representing the name, or null if no name is available.

getFileName

default String getFileName()

Determines the file name based on the name provided by the implementing entity and the file extension associated with its StreamData. If no name is available, a unique name is generated using UniqueLong.get() combined with the file extension.

Returns:

the generated or determined file name as a String. If the name is available and already ends with the correct file extension, it is returned as is; otherwise, the correct extension is appended to the name. If no name is available, a unique file name with the correct extension is returned.