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/7058c245 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/7058c245 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/7058c245 Branch: refs/heads/master Commit: 7058c245b671f82a899816ce9611950788298683 Parents: b6db690 Author: Claus Ibsen <davscl...@apache.org> Authored: Mon Jan 19 16:47:52 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Mon Jan 19 19:14:25 2015 +0100 ---------------------------------------------------------------------- .../camel/model/dataformat/CsvDataFormat.java | 74 ++++++++++++++++++-- .../model/dataformat/DataFormatsDefinition.java | 5 +- .../model/dataformat/FlatpackDataFormat.java | 31 ++++++++ .../camel/model/dataformat/HL7DataFormat.java | 8 +++ .../camel/model/dataformat/IcalDataFormat.java | 3 + 5 files changed, 115 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/7058c245/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java index e8d2144..f6c3c9b 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java @@ -54,7 +54,7 @@ public class CsvDataFormat extends DataFormatDefinition { private String escape; @XmlAttribute private Boolean headerDisabled; - @XmlElement(name = "header") + @XmlElement private List<String> header; @XmlAttribute private Boolean allowMissingColumnNames; @@ -180,12 +180,13 @@ public class CsvDataFormat extends DataFormatDefinition { return value.charAt(0); } - //region Getters/Setters - public String getFormatRef() { return formatRef; } + /** + * The reference format to use, it will be updated with the other format options, the default value is CSVFormat.DEFAULT + */ public void setFormatRef(String formatRef) { this.formatRef = formatRef; } @@ -194,6 +195,9 @@ public class CsvDataFormat extends DataFormatDefinition { return formatName; } + /** + * The name of the format to use, the default value is CSVFormat.DEFAULT + */ public void setFormatName(String formatName) { this.formatName = formatName; } @@ -202,6 +206,9 @@ public class CsvDataFormat extends DataFormatDefinition { return commentMarkerDisabled; } + /** + * Disables the comment marker of the reference format. + */ public void setCommentMarkerDisabled(Boolean commentMarkerDisabled) { this.commentMarkerDisabled = commentMarkerDisabled; } @@ -210,6 +217,9 @@ public class CsvDataFormat extends DataFormatDefinition { return commentMarker; } + /** + * Sets the comment marker of the reference format. + */ public void setCommentMarker(String commentMarker) { this.commentMarker = commentMarker; } @@ -218,6 +228,11 @@ public class CsvDataFormat extends DataFormatDefinition { return delimiter; } + /** + * Sets the delimiter to use. + * <p/> + * The default value is , (comma) + */ public void setDelimiter(String delimiter) { this.delimiter = delimiter; } @@ -226,6 +241,9 @@ public class CsvDataFormat extends DataFormatDefinition { return escapeDisabled; } + /** + * Use for disabling using escape character + */ public void setEscapeDisabled(Boolean escapeDisabled) { this.escapeDisabled = escapeDisabled; } @@ -234,10 +252,16 @@ public class CsvDataFormat extends DataFormatDefinition { return escape; } + /** + * Sets the escape character to use + */ public void setEscape(String escape) { this.escape = escape; } + /** + * Use for disabling headers + */ public Boolean getHeaderDisabled() { return headerDisabled; } @@ -250,6 +274,9 @@ public class CsvDataFormat extends DataFormatDefinition { return header; } + /** + * To configure the CSV headers + */ public void setHeader(List<String> header) { this.header = header; } @@ -258,6 +285,9 @@ public class CsvDataFormat extends DataFormatDefinition { return allowMissingColumnNames; } + /** + * Whether to allow missing column names. + */ public void setAllowMissingColumnNames(Boolean allowMissingColumnNames) { this.allowMissingColumnNames = allowMissingColumnNames; } @@ -266,6 +296,9 @@ public class CsvDataFormat extends DataFormatDefinition { return ignoreEmptyLines; } + /** + * Whether to ignore empty lines. + */ public void setIgnoreEmptyLines(Boolean ignoreEmptyLines) { this.ignoreEmptyLines = ignoreEmptyLines; } @@ -274,6 +307,9 @@ public class CsvDataFormat extends DataFormatDefinition { return ignoreSurroundingSpaces; } + /** + * Whether to ignore surrounding spaces + */ public void setIgnoreSurroundingSpaces(Boolean ignoreSurroundingSpaces) { this.ignoreSurroundingSpaces = ignoreSurroundingSpaces; } @@ -282,6 +318,9 @@ public class CsvDataFormat extends DataFormatDefinition { return nullStringDisabled; } + /** + * Used to disable null strings + */ public void setNullStringDisabled(Boolean nullStringDisabled) { this.nullStringDisabled = nullStringDisabled; } @@ -290,6 +329,9 @@ public class CsvDataFormat extends DataFormatDefinition { return nullString; } + /** + * Sets the null string + */ public void setNullString(String nullString) { this.nullString = nullString; } @@ -298,6 +340,9 @@ public class CsvDataFormat extends DataFormatDefinition { return quoteDisabled; } + /** + * Used to disable quotes + */ public void setQuoteDisabled(Boolean quoteDisabled) { this.quoteDisabled = quoteDisabled; } @@ -306,6 +351,9 @@ public class CsvDataFormat extends DataFormatDefinition { return quote; } + /** + * Sets the quote which by default is " + */ public void setQuote(String quote) { this.quote = quote; } @@ -314,6 +362,9 @@ public class CsvDataFormat extends DataFormatDefinition { return recordSeparatorDisabled; } + /** + * Used for disabling record separator + */ public void setRecordSeparatorDisabled(String recordSeparatorDisabled) { this.recordSeparatorDisabled = recordSeparatorDisabled; } @@ -322,6 +373,9 @@ public class CsvDataFormat extends DataFormatDefinition { return recordSeparator; } + /** + * Sets the record separator (aka new line) which by default is \r\n (CRLF) + */ public void setRecordSeparator(String recordSeparator) { this.recordSeparator = recordSeparator; } @@ -330,6 +384,9 @@ public class CsvDataFormat extends DataFormatDefinition { return skipHeaderRecord; } + /** + * Whether to skip the header record in the output + */ public void setSkipHeaderRecord(Boolean skipHeaderRecord) { this.skipHeaderRecord = skipHeaderRecord; } @@ -338,6 +395,9 @@ public class CsvDataFormat extends DataFormatDefinition { return lazyLoad; } + /** + * Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. + */ public void setLazyLoad(Boolean lazyLoad) { this.lazyLoad = lazyLoad; } @@ -346,6 +406,9 @@ public class CsvDataFormat extends DataFormatDefinition { return useMaps; } + /** + * Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). + */ public void setUseMaps(Boolean useMaps) { this.useMaps = useMaps; } @@ -354,8 +417,11 @@ public class CsvDataFormat extends DataFormatDefinition { return recordConverterRef; } + /** + * Refers to a custom <tt>CsvRecordConverter</tt> to lookup from the registry to use. + */ public void setRecordConverterRef(String recordConverterRef) { this.recordConverterRef = recordConverterRef; } - //endregion + } http://git-wip-us.apache.org/repos/asf/camel/blob/7058c245/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java index f39d1cc..fa2aded 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/DataFormatsDefinition.java @@ -19,7 +19,6 @@ package org.apache.camel.model.dataformat; import java.util.HashMap; import java.util.List; import java.util.Map; - import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlElement; @@ -76,11 +75,13 @@ public class DataFormatsDefinition { ) private List<DataFormatDefinition> dataFormats; - public void setDataFormats(List<DataFormatDefinition> dataFormats) { this.dataFormats = dataFormats; } + /** + * A list holding the configured data formats + */ public List<DataFormatDefinition> getDataFormats() { return dataFormats; } http://git-wip-us.apache.org/repos/asf/camel/blob/7058c245/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java index aa48e7a..fa1c3f3 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java @@ -61,6 +61,9 @@ public class FlatpackDataFormat extends DataFormatDefinition { return parserFactoryRef; } + /** + * References to a custom parser factory to lookup in the registry + */ public void setParserFactoryRef(String parserFactoryRef) { this.parserFactoryRef = parserFactoryRef; } @@ -69,6 +72,9 @@ public class FlatpackDataFormat extends DataFormatDefinition { return definition; } + /** + * The flatpack pzmap configuration file. Can be omitted in simpler situations, but its preferred to use the pzmap. + */ public void setDefinition(String definition) { this.definition = definition; } @@ -77,6 +83,10 @@ public class FlatpackDataFormat extends DataFormatDefinition { return fixed; } + /** + * Delimited or fixed. + * Is by default false = delimited + */ public void setFixed(Boolean fixed) { this.fixed = fixed; } @@ -85,6 +95,11 @@ public class FlatpackDataFormat extends DataFormatDefinition { return ignoreFirstRecord; } + /** + * Whether the first line is ignored for delimited files (for the column headers). + * <p/> + * Is by default true. + */ public void setIgnoreFirstRecord(Boolean ignoreFirstRecord) { this.ignoreFirstRecord = ignoreFirstRecord; } @@ -93,6 +108,11 @@ public class FlatpackDataFormat extends DataFormatDefinition { return textQualifier; } + /** + * If the text is qualified with a char such as " + * <p/> + * The default value is " + */ public void setTextQualifier(String textQualifier) { this.textQualifier = textQualifier; } @@ -101,6 +121,11 @@ public class FlatpackDataFormat extends DataFormatDefinition { return delimiter; } + /** + * The delimiter char (could be ; , or similar) + * <p/> + * The default value is , + */ public void setDelimiter(String delimiter) { this.delimiter = delimiter; } @@ -109,6 +134,9 @@ public class FlatpackDataFormat extends DataFormatDefinition { return allowShortLines; } + /** + * Allows for lines to be shorter than expected and ignores the extra characters + */ public void setAllowShortLines(Boolean allowShortLines) { this.allowShortLines = allowShortLines; } @@ -117,6 +145,9 @@ public class FlatpackDataFormat extends DataFormatDefinition { return ignoreExtraColumns; } + /** + * Allows for lines to be longer than expected and ignores the extra characters. + */ public void setIgnoreExtraColumns(Boolean ignoreExtraColumns) { this.ignoreExtraColumns = ignoreExtraColumns; } http://git-wip-us.apache.org/repos/asf/camel/blob/7058c245/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java index 252b8f1..5e43f92 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java @@ -54,6 +54,11 @@ public class HL7DataFormat extends DataFormatDefinition { return validate; } + /** + * Whether to validate the HL7 message + * <p/> + * Is by default true. + */ public void setValidate(Boolean validate) { this.validate = validate; } @@ -62,6 +67,9 @@ public class HL7DataFormat extends DataFormatDefinition { return parser; } + /** + * To use a custom HL7 parser + */ public void setParser(Object parser) { this.parser = parser; } http://git-wip-us.apache.org/repos/asf/camel/blob/7058c245/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java index 90bba3d..eb7d63a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java @@ -46,6 +46,9 @@ public class IcalDataFormat extends DataFormatDefinition { return validating; } + /** + * Whether to validate. + */ public void setValidating(Boolean validating) { this.validating = validating; }
