CAMEL-8195: Add javadoc to model classes so we have EIP documentation out of the box
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/fec20a1b Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fec20a1b Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fec20a1b Branch: refs/heads/master Commit: fec20a1b870605fcee1a9b39e29e0398a984fcca Parents: 4e58755 Author: Claus Ibsen <davscl...@apache.org> Authored: Mon Jan 19 14:47:07 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Mon Jan 19 16:25:09 2015 +0100 ---------------------------------------------------------------------- .../camel/model/config/PropertyDefinition.java | 10 ++++++++-- .../camel/model/dataformat/AvroDataFormat.java | 5 ++++- .../camel/model/dataformat/BarcodeDataFormat.java | 12 ++++++++++++ .../camel/model/dataformat/Base64DataFormat.java | 15 +++++++++++++++ 4 files changed, 39 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/fec20a1b/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java b/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java index dcb8a6d..055204b 100644 --- a/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/config/PropertyDefinition.java @@ -37,7 +37,10 @@ public class PropertyDefinition { public PropertyDefinition() { } - + + /** + * Property key + */ public void setKey(String key) { this.key = key; } @@ -45,7 +48,10 @@ public class PropertyDefinition { public String getKey() { return key; } - + + /** + * Property value + */ public void setValue(String value) { this.value = value; } http://git-wip-us.apache.org/repos/asf/camel/blob/fec20a1b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java index 543da5d..9cdfd9f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java @@ -36,7 +36,7 @@ import org.apache.camel.spi.Label; @XmlRootElement(name = "avro") @XmlAccessorType(XmlAccessType.FIELD) public class AvroDataFormat extends DataFormatDefinition { - @XmlAttribute + @XmlAttribute(required = true) private String instanceClassName; @XmlTransient private Object schema; @@ -54,6 +54,9 @@ public class AvroDataFormat extends DataFormatDefinition { return instanceClassName; } + /** + * Class name to use for marshal and unmarshalling + */ public void setInstanceClassName(String instanceClassName) { this.instanceClassName = instanceClassName; } http://git-wip-us.apache.org/repos/asf/camel/blob/fec20a1b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java index 4fa3460..57a0530 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java @@ -71,6 +71,9 @@ public class BarcodeDataFormat extends DataFormatDefinition { return width; } + /** + * Width of the barcode + */ public void setWidth(Integer width) { this.width = width; } @@ -79,6 +82,9 @@ public class BarcodeDataFormat extends DataFormatDefinition { return height; } + /** + * Height of the barcode + */ public void setHeight(Integer height) { this.height = height; } @@ -87,6 +93,9 @@ public class BarcodeDataFormat extends DataFormatDefinition { return imageType; } + /** + * Image type of the barcode such as png + */ public void setImageType(String imageType) { this.imageType = imageType; } @@ -95,6 +104,9 @@ public class BarcodeDataFormat extends DataFormatDefinition { return barcodeFormat; } + /** + * Barcode format such as QR-Code + */ public void setBarcodeFormat(String barcodeFormat) { this.barcodeFormat = barcodeFormat; } http://git-wip-us.apache.org/repos/asf/camel/blob/fec20a1b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java index 55c651c..f3f5e71 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java @@ -66,6 +66,11 @@ public class Base64DataFormat extends DataFormatDefinition { return lineLength; } + /** + * To specific a maximum line length for the encoded data. + * <p/> + * By default 76 is used. + */ public void setLineLength(Integer lineLength) { this.lineLength = lineLength; } @@ -74,6 +79,11 @@ public class Base64DataFormat extends DataFormatDefinition { return lineSeparator; } + /** + * The line separators to use. + * <p/> + * By default \r\n is used. + */ public void setLineSeparator(String lineSeparator) { this.lineSeparator = lineSeparator; } @@ -82,6 +92,11 @@ public class Base64DataFormat extends DataFormatDefinition { return urlSafe; } + /** + * Instead of emitting '+' and '/' we emit '-' and '_' respectively. + * urlSafe is only applied to encode operations. Decoding seamlessly handles both modes. + * Is by default false. + */ public void setUrlSafe(Boolean urlSafe) { this.urlSafe = urlSafe; }
