|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.media.jai.tilecodec.TileEncoderImpl
A partial implementation of the TileEncoder
interface
useful for subclassing.
Field Summary | |
protected String |
formatName
The name of the format. |
protected OutputStream |
outputStream
The OutputStream to write the encoded data to. |
protected TileCodecParameterList |
paramList
The TileCodecParameterList object containing the
encoding parameters. |
Constructor Summary | |
TileEncoderImpl(String formatName,
OutputStream output,
TileCodecParameterList param)
Constructs an TileEncoderImpl . |
Method Summary | |
TileCodecParameterList |
getEncodeParameterList()
Returns the current parameters as an instance of the TileCodecParameterList interface. |
String |
getFormatName()
Returns the format name of the encoding scheme. |
OutputStream |
getOutputStream()
Returns the OutputStream to which the encoded data will
be written. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.media.jai.tilecodec.TileEncoder |
encode |
Field Detail |
protected String formatName
protected OutputStream outputStream
OutputStream
to write the encoded data to.
protected TileCodecParameterList paramList
TileCodecParameterList
object containing the
encoding parameters.
Constructor Detail |
public TileEncoderImpl(String formatName, OutputStream output, TileCodecParameterList param)
TileEncoderImpl
. An
IllegalArgumentException
will be thrown if
param
's getParameterListDescriptor()
method
does not return the same descriptor as that from the associated
TileCodecDescriptor
's
getParameterListDescriptor
method for the "tileEncoder"
registry mode.
If param is null, then the default parameter list for encoding
as defined by the associated TileCodecDescriptor
's
getDefaultParameters()
method will be used for encoding.
If this too is null, an IllegalArgumentException
will
be thrown if the ParameterListDescriptor
associated
with the associated TileCodecDescriptor
for the
"tileEncoder" registry mode, reports that the number of parameters
for this format is non-zero.
formatName
- The name of the format.output
- The OutputStream
to write encoded data to.param
- The object containing the tile encoding parameters.
IllegalArgumentException
- if formatName is null.
IllegalArgumentException
- if output is null.
IllegalArgumentException
- if param's getFormatName() method does
not return the same formatName as the one specified to this method.
IllegalArgumentException
- if the ParameterListDescriptors
associated with the param and the associated TileCodecDescriptor are
not equal.
IllegalArgumentException
- if param does not have "tileEncoder"
as one of the valid modes that it supports.Method Detail |
public String getFormatName()
getFormatName
in interface TileEncoder
public TileCodecParameterList getEncodeParameterList()
TileCodecParameterList
interface.
getEncodeParameterList
in interface TileEncoder
public OutputStream getOutputStream()
OutputStream
to which the encoded data will
be written.
getOutputStream
in interface TileEncoder
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |