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/d369b5f8 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d369b5f8 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d369b5f8 Branch: refs/heads/master Commit: d369b5f8e017acb98062aeff99c89c9b29065326 Parents: fec20a1 Author: Claus Ibsen <davscl...@apache.org> Authored: Mon Jan 19 16:15:36 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Mon Jan 19 16:25:09 2015 +0100 ---------------------------------------------------------------------- .../model/dataformat/BeanioDataFormat.java | 21 ++++++++++++++++++++ .../camel/model/dataformat/BindyDataFormat.java | 14 +++++++++++++ 2 files changed, 35 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/d369b5f8/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java index 40df8cc..6c200b8 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java @@ -75,6 +75,10 @@ public class BeanioDataFormat extends DataFormatDefinition { return mapping; } + /** + * The BeanIO mapping file. + * Is by default loaded from the classpath. You can prefix with file:, http:, or classpath: to denote from where to load the mapping file. + */ public void setMapping(String mapping) { this.mapping = mapping; } @@ -83,6 +87,9 @@ public class BeanioDataFormat extends DataFormatDefinition { return streamName; } + /** + * The name of the stream to use. + */ public void setStreamName(String streamName) { this.streamName = streamName; } @@ -91,6 +98,9 @@ public class BeanioDataFormat extends DataFormatDefinition { return ignoreUnidentifiedRecords; } + /** + * Whether to ignore unidentified records. + */ public void setIgnoreUnidentifiedRecords(Boolean ignoreUnidentifiedRecords) { this.ignoreUnidentifiedRecords = ignoreUnidentifiedRecords; } @@ -99,6 +109,9 @@ public class BeanioDataFormat extends DataFormatDefinition { return ignoreUnexpectedRecords; } + /** + * Whether to ignore unexpected records. + */ public void setIgnoreUnexpectedRecords(Boolean ignoreUnexpectedRecords) { this.ignoreUnexpectedRecords = ignoreUnexpectedRecords; } @@ -107,6 +120,9 @@ public class BeanioDataFormat extends DataFormatDefinition { return ignoreInvalidRecords; } + /** + * Whether to ignore invalid records. + */ public void setIgnoreInvalidRecords(Boolean ignoreInvalidRecords) { this.ignoreInvalidRecords = ignoreInvalidRecords; } @@ -115,6 +131,11 @@ public class BeanioDataFormat extends DataFormatDefinition { return encoding; } + /** + * The charset to use. + * <p/> + * Is by default the JVM platform default charset. + */ public void setEncoding(String encoding) { this.encoding = encoding; } http://git-wip-us.apache.org/repos/asf/camel/blob/d369b5f8/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java index 292825a..4b6e2a8 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java @@ -57,6 +57,9 @@ public class BindyDataFormat extends DataFormatDefinition { return type; } + /** + * Whether to use csv, fixed or key value pairs mode. + */ public void setType(BindyType type) { this.type = type; } @@ -65,6 +68,9 @@ public class BindyDataFormat extends DataFormatDefinition { return packages; } + /** + * The java package names to scan for model classes. + */ public void setPackages(String[] packages) { this.packages = packages; } @@ -73,6 +79,9 @@ public class BindyDataFormat extends DataFormatDefinition { return classType; } + /** + * Name of model class to use. + */ public void setClassType(String classType) { this.classType = classType; } @@ -85,6 +94,11 @@ public class BindyDataFormat extends DataFormatDefinition { return locale; } + /** + * To configure a default locale to use, such as <tt>us</tt> for united states. + * <p/> + * To use the JVM platform default locale then use the name <tt>default</tt> + */ public void setLocale(String locale) { this.locale = locale; }
