Author: mehdi
Date: Fri Jul 6 14:27:58 2012
New Revision: 1358237
URL: http://svn.apache.org/viewvc?rev=1358237&view=rev
Log:
Addressed some of the javadocs that were erroneous
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceLevel.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceManager.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPStreamer.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FopFactoryBuilder.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/cli/CommandLineOptions.java
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceLevel.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceLevel.java?rev=1358237&r1=1358236&r2=1358237&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceLevel.java
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceLevel.java Fri
Jul 6 14:27:58 2012
@@ -66,9 +66,8 @@ public class AFPResourceLevel {
}
}
- /** the external resource group file path */
private URI extUri = null;
- private ResourceType resourceType;
+ private final ResourceType resourceType;
/**
* Sets the resource placement level within the AFP output
@@ -84,7 +83,7 @@ public class AFPResourceLevel {
/**
* Main constructor
*
- * @param level the resource level
+ * @param resourceType the resource type
*/
public AFPResourceLevel(ResourceType resourceType) {
this.resourceType = resourceType;
@@ -156,7 +155,7 @@ public class AFPResourceLevel {
/**
* Sets the URI of the external resource group.
*
- * @param filePath the URI of the external resource group
+ * @param uri the URI of the external resource group
*/
public void setExternalUri(URI uri) {
this.extUri = uri;
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceManager.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceManager.java?rev=1358237&r1=1358236&r2=1358237&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceManager.java
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPResourceManager.java
Fri Jul 6 14:27:58 2012
@@ -120,9 +120,9 @@ public class AFPResourceManager {
}
/**
- * Sets the default resource group file path
+ * Sets the default resource group URI.
*
- * @param filePath the default resource group file path
+ * @param uri the default resource group URI
*/
public void setDefaultResourceGroupUri(URI uri) {
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPStreamer.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPStreamer.java?rev=1358237&r1=1358236&r2=1358237&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPStreamer.java
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/AFPStreamer.java Fri Jul
6 14:27:58 2012
@@ -99,9 +99,9 @@ public class AFPStreamer implements Stre
}
/**
- * Sets the default resource group file path
+ * Sets the default resource group URI.
*
- * @param filePath the default resource group file path
+ * @param uri the default resource group URI
*/
public void setDefaultResourceGroupUri(URI uri) {
this.defaultResourceGroupUri = uri;
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java?rev=1358237&r1=1358236&r2=1358237&view=diff
==============================================================================
---
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java
(original)
+++
xmlgraphics/fop/trunk/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java
Fri Jul 6 14:27:58 2012
@@ -37,10 +37,10 @@ public final class AFPResourceAccessor {
/**
* Constructor for resource to be accessed via the {@link
org.apache.fop.apps.FOUserAgent}. This
* contructor takes a base URI for resolving font resource URIs. So, if
fonts need to be
- * accessed, you can set the {@link FontManager}'s base URI instead of the
one on the
- * {@link org.apache.fop.apps.FopFactory}.
+ * accessed, you can set the {@link org.apache.fop.fonts.FontManager}'s
base URI instead of the
+ * one on the {@link org.apache.fop.apps.FopFactory}.
*
- * @param InternalResourceResolver resource resolver
+ * @param resourceResolver the resolver of resources
* @param baseURI the custom base URI to resolve relative URIs against
(may be null)
*/
public AFPResourceAccessor(InternalResourceResolver resourceResolver,
String baseURI) {
@@ -51,7 +51,7 @@ public final class AFPResourceAccessor {
/**
* Constructor for resource to be accessed via the {@link
org.apache.fop.apps.FOUserAgent}.
*
- * @param InternalResourceResolver resource resolver
+ * @param resourceResolver the resolver of resources
*/
public AFPResourceAccessor(InternalResourceResolver resourceResolver) {
this(resourceResolver, null);
@@ -69,7 +69,13 @@ public final class AFPResourceAccessor {
}
}
- /** {@inheritDoc} */
+ /**
+ * Creates an {@link InputStream} given a URI.
+ *
+ * @param uri the URI of the InputStream
+ * @return an InputStream
+ * @throws IOException if an I/O error occurs while creating the
InputStream.
+ */
public InputStream createInputStream(URI uri) throws IOException {
return resourceResolver.getResource(getResourceURI(uri));
}
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FopFactoryBuilder.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FopFactoryBuilder.java?rev=1358237&r1=1358236&r2=1358237&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FopFactoryBuilder.java
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/apps/FopFactoryBuilder.java
Fri Jul 6 14:27:58 2012
@@ -61,7 +61,7 @@ public final class FopFactoryBuilder {
/**
* A builder class for {@link FopFactory} which can be used for setting
configuration. This is
* a helper constructor that uses the default URI resolver implementation
that FOP packages
- * provide ({@link DefaultResourceResolver}).
+ * provide ({@link
org.apache.fop.apps.io.ResourceResolverFactory.DefaultResourceResolver}).
*
* @param defaultBaseURI the default base URI for resolving URIs against
*/
@@ -161,13 +161,12 @@ public final class FopFactoryBuilder {
/**
* Sets the {@link LayoutManagerMaker} so that users can configure how FOP
creates
- * {@link LayoutManager}s.
+ * {@link org.apache.fop.layoutmgr.LayoutManager}s.
*
* @param lmMaker he layout manager maker
* @return <code>this</code>
*/
- public FopFactoryBuilder setLayoutManagerMakerOverride(
- LayoutManagerMaker lmMaker) {
+ public FopFactoryBuilder setLayoutManagerMakerOverride(LayoutManagerMaker
lmMaker) {
fopFactoryConfigBuilder.setLayoutManagerMakerOverride(lmMaker);
return this;
}
@@ -296,11 +295,10 @@ public final class FopFactoryBuilder {
}
/**
- * Sets whether to chose a {@link Renderer} in preference to an
+ * Sets whether to chose a {@link org.apache.fop.render.Renderer} in
preference to an
* {@link org.apache.fop.render.intermediate.IFDocumentHandler}.
*
- * @see {@link RendererFactory}
- * @param preferRenderer true to prefer {@link Renderer}
+ * @param preferRenderer true to prefer {@link
org.apache.fop.render.Renderer}
* @return <code>this</code>
*/
public FopFactoryBuilder setPreferRenderer(boolean preferRenderer) {
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/cli/CommandLineOptions.java
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/cli/CommandLineOptions.java?rev=1358237&r1=1358236&r2=1358237&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/cli/CommandLineOptions.java
(original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/cli/CommandLineOptions.java
Fri Jul 6 14:27:58 2012
@@ -730,6 +730,7 @@ public class CommandLineOptions {
this.useStdIn = true;
} else {
fofile = new File(filename);
+ baseURI = fofile.toURI();
}
} else if (outputmode == null) {
outputmode = MimeConstants.MIME_PDF;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
