From e17daf009f0f93dd1149dabdfb00b9c014805366 Mon Sep 17 00:00:00 2001 From: Mehdi Houshmand Date: Fri, 6 Jul 2012 14:27:58 +0000 Subject: [PATCH] Addressed some of the javadocs that were erroneous git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1358237 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/fop/afp/AFPResourceLevel.java | 7 +++---- .../org/apache/fop/afp/AFPResourceManager.java | 4 ++-- src/java/org/apache/fop/afp/AFPStreamer.java | 4 ++-- .../apache/fop/afp/util/AFPResourceAccessor.java | 16 +++++++++++----- .../org/apache/fop/apps/FopFactoryBuilder.java | 12 +++++------- .../org/apache/fop/cli/CommandLineOptions.java | 1 + 6 files changed, 24 insertions(+), 20 deletions(-) diff --git a/src/java/org/apache/fop/afp/AFPResourceLevel.java b/src/java/org/apache/fop/afp/AFPResourceLevel.java index 860ca3d26..d56763050 100644 --- a/src/java/org/apache/fop/afp/AFPResourceLevel.java +++ b/src/java/org/apache/fop/afp/AFPResourceLevel.java @@ -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; diff --git a/src/java/org/apache/fop/afp/AFPResourceManager.java b/src/java/org/apache/fop/afp/AFPResourceManager.java index dcc909067..2e5f78043 100644 --- a/src/java/org/apache/fop/afp/AFPResourceManager.java +++ b/src/java/org/apache/fop/afp/AFPResourceManager.java @@ -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) { diff --git a/src/java/org/apache/fop/afp/AFPStreamer.java b/src/java/org/apache/fop/afp/AFPStreamer.java index 072dc1796..fb2b282f6 100644 --- a/src/java/org/apache/fop/afp/AFPStreamer.java +++ b/src/java/org/apache/fop/afp/AFPStreamer.java @@ -99,9 +99,9 @@ public class AFPStreamer implements Streamable { } /** - * 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; diff --git a/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java b/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java index 02691527e..1663bbebe 100644 --- a/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java +++ b/src/java/org/apache/fop/afp/util/AFPResourceAccessor.java @@ -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)); } diff --git a/src/java/org/apache/fop/apps/FopFactoryBuilder.java b/src/java/org/apache/fop/apps/FopFactoryBuilder.java index d062b2f8a..cfc47496c 100644 --- a/src/java/org/apache/fop/apps/FopFactoryBuilder.java +++ b/src/java/org/apache/fop/apps/FopFactoryBuilder.java @@ -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 this */ - 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 this */ public FopFactoryBuilder setPreferRenderer(boolean preferRenderer) { diff --git a/src/java/org/apache/fop/cli/CommandLineOptions.java b/src/java/org/apache/fop/cli/CommandLineOptions.java index 313201abd..03a9cfa48 100644 --- a/src/java/org/apache/fop/cli/CommandLineOptions.java +++ b/src/java/org/apache/fop/cli/CommandLineOptions.java @@ -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; -- 2.39.5