TranscodingHints (Apache Batik Javadoc)

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
```
The TranscodingHints class defines a way to pass transcoding parameters or options to any transcoders.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TranscodingHints.Key
Defines the base type of all keys used to control various aspects of the transcoding operations.
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested Classes
Modifier and Type	Class and 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 and Description
`TranscodingHints()` Constructs a new empty `TranscodingHints`.
`TranscodingHints(java.util.Map init)` Constructs a new `TranscodingHints` with keys and values initialized from the specified Map object (which may be null).

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`containsKey(java.lang.Object key)` Returns `true` if this `TranscodingHints` 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 specified `key` to the specified `value` in this `TranscodingHints` object.
`void`	`putAll(java.util.Map m)` Copies all of the mappings from the specified `Map` to this `TranscodingHints`.
`void`	`putAll(TranscodingHints hints)` Copies all of the keys and corresponding values from the specified `TranscodingHints` object to this `TranscodingHints` object.
`java.lang.Object`	`remove(java.lang.Object key)` Removes the key and its corresponding value from this `TranscodingHints` object.

Methods inherited from class java.util.HashMap
clear, clone, containsValue, entrySet, isEmpty, keySet, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Constructor Detail
  - TranscodingHints
```
public TranscodingHints()
```
    Constructs a new empty TranscodingHints.
  - TranscodingHints
```
public TranscodingHints(java.util.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(java.lang.Object key)
```
    Returns true if this TranscodingHints contains a mapping for the specified key, false otherwise.
    
    Specified by:
    
    containsKey in interface java.util.Map
    
    Overrides:
    
    containsKey in class java.util.HashMap
    
    Parameters:
    key - key whose present in this TranscodingHints is to be tested.
    
    Throws:
    
    java.lang.ClassCastException - key is not of type TranscodingHints.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 interface java.util.Map
    
    Overrides:
    
    get in class java.util.HashMap
    
    Parameters:
    key - a trancoding hint key
    
    Throws:
    
    java.lang.ClassCastException - key is not of type TranscodingHints.Key
  - put
```
public java.lang.Object put(java.lang.Object key,
                   java.lang.Object value)
```
    Maps the specified key to the specified value in this TranscodingHints object.
    
    Specified by:
    
    put in interface java.util.Map
    
    Overrides:
    
    put in class java.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 type TranscodingHints.Key
  - remove
```
public java.lang.Object remove(java.lang.Object key)
```
    Removes the key and its corresponding value from this TranscodingHints object.
    
    Specified by:
    
    remove in interface java.util.Map
    
    Overrides:
    
    remove in class java.util.HashMap
    
    Parameters:
    key - the trancoding hints key that needs to be removed
    
    Throws:
    
    java.lang.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(java.util.Map m)
```
    Copies all of the mappings from the specified Map to this TranscodingHints.
    
    Specified by:
    
    putAll in interface java.util.Map
    
    Overrides:
    
    putAll in class java.util.HashMap
    
    Parameters:
    m - mappings to be stored in this TranscodingHints.
    
    Throws:
    
    java.lang.ClassCastException - key is not of type TranscodingHints.Key

Class TranscodingHints

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

TranscodingHints

TranscodingHints

Method Detail

containsKey

get

put

remove

putAll

putAll