Package org.apache.batik.transcoder
Class TranscodingHints
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap
-
- org.apache.batik.transcoder.TranscodingHints
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.util.Map
public class TranscodingHints extends java.util.HashMap
TheTranscodingHints
class defines a way to pass transcoding parameters or options to any transcoders.- Version:
- $Id: TranscodingHints.java 1805150 2017-08-16 08:29:12Z ssteiner $
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TranscodingHints.Key
Defines the base type of all keys used to control various aspects of the transcoding operations.
-
Constructor Summary
Constructors Constructor Description TranscodingHints()
Constructs a new emptyTranscodingHints
.TranscodingHints(java.util.Map init)
Constructs a newTranscodingHints
with keys and values initialized from the specified Map object (which may be null).
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsKey(java.lang.Object key)
Returnstrue
if thisTranscodingHints
contains a mapping for the specified key, false otherwise.java.lang.Object
get(java.lang.Object key)
Returns the value to which the specified key is mapped.java.lang.Object
put(java.lang.Object key, java.lang.Object value)
Maps the specifiedkey
to the specifiedvalue
in thisTranscodingHints
object.void
putAll(java.util.Map m)
Copies all of the mappings from the specifiedMap
to thisTranscodingHints
.void
putAll(TranscodingHints hints)
Copies all of the keys and corresponding values from the specifiedTranscodingHints
object to thisTranscodingHints
object.java.lang.Object
remove(java.lang.Object key)
Removes the key and its corresponding value from thisTranscodingHints
object.-
Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values
-
-
-
-
Constructor Detail
-
TranscodingHints
public TranscodingHints()
Constructs a new emptyTranscodingHints
.
-
TranscodingHints
public TranscodingHints(java.util.Map init)
Constructs a newTranscodingHints
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(java.lang.Object key)
Returnstrue
if thisTranscodingHints
contains a mapping for the specified key, false otherwise.- Specified by:
containsKey
in interfacejava.util.Map
- Overrides:
containsKey
in classjava.util.HashMap
- Parameters:
key
- key whose present in thisTranscodingHints
is to be tested.- Throws:
java.lang.ClassCastException
- key is not of typeTranscodingHints.Key
-
get
public java.lang.Object get(java.lang.Object key)
Returns the value to which the specified key is mapped.- Specified by:
get
in interfacejava.util.Map
- Overrides:
get
in classjava.util.HashMap
- Parameters:
key
- a trancoding hint key- Throws:
java.lang.ClassCastException
- key is not of typeTranscodingHints.Key
-
put
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
Maps the specifiedkey
to the specifiedvalue
in thisTranscodingHints
object.- Specified by:
put
in interfacejava.util.Map
- Overrides:
put
in classjava.util.HashMap
- Parameters:
key
- the trancoding hint key.value
- the trancoding hint value.- Throws:
java.lang.IllegalArgumentException
- value is not appropriate for the specified key.java.lang.ClassCastException
- key is not of typeTranscodingHints.Key
-
remove
public java.lang.Object remove(java.lang.Object key)
Removes the key and its corresponding value from thisTranscodingHints
object.- Specified by:
remove
in interfacejava.util.Map
- Overrides:
remove
in classjava.util.HashMap
- Parameters:
key
- the trancoding hints key that needs to be removed- Throws:
java.lang.ClassCastException
- key is not of typeTranscodingHints.Key
-
putAll
public void putAll(TranscodingHints hints)
Copies all of the keys and corresponding values from the specifiedTranscodingHints
object to thisTranscodingHints
object.
-
putAll
public void putAll(java.util.Map m)
Copies all of the mappings from the specifiedMap
to thisTranscodingHints
.- Specified by:
putAll
in interfacejava.util.Map
- Overrides:
putAll
in classjava.util.HashMap
- Parameters:
m
- mappings to be stored in thisTranscodingHints
.- Throws:
java.lang.ClassCastException
- key is not of typeTranscodingHints.Key
-
-