aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/RendererConfig.java
diff options
context:
space:
mode:
authorMehdi Houshmand <mehdi@apache.org>2012-06-20 13:51:14 +0000
committerMehdi Houshmand <mehdi@apache.org>2012-06-20 13:51:14 +0000
commitc36ffee9dfbf111899bbca5f994e334ca6b95011 (patch)
tree70107daa49cea97a4456a32087d0703baf84eed8 /src/java/org/apache/fop/render/RendererConfig.java
parentd32664f71c991d0d9fd4445d3fc1b5e83bb0a963 (diff)
downloadxmlgraphics-fop-c36ffee9dfbf111899bbca5f994e334ca6b95011.tar.gz
xmlgraphics-fop-c36ffee9dfbf111899bbca5f994e334ca6b95011.zip
Added tests and cleaning up of code
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/Temp_URI_Unification@1352101 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/java/org/apache/fop/render/RendererConfig.java')
-rw-r--r--src/java/org/apache/fop/render/RendererConfig.java26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/java/org/apache/fop/render/RendererConfig.java b/src/java/org/apache/fop/render/RendererConfig.java
index 832f5e83f..4b3b63a51 100644
--- a/src/java/org/apache/fop/render/RendererConfig.java
+++ b/src/java/org/apache/fop/render/RendererConfig.java
@@ -25,14 +25,40 @@ import org.apache.fop.apps.FOPException;
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.fonts.FontConfig;
+/**
+ * Implementations of this interface have all the renderer-specific configuration data found in the
+ * FOP-conf. This object is just a data object that is created by the {@link RendererConfigParser}
+ * when the FOP conf is parsed.
+ */
public interface RendererConfig {
+ /**
+ * Returns the render-specific font configuration information.
+ * @return the font config
+ */
FontConfig getFontInfoConfig();
+ /**
+ * Implementations of this interface parse the relevant renderer-specific configuration data
+ * within the FOP-conf and create a {@link RendererConfig}.
+ */
public interface RendererConfigParser {
+ /**
+ * Builds the object that contains the renderer configuration data.
+ *
+ * @param userAgent the user agent
+ * @param rendererConfiguration the Avalon config object for parsing the data
+ * @return the configuration data object
+ * @throws FOPException if an error occurs while parsing the fop conf
+ */
RendererConfig build(FOUserAgent userAgent, Configuration rendererConfiguration) throws FOPException;
+ /**
+ * The MIME type of the renderer.
+ *
+ * @return the mime type
+ */
String getMimeType();
}
}