You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2023/06/28 07:35:46 UTC
[camel] branch camel-3.21.x updated: CAMEL-19512: Add javadoc to StreamCache useage
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch camel-3.21.x
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/camel-3.21.x by this push:
new 2dd608be6d3 CAMEL-19512: Add javadoc to StreamCache useage
2dd608be6d3 is described below
commit 2dd608be6d30b07e0b462c683e5ebb2d8f089a9c
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Jun 28 09:35:04 2023 +0200
CAMEL-19512: Add javadoc to StreamCache useage
---
.../apache/camel/component/cxf/converter/CachedCxfPayload.java | 8 ++++++++
.../camel/component/netty/http/NettyChannelBufferStreamCache.java | 5 +++++
core/camel-api/src/main/java/org/apache/camel/StreamCache.java | 5 +++++
.../apache/camel/converter/stream/ByteArrayInputStreamCache.java | 7 ++++++-
.../org/apache/camel/converter/stream/FileInputStreamCache.java | 7 ++++++-
.../java/org/apache/camel/converter/stream/InputStreamCache.java | 2 ++
.../main/java/org/apache/camel/converter/stream/ReaderCache.java | 7 ++++++-
.../src/main/java/org/apache/camel/util/xml/SourceCache.java | 7 ++++++-
.../main/java/org/apache/camel/util/xml/StreamSourceCache.java | 7 ++++++-
9 files changed, 50 insertions(+), 5 deletions(-)
diff --git a/components/camel-cxf/camel-cxf-common/src/main/java/org/apache/camel/component/cxf/converter/CachedCxfPayload.java b/components/camel-cxf/camel-cxf-common/src/main/java/org/apache/camel/component/cxf/converter/CachedCxfPayload.java
index bfb17f949e5..9d56b3b8c67 100644
--- a/components/camel-cxf/camel-cxf-common/src/main/java/org/apache/camel/component/cxf/converter/CachedCxfPayload.java
+++ b/components/camel-cxf/camel-cxf-common/src/main/java/org/apache/camel/component/cxf/converter/CachedCxfPayload.java
@@ -46,6 +46,14 @@ import org.apache.cxf.staxutils.StaxUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * {@link org.apache.camel.StreamCache} implementation for CXF payload.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
+ */
public class CachedCxfPayload<T> extends CxfPayload<T> implements StreamCache {
private static final Logger LOG = LoggerFactory.getLogger(CachedCxfPayload.class);
private static String defaultCharset = ObjectHelper.getSystemProperty("org.apache.camel.default.charset", "UTF-8");
diff --git a/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyChannelBufferStreamCache.java b/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyChannelBufferStreamCache.java
index 8bf712a04f7..430a7f58ef9 100644
--- a/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyChannelBufferStreamCache.java
+++ b/components/camel-netty-http/src/main/java/org/apache/camel/component/netty/http/NettyChannelBufferStreamCache.java
@@ -29,6 +29,11 @@ import org.apache.camel.util.IOHelper;
* A {@link ByteBuf} which is exposed as an {@link InputStream} which makes it very easy to use by Camel and other Camel
* components. Also supported is {@link StreamCache} which allows the data to be re-read for example when doing content
* based routing with XPath.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public final class NettyChannelBufferStreamCache extends InputStream implements StreamCache {
diff --git a/core/camel-api/src/main/java/org/apache/camel/StreamCache.java b/core/camel-api/src/main/java/org/apache/camel/StreamCache.java
index 622c9bc6e86..bdcec5cc3ca 100644
--- a/core/camel-api/src/main/java/org/apache/camel/StreamCache.java
+++ b/core/camel-api/src/main/java/org/apache/camel/StreamCache.java
@@ -30,6 +30,11 @@ import java.io.OutputStream;
* <p/>
* It is recommended in the {@link #copy(Exchange)} method to let the copied stream start from the start. If the
* implementation does not support copy, then return <tt>null</tt>.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public interface StreamCache {
diff --git a/core/camel-support/src/main/java/org/apache/camel/converter/stream/ByteArrayInputStreamCache.java b/core/camel-support/src/main/java/org/apache/camel/converter/stream/ByteArrayInputStreamCache.java
index 664793c4fa6..fc9932a549f 100644
--- a/core/camel-support/src/main/java/org/apache/camel/converter/stream/ByteArrayInputStreamCache.java
+++ b/core/camel-support/src/main/java/org/apache/camel/converter/stream/ByteArrayInputStreamCache.java
@@ -27,7 +27,12 @@ import org.apache.camel.StreamCache;
import org.apache.camel.util.IOHelper;
/**
- * A {@link StreamCache} for {@link java.io.ByteArrayInputStream}
+ * A {@link StreamCache} for {@link java.io.ByteArrayInputStream}.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public class ByteArrayInputStreamCache extends FilterInputStream implements StreamCache {
diff --git a/core/camel-support/src/main/java/org/apache/camel/converter/stream/FileInputStreamCache.java b/core/camel-support/src/main/java/org/apache/camel/converter/stream/FileInputStreamCache.java
index 53405146ba9..1c06c700e49 100644
--- a/core/camel-support/src/main/java/org/apache/camel/converter/stream/FileInputStreamCache.java
+++ b/core/camel-support/src/main/java/org/apache/camel/converter/stream/FileInputStreamCache.java
@@ -49,7 +49,12 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * A {@link StreamCache} for {@link File}s
+ * A {@link StreamCache} for {@link File}s.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public final class FileInputStreamCache extends InputStream implements StreamCache {
private InputStream stream;
diff --git a/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java b/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java
index 2413809745c..35650b269a3 100644
--- a/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java
+++ b/core/camel-support/src/main/java/org/apache/camel/converter/stream/InputStreamCache.java
@@ -25,6 +25,8 @@ import org.apache.camel.StreamCache;
/**
* A {@link StreamCache} for caching using an in-memory byte array.
+ *
+ * @see StreamCache
*/
public final class InputStreamCache extends ByteArrayInputStream implements StreamCache {
diff --git a/core/camel-support/src/main/java/org/apache/camel/converter/stream/ReaderCache.java b/core/camel-support/src/main/java/org/apache/camel/converter/stream/ReaderCache.java
index 70e5dd618e4..877efbe150c 100644
--- a/core/camel-support/src/main/java/org/apache/camel/converter/stream/ReaderCache.java
+++ b/core/camel-support/src/main/java/org/apache/camel/converter/stream/ReaderCache.java
@@ -24,7 +24,12 @@ import org.apache.camel.Exchange;
import org.apache.camel.StreamCache;
/**
- * A {@link org.apache.camel.StreamCache} for String {@link java.io.Reader}s
+ * A {@link org.apache.camel.StreamCache} for String {@link java.io.Reader}s.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public class ReaderCache extends StringReader implements StreamCache {
diff --git a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java
index 4dc9b0f6d3e..7d58c7aab6a 100644
--- a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java
+++ b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/SourceCache.java
@@ -24,7 +24,12 @@ import org.apache.camel.StreamCache;
import org.apache.camel.util.IOHelper;
/**
- * {@link org.apache.camel.StreamCache} implementation for {@link StringSource}s
+ * {@link org.apache.camel.StreamCache} implementation for {@link StringSource}s.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public final class SourceCache extends StringSource implements StreamCache {
diff --git a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java
index 6d61187f1fb..228e0565549 100644
--- a/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java
+++ b/core/camel-xml-jaxp/src/main/java/org/apache/camel/util/xml/StreamSourceCache.java
@@ -29,7 +29,12 @@ import org.apache.camel.converter.stream.ReaderCache;
import org.apache.camel.util.IOHelper;
/**
- * A {@link org.apache.camel.StreamCache} for {@link javax.xml.transform.stream.StreamSource}s
+ * A {@link org.apache.camel.StreamCache} for {@link javax.xml.transform.stream.StreamSource}s.
+ * <p/>
+ * <b>Important:</b>
+ * All the classes from the Camel release that implements {@link StreamCache} is NOT intended for end users
+ * to create as instances, but they are part of
+ * Camels <a href="https://camel.apache.org/manual/stream-caching.html">stream-caching</a> functionality.
*/
public final class StreamSourceCache extends StreamSource implements StreamCache {