Class ImageWriterRegistry
java.lang.Object
org.apache.xmlgraphics.image.writer.ImageWriterRegistry
Registry for
ImageWriter
implementations.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Map
<String, List<ImageWriter>> private static ImageWriterRegistry
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.ImageWriterRegistry
(Properties preferredOrder) Special constructor. -
Method Summary
Modifier and TypeMethodDescriptionstatic ImageWriterRegistry
private int
getPriority
(ImageWriter writer) getWriterFor
(String mime) Returns an ImageWriter that can be used to encode an image to the requested MIME type.void
register
(ImageWriter writer) Registers a new ImageWriter implementation in the registry.void
register
(ImageWriter writer, int priority) Registers a new ImageWriter implementation with the associated priority in the registry.private void
setPreferredOrder
(Properties preferredOrder) private void
setup()
-
Field Details
-
instance
-
imageWriterMap
-
preferredOrder
-
-
Constructor Details
-
ImageWriterRegistry
public ImageWriterRegistry()Default constructor. The default preferred order for the image writers is loaded from the resources. -
ImageWriterRegistry
Special constructor. The preferred order for the image writers can be specified as a Map (for example a Properties file). The entries of the Map consists of fully qualified class or package names as keys and integer numbers as values. Zero (0) is the default priority.- Parameters:
preferredOrder
- the map of order properties used to order the plug-ins
-
-
Method Details
-
setPreferredOrder
-
getInstance
- Returns:
- a singleton instance of the ImageWriterRegistry.
-
setup
private void setup() -
getPriority
-
register
Registers a new ImageWriter implementation with the associated priority in the registry. Higher priorities get preference over lower priorities.- Parameters:
writer
- the ImageWriter instance to register.priority
- the priority of the writer in the registry.- See Also:
-
register
Registers a new ImageWriter implementation in the registry. If an ImageWriter for the same target MIME type has already been registered, it is placed in an array based on priority.- Parameters:
writer
- the ImageWriter instance to register.
-
getWriterFor
Returns an ImageWriter that can be used to encode an image to the requested MIME type.- Parameters:
mime
- the MIME type of the desired output format- Returns:
- a functional ImageWriter instance handling the desired output format or null if none can be found.
-