Author: gertv
Date: Fri Dec 3 12:27:50 2010
New Revision: 1041785
URL: http://svn.apache.org/viewvc?rev=1041785&view=rev
Log:
Add better javadocs to improve generated wiki/xsd documentation
Modified:
servicemix/components/engines/servicemix-saxon/trunk/pom.xml
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/SaxonEndpoint.java
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/XsltEndpoint.java
Modified: servicemix/components/engines/servicemix-saxon/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-saxon/trunk/pom.xml?rev=1041785&r1=1041784&r2=1041785&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-saxon/trunk/pom.xml (original)
+++ servicemix/components/engines/servicemix-saxon/trunk/pom.xml Fri Dec 3
12:27:50 2010
@@ -124,6 +124,13 @@
<artifactId>easymock</artifactId>
<scope>test</scope>
</dependency>
+
+ <!-- documentation -->
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-common</artifactId>
+ <classifier>sources</classifier>
+ </dependency>
</dependencies>
<build>
Modified:
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/SaxonEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/SaxonEndpoint.java?rev=1041785&r1=1041784&r2=1041785&view=diff
==============================================================================
---
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/SaxonEndpoint.java
(original)
+++
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/SaxonEndpoint.java
Fri Dec 3 12:27:50 2010
@@ -58,6 +58,8 @@ public abstract class SaxonEndpoint exte
private Map parameters;
/**
+ * Set a SourceTransformer instance to use for handling XML conversions.
+ *
* @param sourceTransformer the sourceTransformer to set
*/
protected void setSourceTransformer(SourceTransformer sourceTransformer) {
@@ -65,6 +67,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ *
+ *
* @return the sourceTransformer
*/
public SourceTransformer getSourceTransformer() {
@@ -79,6 +83,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Resource referring to the WSDL resource that defines this endpoint.
+ *
* @param wsdlResource the wsdlResource to set
*/
public void setWsdlResource(Resource wsdlResource) {
@@ -93,6 +99,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Expression to dynamically determine the stylesheet to use for
processing the exchange.
+ *
* @param expression the expression to set
*/
public void setExpression(Expression expression) {
@@ -107,6 +115,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Spring Resource for the XSL-T stylesheet or XQuery file to use.
+ *
* @param resource the resource to set
*/
public void setResource(Resource resource) {
@@ -137,6 +147,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * The output result type, possible values are dom, bytes, string.
Defaults to dom.
+ *
* @param result the result to set
*/
public void setResult(String result) {
@@ -151,6 +163,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Additional configuration for the Saxon XSL-T/XQuery processor.
+ *
* @param configuration the configuration to set
*/
public void setConfiguration(Configuration configuration) {
@@ -158,6 +172,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Copy attachments into the resulting normalized message. Defaults to
<code>true</code>.
+ *
* @return the copyAttachments
*/
public boolean isCopyAttachments() {
@@ -172,6 +188,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Copy properties into the resulting normalized message. Defaults to
<code>true</code>.
+ *
* @return the copyProperties
*/
public boolean isCopyProperties() {
@@ -186,6 +204,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Copy the security subject into the resulting normalized message.
Defaults to <code>true</code>.
+ *
* @return the copySubject
*/
public boolean isCopySubject() {
@@ -207,6 +227,8 @@ public abstract class SaxonEndpoint exte
}
/**
+ * Add parameter names and values that are available during XSL/XQuery
processing.
+ *
* @param parameters the parameters to set
*/
public void setParameters(Map parameters) {
Modified:
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/XsltEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/XsltEndpoint.java?rev=1041785&r1=1041784&r2=1041785&view=diff
==============================================================================
---
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/XsltEndpoint.java
(original)
+++
servicemix/components/engines/servicemix-saxon/trunk/src/main/java/org/apache/servicemix/saxon/XsltEndpoint.java
Fri Dec 3 12:27:50 2010
@@ -49,7 +49,6 @@ public class XsltEndpoint extends SaxonE
private Templates templates;
private boolean useDomSourceForXslt = true;
private Boolean useDomSourceForContent;
- private boolean reload = false;
public TransformerFactory getTransformerFactory() {
if (transformerFactory == null) {
@@ -58,6 +57,11 @@ public class XsltEndpoint extends SaxonE
return transformerFactory;
}
+ /**
+ * Set a transform factory, e.g. for injecting a custom transformer
configuration or implementation.
+ *
+ * @param transformerFactory
+ */
public void setTransformerFactory(TransformerFactory transformerFactory) {
this.transformerFactory = transformerFactory;
}
@@ -66,6 +70,11 @@ public class XsltEndpoint extends SaxonE
return useDomSourceForXslt;
}
+ /**
+ * Convert the XSL-T stylesheet Source into a DOMSource. Defaults to
<code>true</true>.
+ *
+ * @param useDomSourceForXslt
+ */
public void setUseDomSourceForXslt(boolean useDomSourceForXslt) {
this.useDomSourceForXslt = useDomSourceForXslt;
}
@@ -74,18 +83,15 @@ public class XsltEndpoint extends SaxonE
return useDomSourceForContent;
}
+ /**
+ * Convert the message body Source into a DOMSource. Defaults to
<code>false</true>.
+ *
+ * @param useDomSourceForContent
+ */
public void setUseDomSourceForContent(Boolean useDomSourceForContent) {
this.useDomSourceForContent = useDomSourceForContent;
}
- public boolean isReload() {
- return reload;
- }
-
- public void setReload(boolean reload) {
- this.reload = reload;
- }
-
public void validate() throws DeploymentException {
if (xsltSource == null && getResource() == null && getExpression() ==
null) {
throw new DeploymentException("xsltSource, resource or expression
must be specified");
