true if the specified value is compatible with
* this key, and false otherwise.
*
* @param value the value (null permitted).
*
* @return A boolean.
*/
public abstract boolean isCompatibleValue(Object value);
/**
* Returns the private key for this instance.
*
* @return The private key.
*/
protected final int intKey()
{
return key;
}
/**
* Returns a hash code for the key.
*
* @return A hash code.
*/
public final int hashCode()
{
return System.identityHashCode(this);
}
/**
* Checks this key for equality with an arbitrary object.
*
* @param other the object (null permitted)
*
* @return A boolean.
*/
public final boolean equals(Object other)
{
return this == other;
}
} // class Key
private static final class KeyImpl extends Key
{
final String description;
final Object v1;
final Object v2;
final Object v3;
KeyImpl(int privateKey, String description,
Object v1, Object v2, Object v3)
{
super(privateKey);
this.description = description;
this.v1 = v1;
this.v2 = v2;
this.v3 = v3;
}
/**
* Returns true if the specified value is compatible with
* this key, and false otherwise.
*
* @param value the value (null permitted).
*
* @return A boolean.
*/
public boolean isCompatibleValue(Object value)
{
return value == v1 || value == v2 || value == v3;
}
/**
* Returns a string representation of the key.
*
* @return A string.
*/
public String toString()
{
return description;
}
} // class KeyImpl
private HashMap hintMap = new HashMap();
/**
* A key for the 'antialiasing' hint. Permitted values are:
* *
| {@link #VALUE_ANTIALIAS_OFF} | *Render without antialiasing (better speed). | *
| {@link #VALUE_ANTIALIAS_ON} | *Render with antialiasing (better quality). | *
| {@link #VALUE_ANTIALIAS_DEFAULT} | *Use the default value for antialiasing. | *
*
| {@link #VALUE_RENDER_SPEED} | *Prefer speed over quality when rendering. | *
| {@link #VALUE_RENDER_QUALITY} | *Prefer quality over speed when rendering. | *
| {@link #VALUE_RENDER_DEFAULT} | *Use the default value for quality vs. speed when rendering. | *
*
| {@link #VALUE_DITHER_DISABLE} | *Disable dithering. | *
| {@link #VALUE_DITHER_ENABLE} | *Enable dithering. | *
| {@link #VALUE_DITHER_DEFAULT} | *Use the default value for dithering. | *
*
| {@link #VALUE_TEXT_ANTIALIAS_ON} | *Render text with antialiasing (better quality usually). | *
| {@link #VALUE_TEXT_ANTIALIAS_OFF} | *Render test without antialiasing (better speed). | *
| {@link #VALUE_TEXT_ANTIALIAS_DEFAULT} | *Use the default value for text antialiasing. | *
*
| {@link #VALUE_FRACTIONALMETRICS_OFF} | *Render text with fractional metrics off. | *
| {@link #VALUE_FRACTIONALMETRICS_ON} | *Render text with fractional metrics on. | *
| {@link #VALUE_FRACTIONALMETRICS_DEFAULT} | *Use the default value for fractional metrics. | *
*
| {@link #VALUE_INTERPOLATION_NEAREST_NEIGHBOR} | *Use nearest neighbour interpolation. | *
| {@link #VALUE_INTERPOLATION_BILINEAR} | *Use bilinear interpolation. | *
| {@link #VALUE_INTERPOLATION_BICUBIC} | *Use bicubic interpolation. | *
*
| {@link #VALUE_ALPHA_INTERPOLATION_SPEED} | *Prefer speed over quality. | *
| {@link #VALUE_ALPHA_INTERPOLATION_QUALITY} | *Prefer quality over speed. | *
| {@link #VALUE_ALPHA_INTERPOLATION_DEFAULT} | *Use the default setting. | *
*
| {@link #VALUE_COLOR_RENDER_SPEED} | *Prefer speed over quality. | *
| {@link #VALUE_COLOR_RENDER_QUALITY} | *Prefer quality over speed. | *
| {@link #VALUE_COLOR_RENDER_DEFAULT} | *Use the default setting. | *
*
| {@link #VALUE_STROKE_DEFAULT} | *Use the default setting. | *
| {@link #VALUE_STROKE_NORMALIZE} | *XXX | *
| {@link #VALUE_STROKE_PURE} | *XXX | *
null
* permitted).
*/
public RenderingHints(Map init)
{
if (init != null)
putAll(init);
}
/**
* Creates a new collection containing a single (key, value) pair.
*
* @param key the key.
* @param value the value.
*/
public RenderingHints(Key key, Object value)
{
put(key, value);
}
/**
* Returns the number of hints in the collection.
*
* @return The number of hints.
*/
public int size()
{
return hintMap.size();
}
/**
* Returns true if there are no hints in the collection,
* and false otherwise.
*
* @return A boolean.
*/
public boolean isEmpty()
{
return hintMap.isEmpty();
}
/**
* Returns true if the collection of hints contains the
* specified key, and false otherwise.
*
* @param key the key (null not permitted).
*
* @return A boolean.
*
* @throws NullPointerException if key is null.
* @throws ClassCastException if key is not a {@link Key}.
*/
public boolean containsKey(Object key)
{
if (key == null)
throw new NullPointerException();
// don't remove the cast, it is necessary to throw the required exception
return hintMap.containsKey((Key) key);
}
/**
* Returns true if the collection of hints contains the
* specified value, and false otherwise.
*
* @param value the value.
*
* @return A boolean.
*/
public boolean containsValue(Object value)
{
return hintMap.containsValue(value);
}
/**
* Returns the value associated with the specified key, or null
* if there is no value defined for the key.
*
* @param key the key (null permitted).
*
* @return The value (possibly null).
*
* @throws ClassCastException if key is not a {@link Key}.
*
* @see #containsKey(Object)
*/
public Object get(Object key)
{
// don't remove the cast, it is necessary to throw the required exception
return hintMap.get((Key) key);
}
/**
* Adds a (key, value) pair to the collection of hints (if the
* collection already contains the specified key, then the
* value is updated).
*
* @param key the key.
* @param value the value.
*
* @return the previous value of the key or null if the key
* didn't have a value yet.
*/
public Object put(Object key, Object value)
{
if (key == null || value == null)
throw new NullPointerException();
if (! ((Key) key).isCompatibleValue(value))
throw new IllegalArgumentException();
return hintMap.put(key, value);
}
/**
* Adds all the hints from a collection to this collection.
*
* @param hints the hint collection.
*/
public void add(RenderingHints hints)
{
hintMap.putAll(hints);
}
/**
* Clears all the hints from this collection.
*/
public void clear()
{
hintMap.clear();
}
/**
* Removes a hint from the collection.
*
* @param key the key.
*
* @return The value that was associated with the key, or null if
* the key was not part of the collection
*
* @throws ClassCastException if the key is not a subclass of
* {@link RenderingHints.Key}.
*/
public Object remove(Object key)
{
// don't remove the (Key) cast, it is necessary to throw the exception
// required by the spec
return hintMap.remove((Key) key);
}
/**
* Adds a collection of (key, value) pairs to the collection.
*
* @param m a map containing (key, value) items.
*
* @throws ClassCastException if the map contains a key that is not
* a subclass of {@link RenderingHints.Key}.
* @throws IllegalArgumentException if the map contains a value that is
* not compatible with its key.
*/
public void putAll(Map m)
{
// preprocess map to generate appropriate exceptions
Iterator iterator = m.keySet().iterator();
while (iterator.hasNext())
{
Key key = (Key) iterator.next();
if (!key.isCompatibleValue(m.get(key)))
throw new IllegalArgumentException();
}
// map is OK, update
hintMap.putAll(m);
}
/**
* Returns a set containing the keys from this collection.
*
* @return A set of keys.
*/
public Set keySet()
{
return hintMap.keySet();
}
/**
* Returns a collection of the values from this hint collection. The
* collection is backed by the RenderingHints instance,
* so updates to one will affect the other.
*
* @return A collection of values.
*/
public Collection values()
{
return hintMap.values();
}
/**
* Returns a set of entries from the collection.
*
* @return A set of entries.
*/
public Set entrySet()
{
return Collections.unmodifiableSet(hintMap.entrySet());
}
/**
* Checks this collection for equality with an arbitrary object.
*
* @param o the object (null permitted)
*
* @return A boolean.
*/
public boolean equals(Object o)
{
return hintMap.equals(o);
}
/**
* Returns a hash code for the collection of hints.
*
* @return A hash code.
*/
public int hashCode()
{
return hintMap.hashCode();
}
/**
* Creates a clone of this instance.
*
* @return A clone.
*/
public Object clone()
{
try
{
RenderingHints copy = (RenderingHints) super.clone();
copy.hintMap = (HashMap) hintMap.clone();
return copy;
}
catch (CloneNotSupportedException e)
{
throw (Error) new InternalError().initCause(e); // Impossible
}
}
/**
* Returns a string representation of this instance.
*
* @return A string.
*/
public String toString()
{
return hintMap.toString();
}
} // class RenderingHints