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/c27a9725 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c27a9725 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c27a9725 Branch: refs/heads/master Commit: c27a9725f7ea952f16454f4915bb2f60b5781aee Parents: 9387fb6 Author: Claus Ibsen <[email protected]> Authored: Mon Jan 19 19:05:39 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Mon Jan 19 19:55:07 2015 +0100 ---------------------------------------------------------------------- .../model/dataformat/DataFormatsDefinition.java | 6 +- .../camel/model/dataformat/JaxbDataFormat.java | 3 +- .../camel/model/dataformat/JibxDataFormat.java | 9 +++ .../camel/model/dataformat/JsonDataFormat.java | 40 ++++++++++ .../camel/model/dataformat/PGPDataFormat.java | 82 +++++++++++++++++++- .../model/dataformat/ProtobufDataFormat.java | 3 + .../model/dataformat/SoapJaxbDataFormat.java | 54 ++++++++++++- .../model/dataformat/StringDataFormat.java | 5 ++ .../model/dataformat/TidyMarkupDataFormat.java | 10 +++ .../model/dataformat/XMLBeansDataFormat.java | 5 ++ .../model/dataformat/XmlRpcDataFormat.java | 5 ++ .../camel/model/dataformat/ZipDataFormat.java | 4 + .../model/dataformat/ZipFileDataFormat.java | 4 + 13 files changed, 222 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/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 fa2aded..812b756 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 @@ -75,13 +75,13 @@ public class DataFormatsDefinition { ) private List<DataFormatDefinition> dataFormats; + /** + * A list holding the configured data formats + */ 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/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java index 51ea583..54d90f1 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java @@ -103,7 +103,7 @@ public class JaxbDataFormat extends DataFormatDefinition { } /** - * To enable pretty printing to output XML nicely formatted. + * To enable pretty printing output nicely formatted. * <p/> * Is by default false. */ @@ -167,7 +167,6 @@ public class JaxbDataFormat extends DataFormatDefinition { /** * To overrule and use a specific encoding - * @param encoding */ public void setEncoding(String encoding) { this.encoding = encoding; http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java index b360c89..15da316 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java @@ -56,6 +56,9 @@ public class JibxDataFormat extends DataFormatDefinition { return unmarshallClass; } + /** + * Class use when unmarshalling from XML to Java. + */ public void setUnmarshallClass(Class<?> unmarshallClass) { this.unmarshallClass = unmarshallClass; } @@ -64,6 +67,9 @@ public class JibxDataFormat extends DataFormatDefinition { return unmarshallTypeName; } + /** + * Class name to use when unmarshalling from XML to Java. + */ public void setUnmarshallTypeName(String unmarshallTypeName) { this.unmarshallTypeName = unmarshallTypeName; } @@ -72,6 +78,9 @@ public class JibxDataFormat extends DataFormatDefinition { return bindingName; } + /** + * To use a custom binding factory + */ public void setBindingName(String bindingName) { this.bindingName = bindingName; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java index 0568fad..6b9dd6d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java @@ -73,6 +73,11 @@ public class JsonDataFormat extends DataFormatDefinition { return prettyPrint; } + /** + * To enable pretty printing output nicely formatted. + * <p/> + * Is by default false. + */ public void setPrettyPrint(Boolean prettyPrint) { this.prettyPrint = prettyPrint; } @@ -81,6 +86,9 @@ public class JsonDataFormat extends DataFormatDefinition { return unmarshalTypeName; } + /** + * Class name of the java type to use when unarmshalling + */ public void setUnmarshalTypeName(String unmarshalTypeName) { this.unmarshalTypeName = unmarshalTypeName; } @@ -89,6 +97,9 @@ public class JsonDataFormat extends DataFormatDefinition { return unmarshalType; } + /** + * Class of the java type to use when unarmshalling + */ public void setUnmarshalType(Class<?> unmarshalType) { this.unmarshalType = unmarshalType; } @@ -97,6 +108,11 @@ public class JsonDataFormat extends DataFormatDefinition { return library; } + /** + * Which json library to use such. + * <p/> + * Is by default xstream + */ public void setLibrary(JsonLibrary library) { this.library = library; } @@ -105,6 +121,11 @@ public class JsonDataFormat extends DataFormatDefinition { return jsonView; } + /** + * When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. + * With Jackson you can use JSON views to accomplish this. This option is to refer to the class + * which has @JsonView annotations + */ public void setJsonView(Class<?> jsonView) { this.jsonView = jsonView; } @@ -113,6 +134,10 @@ public class JsonDataFormat extends DataFormatDefinition { return include; } + /** + * If you want to marshal a pojo to JSON, and the pojo has some fields with null values. + * And you want to skip these null values, you can set this option to <tt>NOT_NULL</tt> + */ public void setInclude(String include) { this.include = include; } @@ -121,6 +146,10 @@ public class JsonDataFormat extends DataFormatDefinition { return allowJmsType; } + /** + * Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname + * to use to unmarshal to. + */ public void setAllowJmsType(Boolean allowJmsType) { this.allowJmsType = allowJmsType; } @@ -129,6 +158,10 @@ public class JsonDataFormat extends DataFormatDefinition { return collectionTypeName; } + /** + * Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows + * to use different collection types than java.util.Collection based as default. + */ public void setCollectionTypeName(String collectionTypeName) { this.collectionTypeName = collectionTypeName; } @@ -137,6 +170,9 @@ public class JsonDataFormat extends DataFormatDefinition { return useList; } + /** + * To unarmshal to a List of Map or a List of Pojo. + */ public void setUseList(Boolean useList) { this.useList = useList; } @@ -145,6 +181,10 @@ public class JsonDataFormat extends DataFormatDefinition { return enableJaxbAnnotationModule; } + /** + * Whether to enable the JAXB annotations module when using jackson. When enabled then JAXB annotations + * can be used by Jackson. + */ public void setEnableJaxbAnnotationModule(Boolean enableJaxbAnnotationModule) { this.enableJaxbAnnotationModule = enableJaxbAnnotationModule; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java index a0c950d..955ad8f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java @@ -46,6 +46,8 @@ public class PGPDataFormat extends DataFormatDefinition { @XmlAttribute private String signatureKeyFileName; @XmlAttribute + private String signatureKeyRing; + @XmlAttribute private Boolean armored; @XmlAttribute private Boolean integrity; @@ -84,6 +86,9 @@ public class PGPDataFormat extends DataFormatDefinition { if (signatureKeyFileName != null) { setProperty(camelContext, dataFormat, "signatureKeyFileName", signatureKeyFileName); } + if (signatureKeyRing != null) { + setProperty(camelContext, dataFormat, "signatureKeyRing", signatureKeyRing); + } if (armored != null) { setProperty(camelContext, dataFormat, "armored", armored); } @@ -111,6 +116,14 @@ public class PGPDataFormat extends DataFormatDefinition { return signatureKeyUserid; } + /** + * User ID of the key in the PGP keyring used for signing (during encryption) or signature verification (during decryption). + * During the signature verification process the specified User ID restricts the public keys from the public + * keyring which can be used for the verification. If no User ID is specified for the signature verficiation + * then any public key in the public keyring can be used for the verification. Can also be only a part of a user ID. + * For example, if the user ID is "Test User <[email protected]>" then you can use the + * part "Test User" or "<[email protected]>" to address the User ID. + */ public void setSignatureKeyUserid(String signatureKeyUserid) { this.signatureKeyUserid = signatureKeyUserid; } @@ -119,6 +132,9 @@ public class PGPDataFormat extends DataFormatDefinition { return signaturePassword; } + /** + * Password used when opening the private key used for signing (during encryption). + */ public void setSignaturePassword(String signaturePassword) { this.signaturePassword = signaturePassword; } @@ -127,14 +143,34 @@ public class PGPDataFormat extends DataFormatDefinition { return signatureKeyFileName; } + /** + * Filename of the keyring to use for signing (during encryption) or for signature verification (during decryption); + * must be accessible as a classpath resource (but you can specify a location in the file system by using the "file:" prefix). + */ public void setSignatureKeyFileName(String signatureKeyFileName) { this.signatureKeyFileName = signatureKeyFileName; } + public String getSignatureKeyRing() { + return signatureKeyRing; + } + + /** + * Keyring used for signing/verifying as byte array. + * You can not set the signatureKeyFileName and signatureKeyRing at the same time. + */ + public void setSignatureKeyRing(String signatureKeyRing) { + this.signatureKeyRing = signatureKeyRing; + } + public Integer getHashAlgorithm() { return hashAlgorithm; } + /** + * Signature hash algorithm; possible values are defined in org.bouncycastle.bcpg.HashAlgorithmTags; + * for example 2 (= SHA1), 8 (= SHA256), 9 (= SHA384), 10 (= SHA512), 11 (=SHA224). Only relevant for signing. + */ public void setHashAlgorithm(Integer hashAlgorithm) { this.hashAlgorithm = hashAlgorithm; } @@ -143,6 +179,9 @@ public class PGPDataFormat extends DataFormatDefinition { return armored; } + /** + * This option will cause PGP to base64 encode the encrypted text, making it available for copy/paste, etc. + */ public void setArmored(Boolean armored) { this.armored = armored; } @@ -151,6 +190,11 @@ public class PGPDataFormat extends DataFormatDefinition { return integrity; } + /** + * Adds an integrity check/sign into the encryption file. + * <p/> + * The default value is true. + */ public void setIntegrity(Boolean integrity) { this.integrity = integrity; } @@ -159,6 +203,9 @@ public class PGPDataFormat extends DataFormatDefinition { return keyFileName; } + /** + * Filename of the keyring; must be accessible as a classpath resource (but you can specify a location in the file system by using the "file:" prefix). + */ public void setKeyFileName(String keyFileName) { this.keyFileName = keyFileName; } @@ -167,6 +214,12 @@ public class PGPDataFormat extends DataFormatDefinition { return keyUserid; } + /** + * The user ID of the key in the PGP keyring used during encryption. + * Can also be only a part of a user ID. + * For example, if the user ID is "Test User <[email protected]>" + * then you can use the part "Test User" or "<[email protected]>" to address the user ID. + */ public void setKeyUserid(String keyUserid) { this.keyUserid = keyUserid; } @@ -179,18 +232,29 @@ public class PGPDataFormat extends DataFormatDefinition { return algorithm; } + /** + * Symmetric key encryption algorithm; possible values are defined in org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags; + * for example 2 (= TRIPLE DES), 3 (= CAST5), 4 (= BLOWFISH), 6 (= DES), 7 (= AES_128). Only relevant for encrypting. + */ public void setAlgorithm(Integer algorithm) { this.algorithm = algorithm; } - + public Integer getCompressionAlgorithm() { return compressionAlgorithm; } + /** + * Compression algorithm; possible values are defined in org.bouncycastle.bcpg.CompressionAlgorithmTags; + * for example 0 (= UNCOMPRESSED), 1 (= ZIP), 2 (= ZLIB), 3 (= BZIP2). Only relevant for encrypting. + */ public void setCompressionAlgorithm(Integer compressionAlgorithm) { this.compressionAlgorithm = compressionAlgorithm; } + /** + * Password used when opening the private key (not used for encryption). + */ public void setPassword(String password) { this.password = password; } @@ -199,14 +263,28 @@ public class PGPDataFormat extends DataFormatDefinition { return provider; } + /** + * Java Cryptography Extension (JCE) provider, default is Bouncy Castle + * ("BC"). Alternatively you can use, for example, the IAIK JCE provider; in + * this case the provider must be registered beforehand and the Bouncy + * Castle provider must not be registered beforehand. The Sun JCE provider + * does not work. + */ public void setProvider(String provider) { this.provider = provider; } - + public String getSignatureVerificationOption() { return signatureVerificationOption; } + /** + * Controls the behavior for verifying the signature during unmarshaling. There are 4 values possible: + * "optional": The PGP message may or may not contain signatures; if it does contain signatures, then a signature verification is executed. + * "required": The PGP message must contain at least one signature; if this is not the case an exception (PGPException) is thrown. A signature verification is executed. + * "ignore": Contained signatures in the PGP message are ignored; no signature verification is executed. + * "no_signature_allowed": The PGP message must not contain a signature; otherwise an exception (PGPException) is thrown. + */ public void setSignatureVerificationOption(String signatureVerificationOption) { this.signatureVerificationOption = signatureVerificationOption; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java index d2f9e34..1880ef5 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java @@ -54,6 +54,9 @@ public class ProtobufDataFormat extends DataFormatDefinition { return instanceClass; } + /** + * Name of class to use when unarmshalling + */ public void setInstanceClass(String instanceClass) { this.instanceClass = instanceClass; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java index 3f6cc04..79c9b83 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java @@ -70,6 +70,9 @@ public class SoapJaxbDataFormat extends DataFormatDefinition { setElementNameStrategy(elementNameStrategy); } + /** + * Package name where your JAXB classes are located. + */ public void setContextPath(String contextPath) { this.contextPath = contextPath; } @@ -78,6 +81,9 @@ public class SoapJaxbDataFormat extends DataFormatDefinition { return contextPath; } + /** + * To overrule and use a specific encoding + */ public void setEncoding(String encoding) { this.encoding = encoding; } @@ -86,6 +92,22 @@ public class SoapJaxbDataFormat extends DataFormatDefinition { return encoding; } + /** + * Refers to an element strategy to lookup from the registry. + * <p/> + * An element name strategy is used for two purposes. The first is to find a xml element name for a given object + * and soap action when marshaling the object into a SOAP message. The second is to find an Exception class for a given soap fault name. + * <p/> + * The following three element strategy class name is provided out of the box. + * QNameStrategy - Uses a fixed qName that is configured on instantiation. Exception lookup is not supported + * TypeNameStrategy - Uses the name and namespace from the @XMLType annotation of the given type. If no namespace is set then package-info is used. Exception lookup is not supported + * ServiceInterfaceStrategy - Uses information from a webservice interface to determine the type name and to find the exception class for a SOAP fault + * <p/> + * All three classes is located in the package name org.apache.camel.dataformat.soap.name + * <p/> + * If you have generated the web service stub code with cxf-codegen or a similar tool then you probably + * will want to use the ServiceInterfaceStrategy. In the case you have no annotated service interface you should use QNameStrategy or TypeNameStrategy. + */ public void setElementNameStrategyRef(String elementNameStrategyRef) { this.elementNameStrategyRef = elementNameStrategyRef; } @@ -98,10 +120,31 @@ public class SoapJaxbDataFormat extends DataFormatDefinition { return version; } + /** + * SOAP version should either be 1.1 or 1.2. + * <p/> + * Is by default 1.1 + */ public void setVersion(String version) { this.version = version; } + /** + * Sets an element strategy instance to use. + * <p/> + * An element name strategy is used for two purposes. The first is to find a xml element name for a given object + * and soap action when marshaling the object into a SOAP message. The second is to find an Exception class for a given soap fault name. + * <p/> + * The following three element strategy class name is provided out of the box. + * QNameStrategy - Uses a fixed qName that is configured on instantiation. Exception lookup is not supported + * TypeNameStrategy - Uses the name and namespace from the @XMLType annotation of the given type. If no namespace is set then package-info is used. Exception lookup is not supported + * ServiceInterfaceStrategy - Uses information from a webservice interface to determine the type name and to find the exception class for a SOAP fault + * <p/> + * All three classes is located in the package name org.apache.camel.dataformat.soap.name + * <p/> + * If you have generated the web service stub code with cxf-codegen or a similar tool then you probably + * will want to use the ServiceInterfaceStrategy. In the case you have no annotated service interface you should use QNameStrategy or TypeNameStrategy. + */ public void setElementNameStrategy(Object elementNameStrategy) { this.elementNameStrategy = elementNameStrategy; } @@ -114,6 +157,10 @@ public class SoapJaxbDataFormat extends DataFormatDefinition { return namespacePrefixRef; } + /** + * When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, + * such as ns2, ns3, ns4 etc. To control this mapping, Camel allows you to refer to a map which contains the desired mapping. + */ public void setNamespacePrefixRef(String namespacePrefixRef) { this.namespacePrefixRef = namespacePrefixRef; } @@ -121,7 +168,12 @@ public class SoapJaxbDataFormat extends DataFormatDefinition { public String getSchema() { return schema; } - + + /** + * To validate against an existing schema. + * Your can use the prefix classpath:, file:* or *http: to specify how the resource should by resolved. + * You can separate multiple schema files by using the ',' character. + */ public void setSchema(String schema) { this.schema = schema; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java index 7b0928f..50c2c19 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java @@ -51,6 +51,11 @@ public class StringDataFormat extends DataFormatDefinition { return charset; } + /** + * Sets an encoding to use. + * <p/> + * Will by default use the JVM platform default charset. + */ public void setCharset(String charset) { this.charset = charset; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java index b8b4789..2ac4477 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java @@ -56,6 +56,11 @@ public class TidyMarkupDataFormat extends DataFormatDefinition { this.setDataObjectType(dataObjectType); } + /** + * What data type to unmarshal as, can either be org.w3c.dom.Node or java.lang.String. + * <p/> + * Is by default org.w3c.dom.Node + */ public void setDataObjectType(Class<?> dataObjectType) { this.dataObjectType = dataObjectType; } @@ -68,6 +73,11 @@ public class TidyMarkupDataFormat extends DataFormatDefinition { return dataObjectTypeName; } + /** + * What data type to unmarshal as, can either be org.w3c.dom.Node or java.lang.String. + * <p/> + * Is by default org.w3c.dom.Node + */ public void setDataObjectTypeName(String dataObjectTypeName) { this.dataObjectTypeName = dataObjectTypeName; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java index b9a0baa..7d198de 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java @@ -44,6 +44,11 @@ public class XMLBeansDataFormat extends DataFormatDefinition { return prettyPrint; } + /** + * To enable pretty printing output nicely formatted. + * <p/> + * Is by default false. + */ public void setPrettyPrint(Boolean prettyPrint) { this.prettyPrint = prettyPrint; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java index 4f1e13c..2bcc7a6 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java @@ -51,6 +51,11 @@ public class XmlRpcDataFormat extends DataFormatDefinition { return request; } + /** + * Whether to unmarshal request or response + * <p/> + * Is by default false + */ public void setRequest(Boolean request) { this.request = request; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java index 2514134..39f9cf7 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java @@ -58,6 +58,10 @@ public class ZipDataFormat extends DataFormatDefinition { return compressionLevel; } + /** + * To specify a specific compression between 0-9. + * 0 is no compression, and 9 is best compression. + */ public void setCompressionLevel(Integer compressionLevel) { this.compressionLevel = compressionLevel; } http://git-wip-us.apache.org/repos/asf/camel/blob/c27a9725/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java index e33ae15..a982c86 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java @@ -52,6 +52,10 @@ public class ZipFileDataFormat extends DataFormatDefinition { return usingIterator; } + /** + * If the zip file has more then one entry, the setting this option to true, allows to work with the splitter EIP, + * to split the data using an iterator in a streaming mode. + */ public void setUsingIterator(Boolean usingIterator) { this.usingIterator = usingIterator; }
