MediaBean

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.emb
Class MediaBean

java.lang.Object
  javax.emb.MediaBean

All Implemented Interfaces:: Media (src) , java.io.Serializable

public class MediaBean
extends java.lang.Object
implements Media (src)

This class implements the Media interface and models media objects that are transient, immutable, and local. In order to avoid excessive memory use, a temporary file may be used to store and access the media content while an instance is alive.

See Also:: Serialized Form

Field Summary

Fields inherited from interface javax.emb.Media (src)

MIME_TYPE_UNKNOWN

Constructor Summary
`MediaBean(java.io.File mediaFile, java.lang.String mimeType)` This constructor wraps a new instance around the given media file.
`MediaBean(java.io.InputStream contentStream, java.lang.String mimeType, java.lang.String name)` This constructor initializes a new instance with content copied from the given content stream, and the given mime type and name.

Method Summary
`byte[]`	`getContent()` Returns the complete media content as a byte array.
`MediaFormat (src)`	`getFormat()` Queries a suitable media format instance from the MediaFormatRegistry singleton and returns it.
`MediaHeader (src)`	`getHeader()` Returns the receiver's header information.
`java.lang.String`	`getMimeType()` Returns a mime type for the receiver's content as a string.
`java.lang.String`	`getName()` Returns the receiver's non-unique name as a String.
`Media (src)`	`getProxy()` Returns a media object that can be used as a proxy for the receiver, e.g.
`long`	`getSize()` This operation returns the receiver's content size in number of bytes as a long value.
`int`	`readContent(long position, byte[] buffer)` Similarly to input streams, this method fills the given buffer with content read from the media object.
`int`	`readContent(long position, byte[] buffer, int offset, int length)` Similar to input streams, this method fills the given buffer with content read from the media object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaBean

public MediaBean(java.io.InputStream contentStream,
                 java.lang.String mimeType,
                 java.lang.String name)
          throws MediaException (src)

This constructor initializes a new instance with content copied from the given content stream, and the given mime type and name. The given name is a file name that should be associated with the object. If the given mimeType is null, one is chosen automatically by analyzing the given file extension, or Media.MIME_TYPE_UNKNOWN is assigned in case none can be derived.

This constructor is suitable for media content regardless of its size. Please note that the given input stream is closed once the content is read completely. Also note that a temporary file is used internally to maintain the content. The implementation tries to delete this file once the instance is garbage collected, and again once the process dies in case the former attempt fails.

Parameters:

contentStream - media content stream.

mimeType - media mime type.

name - media name.

Throws:

ContentAccessException (src) - if something goes wrong during content transfer.

java.lang.NullPointerException - if the given content stream or name is null.

MediaException (src)

MediaBean

public MediaBean(java.io.File mediaFile,
                 java.lang.String mimeType)
          throws MediaException (src)

This constructor wraps a new instance around the given media file. The name property of the receiver is initialized to the name of the given file (without path information). If the given mimeType is null, one is chosen automatically by analyzing the file extension, or Media.MIME_TYPE_UNKNOWN is assigned in case none can be derived. This constructor is useful to invoke a media related service on an existing media file without copying the content of the latter. Please note that the file is not deleted once an instance referencing it is garbage collected.
Parameters:: mediaFile - a file.; mimeType - the optional MIME type of the content.
Throws:: ContentAccessException (src) - if something goes wrong during content transfer, or if the given file is not present or cannot be accessed.; java.lang.NullPointerException - if the given media file is null.; MediaException (src)

Method Detail