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 classTranscodingHints.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
booleancontainsKey(Object key)
Returns true if this TranscodingHints contains a mapping for the specified key, false otherwise.
Objectget(Object key)
Returns the value to which the specified key is mapped.
Objectput(Object key, Object value)
Maps the specified key to the specified value in this TranscodingHints object.
voidputAll(TranscodingHints hints)
Copies all of the keys and corresponding values from the specified TranscodingHints object to this TranscodingHints object.
voidputAll(Map m)
Copies all of the mappings from the specified Map to this TranscodingHints.
Objectremove(Object key)
Removes the key and its corresponding value from this TranscodingHints object.

Constructor Detail

TranscodingHints

public TranscodingHints()
Constructs a new empty TranscodingHints.

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

Method Detail

containsKey

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

get

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

put

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

putAll

public void putAll(TranscodingHints hints)
Copies all of the keys and corresponding values from the specified TranscodingHints object to this TranscodingHints object.

putAll

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

remove

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

Copyright B) 2008 Apache Software Foundation. All Rights Reserved.