Package org.zkoss.util.media
Class RepeatableMedia
- java.lang.Object
-
- org.zkoss.util.media.RepeatableMedia
-
- All Implemented Interfaces:
java.io.Serializable,Media
public class RepeatableMedia extends java.lang.Object implements Media, java.io.Serializable
RepeatableMediaadds functionality to another media, the ability to read repeatedly. Unlike other media,RepeatableMediausesRepeatableInputStream, if binary, orRepeatableReaderto makegetStreamData()andgetReaderData()to be able to re-open whenInputStream.close()orReader.close()is called. In other words, the buffered input stream of the give media is never closed until it is GC-ed.- Since:
- 3.0.4
- Author:
- jumperchen, tomyeh
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]getByteData()Returns the raw data in byte array.java.lang.StringgetContentType()Returns the content type, e.g., "image/jpeg", or null if not available.java.lang.StringgetFormat()Returns the format name, e.g., "jpeg", or null if not available.static MediagetInstance(Media media)Returns a repeatable media with a repeatable input stream or reader, or null if the given media is null.java.lang.StringgetName()Returns the name (usually filename) of this media, or null if not available.java.io.ReadergetReaderData()Returns the raw data in Reader.java.io.InputStreamgetStreamData()Returns the repeatable input stream, if the original input stream is not null.java.lang.StringgetStringData()Returns the raw data in string.booleaninMemory()Returns whether the data is cached in memory (in form of byte[] or String).booleanisBinary()Returns whether the format of this content is binary or text-based.booleanisContentDisposition()Whether to allow Content-Disposition or not when writing the media to response header.
-
-
-
Method Detail
-
getInstance
public static Media getInstance(Media media)
Returns a repeatable media with a repeatable input stream or reader, or null if the given media is null.
-
getReaderData
public java.io.Reader getReaderData()
Description copied from interface:MediaReturns the raw data in Reader.Note: it wraps
Media.getStringData()with StringReader, if it is in memory (Media.inMemory()returns true).- Specified by:
getReaderDatain interfaceMedia- See Also:
Media.getReaderData()
-
getStreamData
public java.io.InputStream getStreamData()
Returns the repeatable input stream, if the original input stream is not null.- Specified by:
getStreamDatain interfaceMedia- See Also:
Media.getStreamData(),RepeatableInputStream.getInstance(InputStream)
-
getByteData
public byte[] getByteData()
Description copied from interface:MediaReturns the raw data in byte array.It might not be a copy, so don't modify it directly unless you know what you are doing.
If the data is not cached in memory (
Media.inMemory()return false), the data will be read fromMedia.getStreamData(). Furthermore, it also implies you can not invoke this method again.- Specified by:
getByteDatain interfaceMedia- See Also:
Media.getByteData()
-
getContentType
public java.lang.String getContentType()
Description copied from interface:MediaReturns the content type, e.g., "image/jpeg", or null if not available.- Specified by:
getContentTypein interfaceMedia- See Also:
Media.getContentType()
-
getFormat
public java.lang.String getFormat()
Description copied from interface:MediaReturns the format name, e.g., "jpeg", or null if not available.- Specified by:
getFormatin interfaceMedia- See Also:
Media.getFormat()
-
getName
public java.lang.String getName()
Description copied from interface:MediaReturns the name (usually filename) of this media, or null if not available.- Specified by:
getNamein interfaceMedia- See Also:
Media.getName()
-
getStringData
public java.lang.String getStringData()
Description copied from interface:MediaReturns the raw data in string.If the data is not cached in memory (
Media.inMemory()return false), the data will be read fromMedia.getReaderData(). Furthermore, it also implies you can not invoke this method again.- Specified by:
getStringDatain interfaceMedia- See Also:
Media.getStringData()
-
inMemory
public boolean inMemory()
Description copied from interface:MediaReturns whether the data is cached in memory (in form of byte[] or String).- Specified by:
inMemoryin interfaceMedia- See Also:
Media.inMemory()
-
isBinary
public boolean isBinary()
Description copied from interface:MediaReturns whether the format of this content is binary or text-based. If true, useMedia.getByteData()orMedia.getStreamData()to retrieve its content. If false, useMedia.getStringData()orMedia.getReaderData()to retrieve its content.- Specified by:
isBinaryin interfaceMedia- See Also:
Media.isBinary()
-
isContentDisposition
public boolean isContentDisposition()
Description copied from interface:MediaWhether to allow Content-Disposition or not when writing the media to response header.Default: true
- Specified by:
isContentDispositionin interfaceMedia- See Also:
Media.isContentDisposition()
-
-