Wraps around another resource, delegates all queries (except * getSize) to that other resource but transforms stream content @@ -39,14 +39,14 @@ public abstract class ContentTransformingResource extends ResourceDecorator { private static final int BUFFER_SIZE = 8192; /** no arg constructor */ - public ContentTransformingResource() { + protected ContentTransformingResource() { } /** * Constructor with another resource to wrap. * @param other the resource to wrap. */ - public ContentTransformingResource(ResourceCollection other) { + protected ContentTransformingResource(ResourceCollection other) { super(other); } @@ -121,7 +121,7 @@ public abstract class ContentTransformingResource extends ResourceDecorator { if (a != null) { return new Appendable() { public OutputStream getAppendOutputStream() - throws IOException { + throws IOException { OutputStream out = a.getAppendOutputStream(); if (out != null) { out = wrapStream(out); @@ -139,7 +139,7 @@ public abstract class ContentTransformingResource extends ResourceDecorator { } /** - * whether the transformation performed allows appends. + * Learn whether the transformation performed allows appends. * *
In general compressed outputs will become invalid if they * are appended to, for example.
@@ -151,7 +151,7 @@ public abstract class ContentTransformingResource extends ResourceDecorator { } /** - * Is supposed to wrap the stream. + * Get a content-filtering/transforming InputStream. * * @param in InputStream to wrap, will never be null. * @return a compressed inputstream. @@ -161,7 +161,7 @@ public abstract class ContentTransformingResource extends ResourceDecorator { throws IOException; /** - * Is supposed to wrap the stream to allow transformation on the fly. + * Get a content-filtering/transforming OutputStream. * * @param out OutputStream to wrap, will never be null. * @return a compressed outputstream. diff --git a/src/main/org/apache/tools/ant/types/resources/JavaConstantResource.java b/src/main/org/apache/tools/ant/types/resources/JavaConstantResource.java index f8ff6e2a8..0ad14071e 100644 --- a/src/main/org/apache/tools/ant/types/resources/JavaConstantResource.java +++ b/src/main/org/apache/tools/ant/types/resources/JavaConstantResource.java @@ -25,8 +25,7 @@ import java.lang.reflect.Field; /** * A resource that is a java constant. * This lets you extract values off the classpath and use them elsewhere - * @since Ant1.7 - * + * @since Ant 1.7 */ public class JavaConstantResource extends AbstractClasspathResource { @@ -67,5 +66,4 @@ public class JavaConstantResource extends AbstractClasspathResource { } } - } diff --git a/src/main/org/apache/tools/ant/types/resources/MappedResource.java b/src/main/org/apache/tools/ant/types/resources/MappedResource.java index 215193dce..13d2c548f 100644 --- a/src/main/org/apache/tools/ant/types/resources/MappedResource.java +++ b/src/main/org/apache/tools/ant/types/resources/MappedResource.java @@ -35,6 +35,8 @@ public class MappedResource extends ResourceDecorator { /** * Wraps an existing resource. + * @param r Resource to wrap + * @param m FileNameMapper that handles mapping */ public MappedResource(Resource r, FileNameMapper m) { super(r); @@ -48,14 +50,14 @@ public class MappedResource extends ResourceDecorator { String name = getResource().getName(); if (isReference()) { return name; - } else { - String[] mapped = mapper.mapFileName(name); - return mapped != null && mapped.length > 0 ? mapped[0] : null; } + String[] mapped = mapper.mapFileName(name); + return mapped != null && mapped.length > 0 ? mapped[0] : null; } /** * Not really supported since mapper is never null. + * @param r reference to set */ public void setRefid(Reference r) { if (mapper != null) { @@ -66,10 +68,11 @@ public class MappedResource extends ResourceDecorator { /** * Suppress FileProvider + * @param clazz the type to implement */ public Object as(Class clazz) { return FileProvider.class.isAssignableFrom(clazz) - ? null : getResource().as(clazz); + ? null : getResource().as(clazz); } -} \ No newline at end of file +} diff --git a/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java b/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java index 583b6be42..6d551bff1 100644 --- a/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java +++ b/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java @@ -35,7 +35,7 @@ import org.apache.tools.ant.util.IdentityMapper; * @since Ant 1.8.0 */ public class MappedResourceCollection - extends DataType implements ResourceCollection, Cloneable { + extends DataType implements ResourceCollection, Cloneable { private ResourceCollection nested = null; private Mapper mapper = null; @@ -86,7 +86,7 @@ public class MappedResourceCollection } /** - * @return false + * {@inheritDoc} */ public boolean isFilesystemOnly() { if (isReference()) { @@ -98,7 +98,7 @@ public class MappedResourceCollection } /** - * @return size of the nested resource collection. + * {@inheritDoc} */ public int size() { if (isReference()) { @@ -108,6 +108,9 @@ public class MappedResourceCollection return nested.size(); } + /** + * {@inheritDoc} + */ public Iterator iterator() { if (isReference()) { return ((MappedResourceCollection) getCheckedRef()).iterator(); @@ -128,8 +131,7 @@ public class MappedResourceCollection } /** - * Implement clone. The nested resource collection and mapper are - * copied. + * Implement clone. The nested resource collection and mapper are copied. * @return a cloned instance. */ public Object clone() { @@ -204,4 +206,4 @@ public class MappedResourceCollection throw new UnsupportedOperationException(); } } -} \ No newline at end of file +}