org.apache.batik.transcoder

Class TranscodingHints

public class TranscodingHints extends HashMap

The TranscodingHints class defines a way to pass transcoding parameters or options to any transcoders.

Nested Class Summary
abstract static class	TranscodingHints.Key Defines the base type of all keys used to control various aspects of the transcoding operations.

Constructor Summary
	TranscodingHints() Constructs a new empty `TranscodingHints`.
	TranscodingHints(Map init) Constructs a new `TranscodingHints` with keys and values initialized from the specified Map object (which may be null).

Method Summary
boolean	containsKey(Object key) Returns `true` if this `TranscodingHints` contains a mapping for the specified key, false otherwise.
Object	get(Object key) Returns the value to which the specified key is mapped.
Object	put(Object key, Object value) Maps the specified `key` to the specified `value` in this `TranscodingHints` object.
void	putAll(TranscodingHints hints) Copies all of the keys and corresponding values from the specified `TranscodingHints` object to this `TranscodingHints` object.
void	putAll(Map m) Copies all of the mappings from the specified `Map` to this `TranscodingHints`.
Object	remove(Object key) Removes the key and its corresponding value from this `TranscodingHints` object.

Constructor Detail

public TranscodingHints()

Constructs a new empty TranscodingHints.

public TranscodingHints(Map init)

Constructs a new TranscodingHints with keys and values initialized from the specified Map object (which may be null).

Parameters: init a map of key/value pairs to initialize the hints or null if the object should be empty

public boolean containsKey(Object key)

Returns true if this TranscodingHints contains a mapping for the specified key, false otherwise.

Parameters: key key whose present in this TranscodingHints is to be tested.

Throws: ClassCastException key is not of type TranscodingHints.Key

public Object get(Object key)

Returns the value to which the specified key is mapped.

Parameters: key a trancoding hint key

Throws: ClassCastException key is not of type TranscodingHints.Key

public Object put(Object key, Object value)

Maps the specified key to the specified value in this TranscodingHints object.

Parameters: key the trancoding hint key. value the trancoding hint value.

Throws: IllegalArgumentException value is not appropriate for the specified key. ClassCastException key is not of type TranscodingHints.Key

public void putAll(TranscodingHints hints)

Copies all of the keys and corresponding values from the specified TranscodingHints object to this TranscodingHints object.

public void putAll(Map m)

Copies all of the mappings from the specified Map to this TranscodingHints.

Parameters: m mappings to be stored in this TranscodingHints.

Throws: ClassCastException key is not of type TranscodingHints.Key

public Object remove(Object key)

Removes the key and its corresponding value from this TranscodingHints object.

Parameters: key the trancoding hints key that needs to be removed

Throws: ClassCastException key is not of type TranscodingHints.Key