aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/render/RendererContext.java
diff options
context:
space:
mode:
authorJeremias Maerki <jeremias@apache.org>2002-09-09 10:54:52 +0000
committerJeremias Maerki <jeremias@apache.org>2002-09-09 10:54:52 +0000
commitb219d015f27874d474a9b035c9beb4b78c03cfe2 (patch)
tree30604d4f85ed69be4c23da845f143984204f9363 /src/org/apache/fop/render/RendererContext.java
parentdd8891583eb347173ca359067098aafd2b7115f0 (diff)
downloadxmlgraphics-fop-b219d015f27874d474a9b035c9beb4b78c03cfe2.tar.gz
xmlgraphics-fop-b219d015f27874d474a9b035c9beb4b78c03cfe2.zip
Fixed checkstyle violations
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@195161 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/org/apache/fop/render/RendererContext.java')
-rw-r--r--src/org/apache/fop/render/RendererContext.java53
1 files changed, 44 insertions, 9 deletions
diff --git a/src/org/apache/fop/render/RendererContext.java b/src/org/apache/fop/render/RendererContext.java
index 911c9baab..52c242dd9 100644
--- a/src/org/apache/fop/render/RendererContext.java
+++ b/src/org/apache/fop/render/RendererContext.java
@@ -1,45 +1,80 @@
/*
* $Id$
- * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
+ * Copyright (C) 2001-2002 The Apache Software Foundation. All rights reserved.
* For details on use and redistribution please refer to the
* LICENSE file included with these sources.
*/
package org.apache.fop.render;
-import org.apache.fop.fo.FOUserAgent;
+//Java
+import java.util.Map;
-import java.util.HashMap;
+//FOP
+import org.apache.fop.fo.FOUserAgent;
/**
- * The Render Context for external handlers.
- * This provides a rendering context so that external handlers
- * can get information to be able to render to the render target.
+ * The Render Context for external handlers. This provides a rendering context
+ * so that external handlers can get information to be able to render to the
+ * render target.
*/
public class RendererContext {
- String mime;
- FOUserAgent userAgent;
- HashMap props = new HashMap();
+ private String mime;
+ private FOUserAgent userAgent;
+ private Map props = new java.util.HashMap();
+
+ /**
+ * Contructor for this class. It takes a MIME type as parameter.
+ *
+ * @param m The MIME type of the output that's generated.
+ */
public RendererContext(String m) {
mime = m;
}
+ /**
+ * Returns the MIME type associated with this RendererContext.
+ *
+ * @return The MIME type (ex. application/pdf)
+ */
public String getMimeType() {
return mime;
}
+ /**
+ * Sets the user agent.
+ *
+ * @param ua The user agent
+ */
public void setUserAgent(FOUserAgent ua) {
userAgent = ua;
}
+ /**
+ * Returns the user agent.
+ *
+ * @return The user agent
+ */
public FOUserAgent getUserAgent() {
return userAgent;
}
+ /**
+ * Sets a property on the RendererContext.
+ *
+ * @param name The key of the property
+ * @param val The value of the property
+ */
public void setProperty(String name, Object val) {
props.put(name, val);
}
+ /**
+ * Returns a property from the RendererContext.
+ *
+ * @param prop The key of the property to return.
+ * @return The requested value, <code>null</code> if it doesn't exist.
+ */
public Object getProperty(String prop) {
return props.get(prop);
}