RepeatableMedia (The ZKoss Common Library 9.6.5 API)

java.lang.Object
- org.zkoss.util.media.RepeatableMedia

All Implemented Interfaces:

Serializable, Media
```
public class RepeatableMedia
extends Object
implements Media, Serializable
```
RepeatableMedia adds functionality to another media, the ability to read repeatedly. Unlike other media, RepeatableMedia uses RepeatableInputStream, if binary, or RepeatableReader to make getStreamData() and getReaderData() to be able to re-open when InputStream.close() or Reader.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 and Description
`byte[]`	`getByteData()` Returns the raw data in byte array.
`String`	`getContentType()` Returns the content type, e.g., "image/jpeg", or null if not available.
`String`	`getFormat()` Returns the format name, e.g., "jpeg", or null if not available.
`static Media`	`getInstance(Media media)` Returns a repeatable media with a repeatable input stream or reader, or null if the given media is null.
`String`	`getName()` Returns the name (usually filename) of this media, or null if not available.
`Reader`	`getReaderData()` Returns the raw data in Reader.
`InputStream`	`getStreamData()` Returns the repeatable input stream, if the original input stream is not null.
`String`	`getStringData()` Returns the raw data in string.
`boolean`	`inMemory()` Returns whether the data is cached in memory (in form of byte[] or String).
`boolean`	`isBinary()` Returns whether the format of this content is binary or text-based.
`boolean`	`isContentDisposition()` Whether to allow Content-Disposition or not when writing the media to response header.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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 Reader getReaderData()
```
    Description copied from interface: Media
    
    Returns the raw data in Reader. The return object is implementation-specific, please check javadoc for its implementation class.
    
    Specified by:
    
    getReaderData in interface Media
    
    See Also:
    
    Media.getReaderData()
  - getStreamData
```
public InputStream getStreamData()
```
    Returns the repeatable input stream, if the original input stream is not null.
    
    Specified by:
    
    getStreamData in interface Media
    
    See Also:
    
    Media.getStreamData(), RepeatableInputStream.getInstance(InputStream)
  - getByteData
```
public byte[] getByteData()
```
    Description copied from interface: Media
    
    Returns 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 from Media.getStreamData(). Furthermore, it also implies you can not invoke this method again.
    
    Specified by:
    
    getByteData in interface Media
    
    See Also:
    
    Media.getByteData()
  - getContentType
```
public String getContentType()
```
    Description copied from interface: Media
    
    Returns the content type, e.g., "image/jpeg", or null if not available.
    
    Specified by:
    
    getContentType in interface Media
    
    See Also:
    
    Media.getContentType()
  - getFormat
```
public String getFormat()
```
    Description copied from interface: Media
    
    Returns the format name, e.g., "jpeg", or null if not available.
    
    Specified by:
    
    getFormat in interface Media
    
    See Also:
    
    Media.getFormat()
  - getName
```
public String getName()
```
    Description copied from interface: Media
    
    Returns the name (usually filename) of this media, or null if not available.
    
    Specified by:
    
    getName in interface Media
    
    See Also:
    
    Media.getName()
  - getStringData
```
public String getStringData()
```
    Description copied from interface: Media
    
    Returns the raw data in string.
    If the data is not cached in memory (Media.inMemory() return false), the data will be read from Media.getReaderData(). Furthermore, it also implies you can not invoke this method again.
    
    Specified by:
    
    getStringData in interface Media
    
    See Also:
    
    Media.getStringData()
  - inMemory
```
public boolean inMemory()
```
    Description copied from interface: Media
    
    Returns whether the data is cached in memory (in form of byte[] or String).
    
    Specified by:
    
    inMemory in interface Media
    
    See Also:
    
    Media.inMemory()
  - isBinary
```
public boolean isBinary()
```
    Description copied from interface: Media
    
    Returns whether the format of this content is binary or text-based. If true, use Media.getByteData() or Media.getStreamData() to retrieve its content. If false, use Media.getStringData() or Media.getReaderData() to retrieve its content.
    
    Specified by:
    
    isBinary in interface Media
    
    See Also:
    
    Media.isBinary()
  - isContentDisposition
```
public boolean isContentDisposition()
```
    Description copied from interface: Media
    
    Whether to allow Content-Disposition or not when writing the media to response header.
    Default: true
    
    Specified by:
    
    isContentDisposition in interface Media
    
    See Also:
    
    Media.isContentDisposition()

Class RepeatableMedia

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getReaderData

getStreamData

getByteData

getContentType

getFormat

getName

getStringData

inMemory

isBinary

isContentDisposition