Spring/spring-ws
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixing javadoc

Browse Source
This commit is contained in:
Arjen Poutsma
2014-04-16 17:30:39 +02:00
parent 124675ba78
commit bbc6bf5f60
327 changed files with 2901 additions and 2292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
spring-xml/src/main/java/org/springframework/xml/JaxpVersion.java
View File

@@ -21,11 +21,11 @@ import org.springframework.util.ClassUtils;
/**
* Helper class used to find the current version of JAXP. We cannot depend on the Java version, since JAXP can be
* upgraded independently of the Java version.
* <p/>
* Only distinguishes between JAXP 1.0, 1.1, 1.3, and 1.4, since JAXP 1.2 was a maintenance release with no new
*
* <p>Only distinguishes between JAXP 1.0, 1.1, 1.3, and 1.4, since JAXP 1.2 was a maintenance release with no new
* classes.
* <p>
* Note that Spring-WS requires JDK 1.5 as of Spring-WS 2.0, and therefore has at least JAXP 1.3 available.
*
* <p>Note that Spring-WS requires JDK 1.5 as of Spring-WS 2.0, and therefore has at least JAXP 1.3 available.
*
* @author Arjen Poutsma
* @since 1.0.0
@@ -69,7 +69,7 @@ public abstract class JaxpVersion {
}
/**
* Gets the JAXP version. This means we can do things like if <code>(getJaxpVersion() < JAXP_13)</code>.
* Gets the JAXP version. This means we can do things like if {@code (getJaxpVersion() < JAXP_13)}.
*
* @return a code comparable to the JAXP_XX codes in this class
* @see #JAXP_10
@@ -84,7 +84,7 @@ public abstract class JaxpVersion {
/**
* Convenience method to determine if the current JAXP version is at least 1.4 (packaged with JDK 1.6).
*
* @return <code>true</code> if the current JAXP version is at least JAXP 1.4
* @return {@code true} if the current JAXP version is at least JAXP 1.4
* @see #getJaxpVersion()
* @see #JAXP_14
*/

4
spring-xml/src/main/java/org/springframework/xml/XmlException.java
View File

@@ -27,7 +27,7 @@ import org.springframework.core.NestedRuntimeException;
public abstract class XmlException extends NestedRuntimeException {
/**
* Constructs a new instance of the <code>XmlException</code> with the specific detail message.
* Constructs a new instance of the {@code XmlException} with the specific detail message.
*
* @param message the detail message
*/
@@ -36,7 +36,7 @@ public abstract class XmlException extends NestedRuntimeException {
}
/**
* Constructs a new instance of the <code>XmlException</code> with the specific detail message and exception.
* Constructs a new instance of the {@code XmlException} with the specific detail message and exception.
*
* @param message the detail message
* @param throwable the wrapped exception

4
spring-xml/src/main/java/org/springframework/xml/dom/DomContentHandler.java
View File

@@ -32,7 +32,7 @@ import org.xml.sax.SAXException;
import org.springframework.util.Assert;
/**
* SAX <code>ContentHandler</code> that transforms callback calls to DOM <code>Node</code>s.
* SAX {@code ContentHandler} that transforms callback calls to DOM {@code Node}s.
*
* @author Arjen Poutsma
* @see org.w3c.dom.Node
@@ -47,7 +47,7 @@ public class DomContentHandler implements ContentHandler {
private final Node node;
/**
* Creates a new instance of the <code>DomContentHandler</code> with the given node.
* Creates a new instance of the {@code DomContentHandler} with the given node.
*
* @param node the node to publish events to
*/

8
spring-xml/src/main/java/org/springframework/xml/namespace/QNameEditor.java
View File

@@ -22,9 +22,9 @@ import javax.xml.namespace.QName;
import org.springframework.util.StringUtils;
/**
* PropertyEditor for <code>javax.xml.namespace.QName</code>, to populate a property of type QName from a String value.
* <p/>
* Expects the syntax
* PropertyEditor for {@code javax.xml.namespace.QName}, to populate a property of type QName from a String value.
*
* <p>Expects the syntax
* <pre>
* localPart
* </pre>
@@ -36,7 +36,7 @@ import org.springframework.util.StringUtils;
* <pre>
* {namespace}prefix:localPart
* </pre>
* This resembles the <code>toString()</code> representation of <code>QName</code> itself, but allows for prefixes to be
* This resembles the {@code toString()} representation of {@code QName} itself, but allows for prefixes to be
* specified as well.
*
* @author Arjen Poutsma

38
spring-xml/src/main/java/org/springframework/xml/namespace/QNameUtils.java
View File

@@ -46,14 +46,14 @@ public abstract class QNameUtils {
}
/**
* Creates a new <code>QName</code> with the given parameters. Sets the prefix if possible, i.e. if the
* <code>QName(String, String, String)</code> constructor can be found. If this constructor is not available (as is
* Creates a new {@code QName} with the given parameters. Sets the prefix if possible, i.e. if the
* {@code QName(String, String, String)} constructor can be found. If this constructor is not available (as is
* the case on older implementations of JAX-RPC), the prefix is ignored.
*
* @param namespaceUri namespace URI of the <code>QName</code>
* @param localPart local part of the <code>QName</code>
* @param prefix prefix of the <code>QName</code>. May be ignored.
* @return the created <code>QName</code>
* @param namespaceUri namespace URI of the {@code QName}
* @param localPart local part of the {@code QName}
* @param prefix prefix of the {@code QName}. May be ignored.
* @return the created {@code QName}
* @see QName#QName(String,String,String)
*/
public static QName createQName(String namespaceUri, String localPart, String prefix) {
@@ -66,11 +66,11 @@ public abstract class QNameUtils {
}
/**
* Returns the prefix of the given <code>QName</code>. Returns the prefix if available, i.e. if the
* <code>QName.getPrefix()</code> method can be found. If this method is not available (as is the case on older
* Returns the prefix of the given {@code QName}. Returns the prefix if available, i.e. if the
* {@code QName.getPrefix()} method can be found. If this method is not available (as is the case on older
* implementations of JAX-RPC), an empty string is returned.
*
* @param qName the <code>QName</code> to return the prefix from
* @param qName the {@code QName} to return the prefix from
* @return the prefix, if available, or an empty string
* @see javax.xml.namespace.QName#getPrefix()
*/
@@ -82,7 +82,7 @@ public abstract class QNameUtils {
* Validates the given String as a QName
*
* @param text the qualified name
* @return <code>true</code> if valid, <code>false</code> otherwise
* @return {@code true} if valid, {@code false} otherwise
*/
public static boolean validateQName(String text) {
if (!StringUtils.hasLength(text)) {
@@ -121,10 +121,10 @@ public abstract class QNameUtils {
}
/**
* Convert a <code>QName</code> to a qualified name, as used by DOM and SAX. The returned string has a format of
* <code>prefix:localName</code> if the prefix is set, or just <code>localName</code> if not.
* Convert a {@code QName} to a qualified name, as used by DOM and SAX. The returned string has a format of
* {@code prefix:localName} if the prefix is set, or just {@code localName} if not.
*
* @param qName the <code>QName</code>
* @param qName the {@code QName}
* @return the qualified name
*/
public static String toQualifiedName(QName qName) {
@@ -138,8 +138,8 @@ public abstract class QNameUtils {
}
/**
* Convert a namespace URI and DOM or SAX qualified name to a <code>QName</code>. The qualified name can have the
* form <code>prefix:localname</code> or <code>localName</code>.
* Convert a namespace URI and DOM or SAX qualified name to a {@code QName}. The qualified name can have the
* form {@code prefix:localname} or {@code localName}.
*
* @param namespaceUri the namespace URI
* @param qualifiedName the qualified name
@@ -156,13 +156,13 @@ public abstract class QNameUtils {
}
/**
* Parse the given qualified name string into a <code>QName</code>. Expects the syntax <code>localPart</code>,
* <code>{namespace}localPart</code>, or <code>{namespace}prefix:localPart</code>. This format resembles the
* <code>toString()</code> representation of <code>QName</code> itself, but allows for prefixes to be specified as
* Parse the given qualified name string into a {@code QName}. Expects the syntax {@code localPart},
* {@code{namespace}localPart}, or {@code{namespace}prefix:localPart}. This format resembles the
* {@code toString()} representation of {@code QName} itself, but allows for prefixes to be specified as
* well.
*
* @return a corresponding QName instance
* @throws IllegalArgumentException when the given string is <code>null</code> or empty.
* @throws IllegalArgumentException when the given string is {@code null} or empty.
*/
public static QName parseQNameString(String qNameString) {
Assert.hasLength(qNameString, "QName text may not be null or empty");

6
spring-xml/src/main/java/org/springframework/xml/namespace/SimpleNamespaceContext.java
View File

@@ -29,9 +29,9 @@ import javax.xml.namespace.NamespaceContext;
import org.springframework.util.Assert;
/**
* Simple <code>javax.xml.namespace.NamespaceContext</code> implementation. Follows the standard
* <code>NamespaceContext</code> contract, and is loadable via a <code>java.util.Map</code> or
* <code>java.util.Properties</code> object
* Simple {@code javax.xml.namespace.NamespaceContext} implementation. Follows the standard
* {@code NamespaceContext} contract, and is loadable via a {@code java.util.Map} or
* {@code java.util.Properties} object
*
* @author Arjen Poutsma
* @since 1.0.0

14
spring-xml/src/main/java/org/springframework/xml/sax/AbstractXmlReader.java
View File

@@ -26,7 +26,7 @@ import org.xml.sax.XMLReader;
import org.xml.sax.ext.LexicalHandler;
/**
* Abstract base class for SAX <code>XMLReader</code> implementations. Contains properties as defined in {@link
* Abstract base class for SAX {@code XMLReader} implementations. Contains properties as defined in {@link
* XMLReader}, and does not recognize any features
*
* @author Arjen Poutsma
@@ -93,7 +93,7 @@ public abstract class AbstractXmlReader implements XMLReader {
}
/**
* Throws a <code>SAXNotRecognizedException</code> exception.
* Throws a {@code SAXNotRecognizedException} exception.
*
* @throws org.xml.sax.SAXNotRecognizedException
* always
@@ -104,7 +104,7 @@ public abstract class AbstractXmlReader implements XMLReader {
}
/**
* Throws a <code>SAXNotRecognizedException</code> exception.
* Throws a {@code SAXNotRecognizedException} exception.
*
* @throws SAXNotRecognizedException always
*/
@@ -114,8 +114,8 @@ public abstract class AbstractXmlReader implements XMLReader {
}
/**
* Throws a <code>SAXNotRecognizedException</code> exception when the given property does not signify a lexical
* handler. The property name for a lexical handler is <code>http://xml.org/sax/properties/lexical-handler</code>.
* Throws a {@code SAXNotRecognizedException} exception when the given property does not signify a lexical
* handler. The property name for a lexical handler is {@code http://xml.org/sax/properties/lexical-handler}.
*/
@Override
public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException {
@@ -128,8 +128,8 @@ public abstract class AbstractXmlReader implements XMLReader {
}
/**
* Throws a <code>SAXNotRecognizedException</code> exception when the given property does not signify a lexical
* handler. The property name for a lexical handler is <code>http://xml.org/sax/properties/lexical-handler</code>.
* Throws a {@code SAXNotRecognizedException} exception when the given property does not signify a lexical
* handler. The property name for a lexical handler is {@code http://xml.org/sax/properties/lexical-handler}.
*/
@Override
public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException {

6
spring-xml/src/main/java/org/springframework/xml/sax/SaxUtils.java
View File

@@ -37,8 +37,8 @@ public abstract class SaxUtils {
private static final Log logger = LogFactory.getLog(SaxUtils.class);
/**
* Creates a SAX <code>InputSource</code> from the given resource. Sets the system identifier to the resource's
* <code>URL</code>, if available.
* Creates a SAX {@code InputSource} from the given resource. Sets the system identifier to the resource's
* {@code URL}, if available.
*
* @param resource the resource
* @return the input source created from the resource
@@ -52,7 +52,7 @@ public abstract class SaxUtils {
return inputSource;
}
/** Retrieves the URL from the given resource as System ID. Returns <code>null</code> if it cannot be opened. */
/** Retrieves the URL from the given resource as System ID. Returns {@code null} if it cannot be opened. */
public static String getSystemId(Resource resource) {
try {
return new URI(resource.getURL().toExternalForm()).toString();

4
spring-xml/src/main/java/org/springframework/xml/transform/ResourceSource.java
View File

@@ -34,7 +34,7 @@ import org.xml.sax.XMLReader;
public class ResourceSource extends SAXSource {
/**
* Initializes a new instance of the <code>ResourceSource</code> with the given resource.
* Initializes a new instance of the {@code ResourceSource} with the given resource.
*
* @param content the content
*/
@@ -43,7 +43,7 @@ public class ResourceSource extends SAXSource {
}
/**
* Initializes a new instance of the <code>ResourceSource</code> with the given {@link XMLReader} and resource.
* Initializes a new instance of the {@code ResourceSource} with the given {@link XMLReader} and resource.
*
* @param content the content
*/

4
spring-xml/src/main/java/org/springframework/xml/transform/StringResult.java
View File

@@ -20,8 +20,8 @@ import java.io.StringWriter;
import javax.xml.transform.stream.StreamResult;
/**
* Convenient subclass of <code>StreamResult</code> that writes to a <code>StringWriter</code>. The resulting string can
* be retrieved via <code>toString()</code>.
* Convenient subclass of {@code StreamResult} that writes to a {@code StringWriter}. The resulting string can
* be retrieved via {@code toString()}.
*
* @author Arjen Poutsma
* @see #toString()

4
spring-xml/src/main/java/org/springframework/xml/transform/StringSource.java
View File

@@ -24,7 +24,7 @@ import javax.xml.transform.stream.StreamSource;
import org.springframework.util.Assert;
/**
* Convenient subclass of <code>StreamSource</code> that reads from a <code>StringReader</code>. The string to be read
* Convenient subclass of {@code StreamSource} that reads from a {@code StringReader}. The string to be read
* can be set via the constructor.
*
* @author Arjen Poutsma
@@ -35,7 +35,7 @@ public class StringSource extends StreamSource {
private final String content;
/**
* Initializes a new instance of the <code>StringSource</code> with the given string content.
* Initializes a new instance of the {@code StringSource} with the given string content.
*
* @param content the content
*/

8
spring-xml/src/main/java/org/springframework/xml/transform/TransformerHelper.java
View File

@@ -69,12 +69,12 @@ public class TransformerHelper {
/**
* Instantiate a new TransformerFactory.
* <p/>
* The default implementation simply calls {@link TransformerFactory#newInstance()}. If a {@link
*
* <p>The default implementation simply calls {@link TransformerFactory#newInstance()}. If a {@link
* #setTransformerFactoryClass transformerFactoryClass} has been specified explicitly, the default constructor of
* the specified class will be called instead.
* <p/>
* Can be overridden in subclasses.
*
* <p>Can be overridden in subclasses.
*
* @param transformerFactoryClass the specified factory class (if any)
* @return the new TransactionFactory instance

8
spring-xml/src/main/java/org/springframework/xml/transform/TransformerObjectSupport.java
View File

@@ -27,9 +27,9 @@ import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Convenient base class for objects that use a <code>Transformer</code>. Subclasses can call {@link
* Convenient base class for objects that use a {@code Transformer}. Subclasses can call {@link
* #createTransformer()} or {@link #transform(Source, Result)}. This should be done per thread (i.e. per incoming
* request), because <code>Transformer</code> instances are not thread-safe.
* request), because {@code Transformer} instances are not thread-safe.
*
* @author Arjen Poutsma
* @see Transformer
@@ -67,14 +67,14 @@ public abstract class TransformerObjectSupport {
}
/**
* Returns the <code>TransformerFactory</code>.
* Returns the {@code TransformerFactory}.
*/
protected TransformerFactory getTransformerFactory() {
return transformerHelper.getTransformerFactory();
}
/**
* Creates a new <code>Transformer</code>. Must be called per request, as transformers are not thread-safe.
* Creates a new {@code Transformer}. Must be called per request, as transformers are not thread-safe.
*
* @return the created transformer
* @throws TransformerConfigurationException

4
spring-xml/src/main/java/org/springframework/xml/validation/Jaxp13ValidatorFactory.java
View File

@@ -29,7 +29,7 @@ import org.xml.sax.SAXParseException;
import org.springframework.core.io.Resource;
/**
* Internal class that uses JAXP 1.0 features to create <code>XmlValidator</code> instances.
* Internal class that uses JAXP 1.0 features to create {@code XmlValidator} instances.
*
* @author Arjen Poutsma
* @since 1.0.0
@@ -76,7 +76,7 @@ abstract class Jaxp13ValidatorFactory {
}
}
/** <code>ErrorHandler</code> implementation that stores errors and fatal errors in a list. */
/** {@code ErrorHandler} implementation that stores errors and fatal errors in a list. */
private static class DefaultValidationErrorHandler implements ValidationErrorHandler {
private List<SAXParseException> errors = new ArrayList<SAXParseException>();

10
spring-xml/src/main/java/org/springframework/xml/validation/SchemaLoaderUtils.java
View File

@@ -41,8 +41,8 @@ public abstract class SchemaLoaderUtils {
* Load schema from the given resource.
*
* @param resource the resource to load from
* @param schemaLanguage the language of the schema. Can be <code>XMLConstants.W3C_XML_SCHEMA_NS_URI</code> or
* <code>XMLConstants.RELAXNG_NS_URI</code>.
* @param schemaLanguage the language of the schema. Can be {@code XMLConstants.W3C_XML_SCHEMA_NS_URI} or
* {@code XMLConstants.RELAXNG_NS_URI}.
* @throws IOException if loading failed
* @throws SAXException if loading failed
* @see javax.xml.XMLConstants#W3C_XML_SCHEMA_NS_URI
@@ -56,8 +56,8 @@ public abstract class SchemaLoaderUtils {
* Load schema from the given resource.
*
* @param resources the resources to load from
* @param schemaLanguage the language of the schema. Can be <code>XMLConstants.W3C_XML_SCHEMA_NS_URI</code> or
* <code>XMLConstants.RELAXNG_NS_URI</code>.
* @param schemaLanguage the language of the schema. Can be {@code XMLConstants.W3C_XML_SCHEMA_NS_URI} or
* {@code XMLConstants.RELAXNG_NS_URI}.
* @throws IOException if loading failed
* @throws SAXException if loading failed
* @see javax.xml.XMLConstants#W3C_XML_SCHEMA_NS_URI
@@ -78,7 +78,7 @@ public abstract class SchemaLoaderUtils {
return schemaFactory.newSchema(schemaSources);
}
/** Retrieves the URL from the given resource as System ID. Returns <code>null</code> if it cannot be opened. */
/** Retrieves the URL from the given resource as System ID. Returns {@code null} if it cannot be opened. */
public static String getSystemId(Resource resource) {
try {
return resource.getURL().toString();

16
spring-xml/src/main/java/org/springframework/xml/validation/XmlValidator.java
View File

@@ -23,8 +23,8 @@ import org.xml.sax.SAXParseException;
/**
* Simple processor that validates a given {@link Source}. Can be created via the {@link XmlValidatorFactory}.
* <p/>
* Instances of this class are designed to be thread safe.
*
* <p>Instances of this class are designed to be thread safe.
*
* @author Arjen Poutsma
* @see XmlValidatorFactory#createValidator(org.springframework.core.io.Resource, String)
@@ -37,9 +37,9 @@ public interface XmlValidator {
* be empty if no validation errors are found.
*
* @param source the input document
* @return an array of <code>SAXParseException</code>s
* @throws IOException if the <code>source</code> cannot be read
* @throws XmlValidationException if the <code>source</code> cannot be validated
* @return an array of {@code SAXParseException}s
* @throws IOException if the {@code source} cannot be read
* @throws XmlValidationException if the {@code source} cannot be validated
*/
SAXParseException[] validate(Source source) throws IOException;
@@ -49,9 +49,9 @@ public interface XmlValidator {
*
* @param source the input document
* @param errorHandler the error handler to use. May be {@code null}, in which case a default will be used.
* @return an array of <code>SAXParseException</code>s
* @throws IOException if the <code>source</code> cannot be read
* @throws XmlValidationException if the <code>source</code> cannot be validated
* @return an array of {@code SAXParseException}s
* @throws IOException if the {@code source} cannot be read
* @throws XmlValidationException if the {@code source} cannot be validated
*/
SAXParseException[] validate(Source source, ValidationErrorHandler errorHandler) throws IOException;

14
spring-xml/src/main/java/org/springframework/xml/validation/XmlValidatorFactory.java
View File

@@ -28,9 +28,9 @@ import org.apache.commons.logging.LogFactory;
/**
* Factory for {@link XmlValidator} objects, being aware of JAXP 1.3 {@link Validator}s, and JAXP 1.0 parsing
* capababilities. Mainly for internal use within the framework.
* <p/>
* The goal of this class is to avoid runtime dependencies on JAXP 1.3 by using the best validation implementation that
* capabilities. Mainly for internal use within the framework.
*
* <p>The goal of this class is to avoid runtime dependencies on JAXP 1.3 by using the best validation implementation that
* is available. Prefers JAXP 1.3 {@link XmlValidator} implementations to a custom, SAX-based implementation.
*
* @author Arjen Poutsma
@@ -49,7 +49,7 @@ public abstract class XmlValidatorFactory {
/**
* Create a {@link XmlValidator} with the given schema resource and schema language type. The schema language must
* be one of the <code>SCHEMA_XXX</code> constants.
* be one of the {@code SCHEMA_XXX} constants.
*
* @param schemaResource a resource that locates the schema to validate against
* @param schemaLanguage the language of the schema
@@ -57,7 +57,7 @@ public abstract class XmlValidatorFactory {
* @throws IOException if the schema resource cannot be read
* @throws IllegalArgumentException if the schema language is not supported
* @throws IllegalStateException if JAXP 1.0 cannot be located
* @throws XmlValidationException if a <code>XmlValidator</code> cannot be created
* @throws XmlValidationException if a {@code XmlValidator} cannot be created
* @see #SCHEMA_RELAX_NG
* @see #SCHEMA_W3C_XML
*/
@@ -67,7 +67,7 @@ public abstract class XmlValidatorFactory {
/**
* Create a {@link XmlValidator} with the given schema resources and schema language type. The schema language must
* be one of the <code>SCHEMA_XXX</code> constants.
* be one of the {@code SCHEMA_XXX} constants.
*
* @param schemaResources an array of resource that locate the schemas to validate against
* @param schemaLanguage the language of the schemas
@@ -75,7 +75,7 @@ public abstract class XmlValidatorFactory {
* @throws IOException if the schema resource cannot be read
* @throws IllegalArgumentException if the schema language is not supported
* @throws IllegalStateException if JAXP 1.0 cannot be located
* @throws XmlValidationException if a <code>XmlValidator</code> cannot be created
* @throws XmlValidationException if a {@code XmlValidator} cannot be created
* @see #SCHEMA_RELAX_NG
* @see #SCHEMA_W3C_XML
*/

12
spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathExpressionFactory.java
View File

@@ -28,7 +28,7 @@ import org.w3c.dom.DOMException;
import org.w3c.dom.Node;
/**
* Jaxen-specific factory for creating <code>XPathExpression</code>s.
* Jaxen-specific factory for creating {@code XPathExpression}s.
*
* @author Arjen Poutsma
* @see #createXPathExpression(String)
@@ -37,10 +37,10 @@ import org.w3c.dom.Node;
abstract class JaxenXPathExpressionFactory {
/**
* Creates a Jaxen <code>XPathExpression</code> from the given string expression.
* Creates a Jaxen {@code XPathExpression} from the given string expression.
*
* @param expression the XPath expression
* @return the compiled <code>XPathExpression</code>
* @return the compiled {@code XPathExpression}
* @throws XPathParseException when the given expression cannot be parsed
*/
static XPathExpression createXPathExpression(String expression) {
@@ -55,11 +55,11 @@ abstract class JaxenXPathExpressionFactory {
}
/**
* Creates a Jaxen <code>XPathExpression</code> from the given string expression and prefixes.
* Creates a Jaxen {@code XPathExpression} from the given string expression and prefixes.
*
* @param expression the XPath expression
* @param namespaces the namespaces
* @return the compiled <code>XPathExpression</code>
* @return the compiled {@code XPathExpression}
* @throws XPathParseException when the given expression cannot be parsed
*/
public static XPathExpression createXPathExpression(String expression, Map<String, String> namespaces) {
@@ -74,7 +74,7 @@ abstract class JaxenXPathExpressionFactory {
}
}
/** Jaxen implementation of the <code>XPathExpression</code> interface. */
/** Jaxen implementation of the {@code XPathExpression} interface. */
private static class JaxenXpathExpression implements XPathExpression {
private XPath xpath;

4
spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathTemplate.java
View File

@@ -31,8 +31,8 @@ import org.w3c.dom.Node;
/**
* Implementation of {@link XPathOperations} that uses Jaxen.
* <p/>
* Namespaces can be set using the <code>namespaces</code> property.
*
* <p>Namespaces can be set using the {@code namespaces} property.
*
* @author Arjen Poutsma
* @see <a href="http://www.jaxen.org/">Jaxen</a>

10
spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathExpressionFactory.java
View File

@@ -43,10 +43,10 @@ abstract class Jaxp13XPathExpressionFactory {
private static XPathFactory xpathFactory = XPathFactory.newInstance();
/**
* Creates a JAXP 1.3 <code>XPathExpression</code> from the given string expression.
* Creates a JAXP 1.3 {@code XPathExpression} from the given string expression.
*
* @param expression the XPath expression
* @return the compiled <code>XPathExpression</code>
* @return the compiled {@code XPathExpression}
* @throws XPathParseException when the given expression cannot be parsed
*/
static XPathExpression createXPathExpression(String expression) {
@@ -62,11 +62,11 @@ abstract class Jaxp13XPathExpressionFactory {
}
/**
* Creates a JAXP 1.3 <code>XPathExpression</code> from the given string expression and namespaces.
* Creates a JAXP 1.3 {@code XPathExpression} from the given string expression and namespaces.
*
* @param expression the XPath expression
* @param namespaces the namespaces
* @return the compiled <code>XPathExpression</code>
* @return the compiled {@code XPathExpression}
* @throws XPathParseException when the given expression cannot be parsed
*/
public static XPathExpression createXPathExpression(String expression, Map<String, String> namespaces) {
@@ -89,7 +89,7 @@ abstract class Jaxp13XPathExpressionFactory {
}
/** JAXP 1.3 implementation of the <code>XPathExpression</code> interface. */
/** JAXP 1.3 implementation of the {@code XPathExpression} interface. */
private static class Jaxp13XPathExpression implements XPathExpression {
private final javax.xml.xpath.XPathExpression xpathExpression;

4
spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathTemplate.java
View File

@@ -48,8 +48,8 @@ import org.springframework.xml.transform.TraxUtils;
/**
* Implementation of {@link XPathOperations} that uses JAXP 1.3. JAXP 1.3 is part of Java SE since 1.5.
* <p/>
* Namespaces can be set using the {@code namespaces} property.
*
* <p>Namespaces can be set using the {@code namespaces} property.
*
* @author Arjen Poutsma
* @see #setNamespaces(java.util.Map)

4
spring-xml/src/main/java/org/springframework/xml/xpath/NodeCallbackHandler.java
View File

@@ -23,8 +23,8 @@ import org.w3c.dom.Node;
* An interface used by {@link XPathOperations} implementations for processing {@link Node} objects on a per-node basis.
* Implementations of this interface perform the actual work of processing nodes, but don't need to worry about
* exception handling.
* <p/>
* Consider using a {@link NodeMapper} instead if you need to map exactly result object per node, assembling them in a
*
* <p>Consider using a {@link NodeMapper} instead if you need to map exactly result object per node, assembling them in a
* List.
*
* @author Arjen Poutsma

4
spring-xml/src/main/java/org/springframework/xml/xpath/XPathException.java
View File

@@ -27,7 +27,7 @@ import org.springframework.xml.XmlException;
public class XPathException extends XmlException {
/**
* Constructs a new instance of the <code>XPathException</code> with the specific detail message.
* Constructs a new instance of the {@code XPathException} with the specific detail message.
*
* @param message the detail message
*/
@@ -36,7 +36,7 @@ public class XPathException extends XmlException {
}
/**
* Constructs a new instance of the <code>XPathException</code> with the specific detail message and exception.
* Constructs a new instance of the {@code XPathException} with the specific detail message and exception.
*
* @param message the detail message
* @param throwable the wrapped exception

28
spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpression.java
View File

@@ -23,8 +23,8 @@ import org.w3c.dom.Node;
/**
* Defines the contract for a precompiled XPath expression. Concrete instances can be obtained through the {@link
* XPathExpressionFactory}.
* <p/>
* Implementations of this interface are precompiled, and thus faster, but less flexible, than the XPath expressions
*
* <p>Implementations of this interface are precompiled, and thus faster, but less flexible, than the XPath expressions
* used by {@link XPathOperations} implementations.
*
* @author Arjen Poutsma
@@ -33,10 +33,10 @@ import org.w3c.dom.Node;
public interface XPathExpression {
/**
* Evaluates the given expression as a <code>boolean</code>. Returns the boolean evaluation of the expression, or
* <code>false</code> if it is invalid.
* <p/>
* The return value is determined per the {@code boolean()} function defined in the XPath specification.
* Evaluates the given expression as a {@code boolean}. Returns the boolean evaluation of the expression, or
* {@code false} if it is invalid.
*
* <p>The return value is determined per the {@code boolean()} function defined in the XPath specification.
* This means that an expression that selects zero nodes will return {@code false}, while an expression that
* selects one or more nodes will return {@code true}.
* An expression that returns a string returns {@code false} for empty strings and {@code true} for all other
@@ -51,7 +51,7 @@ public interface XPathExpression {
boolean evaluateAsBoolean(Node node) throws XPathException;
/**
* Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or <code>null</code>
* Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or {@code null}
* if it is invalid.
*
* @param node the starting point
@@ -66,17 +66,17 @@ public interface XPathExpression {
* no result could be found.
*
* @param node the starting point
* @return a list of <code>Node</code>s that are selected by the expression
* @return a list of {@code Node}s that are selected by the expression
* @throws XPathException in case of XPath errors
* @see <a href="http://www.w3.org/TR/xpath#node-sets">XPath specification</a>
*/
List<Node> evaluateAsNodeList(Node node) throws XPathException;
/**
* Evaluates the given expression as a number (<code>double</code>). Returns the numeric evaluation of the
* Evaluates the given expression as a number ({@code double}). Returns the numeric evaluation of the
* expression, or {@link Double#NaN} if it is invalid.
* <p/>
* The return value is determined per the {@code number()} function as defined in the XPath specification.
*
* <p>The return value is determined per the {@code number()} function as defined in the XPath specification.
* This means that if the expression selects multiple nodes, it will return the number value of the first node.
*
* @param node the starting point
@@ -87,9 +87,9 @@ public interface XPathExpression {
double evaluateAsNumber(Node node) throws XPathException;
/**
* Evaluates the given expression as a String. Returns <code>null</code> if no result could be found.
* <p/>
* The return value is determined per the {@code string()} function as defined in the XPath specification.
* Evaluates the given expression as a String. Returns {@code null} if no result could be found.
*
* <p>The return value is determined per the {@code string()} function as defined in the XPath specification.
* This means that if the expression selects multiple nodes, it will return the string value of the first node.
*
* @param node the starting point

6
spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactory.java
View File

@@ -25,10 +25,10 @@ import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Factory for compiled <code>XPathExpression</code>s, being aware of JAXP 1.3+ XPath functionality, and Jaxen. Mainly
* Factory for compiled {@code XPathExpression}s, being aware of JAXP 1.3+ XPath functionality, and Jaxen. Mainly
* for internal use of the framework.
* <p/>
* The goal of this class is to avoid runtime dependencies a specific XPath engine, simply using the best XPath
*
* <p>The goal of this class is to avoid runtime dependencies a specific XPath engine, simply using the best XPath
* implementation that is available. Prefers JAXP 1.3+ XPath implementations to Jaxen.
*
* @author Arjen Poutsma

4
spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactoryBean.java
View File

@@ -26,8 +26,8 @@ import org.springframework.util.CollectionUtils;
/**
* Spring {@link FactoryBean} for {@link XPathExpression} object. Facilitates injection of XPath expressions into
* endpoint beans.
* <p/>
* Uses {@link XPathExpressionFactory} underneath, so support is provided for JAXP 1.3, and Jaxen XPaths.
*
* <p>Uses {@link XPathExpressionFactory} underneath, so support is provided for JAXP 1.3, and Jaxen XPaths.
*
* @author Arjen Poutsma
* @see #setExpression(String)

26
spring-xml/src/main/java/org/springframework/xml/xpath/XPathOperations.java
View File

@@ -24,8 +24,8 @@ import org.w3c.dom.Node;
/**
* Interface that specifies a basic set of XPath operations, implemented by various XPathTemplates. Contains numerous
* evaluation methods,
* <p/>
* The templates that implement this interface do not use precompiled XPath expressions. Consider using the {@link
*
* <p>The templates that implement this interface do not use precompiled XPath expressions. Consider using the {@link
* XPathExpressionFactory} or the {@link XPathExpressionFactoryBean} for optimal performance, but less flexibility.
*
* @author Arjen Poutsma
@@ -36,10 +36,10 @@ import org.w3c.dom.Node;
public interface XPathOperations {
/**
* Evaluates the given expression as a <code>boolean</code>. Returns the boolean evaluation of the expression, or
* <code>false</code> if it is invalid.
* <p/>
* The return value is determined per the {@code boolean()} function defined in the XPath specification.
* Evaluates the given expression as a {@code boolean}. Returns the boolean evaluation of the expression, or
* {@code false} if it is invalid.
*
* <p>The return value is determined per the {@code boolean()} function defined in the XPath specification.
* This means that an expression that selects zero nodes will return {@code false}, while an expression that
* selects one or more nodes will return {@code true}.
* An expression that returns a string returns {@code false} for empty strings and {@code true} for all other
@@ -55,7 +55,7 @@ public interface XPathOperations {
boolean evaluateAsBoolean(String expression, Source context) throws XPathException;
/**
* Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or <code>null</code>
* Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or {@code null}
* if it is invalid.
*
* @param expression the XPath expression
@@ -79,10 +79,10 @@ public interface XPathOperations {
List<Node> evaluateAsNodeList(String expression, Source context) throws XPathException;
/**
* Evaluates the given expression as a <code>double</code>. Returns the evaluation of the expression, or {@link
* Evaluates the given expression as a {@code double}. Returns the evaluation of the expression, or {@link
* Double#NaN} if it is invalid.
* <p/>
* The return value is determined per the {@code number()} function as defined in the XPath specification.
*
* <p>The return value is determined per the {@code number()} function as defined in the XPath specification.
* This means that if the expression selects multiple nodes, it will return the number value of the first node.
*
* @param expression the XPath expression
@@ -95,9 +95,9 @@ public interface XPathOperations {
/**
* Evaluates the given expression as a {@link String}. Returns the evaluation of the expression, or
* <code>null</code> if it is invalid.
* <p/>
* The return value is determined per the {@code string()} function as defined in the XPath specification.
* {@code null} if it is invalid.
*
* <p>The return value is determined per the {@code string()} function as defined in the XPath specification.
* This means that if the expression selects multiple nodes, it will return the string value of the first node.
*
* @param expression the XPath expression

4
spring-xml/src/main/java/org/springframework/xml/xpath/XPathParseException.java
View File

@@ -25,7 +25,7 @@ package org.springframework.xml.xpath;
public class XPathParseException extends XPathException {
/**
* Constructs a new instance of the <code>XPathParseException</code> with the specific detail message.
* Constructs a new instance of the {@code XPathParseException} with the specific detail message.
*
* @param message the detail message
*/
@@ -34,7 +34,7 @@ public class XPathParseException extends XPathException {
}
/**
* Constructs a new instance of the <code>XPathParseException</code> with the specific detail message and
* Constructs a new instance of the {@code XPathParseException} with the specific detail message and
* exception.
*
* @param message the detail message

12
spring-xml/src/main/java/org/springframework/xml/xsd/SimpleXsdSchema.java
View File

@@ -38,8 +38,8 @@ import org.springframework.xml.validation.XmlValidatorFactory;
/**
* The default {@link XsdSchema} implementation.
* <p/>
* Allows a XSD to be set by the {@link #setXsd(Resource)}, or directly in the {@link #SimpleXsdSchema(Resource)
*
* <p>Allows a XSD to be set by the {@link #setXsd(Resource)}, or directly in the {@link #SimpleXsdSchema(Resource)
* constructor}.
*
* @author Mark LaFond
@@ -64,8 +64,8 @@ public class SimpleXsdSchema implements XsdSchema, InitializingBean {
/**
* Create a new instance of the {@link SimpleXsdSchema} class.
* <p/>
* A subsequent call to the {@link #setXsd(Resource)} method is required.
*
* <p>A subsequent call to the {@link #setXsd(Resource)} method is required.
*/
public SimpleXsdSchema() {
}
@@ -73,8 +73,8 @@ public class SimpleXsdSchema implements XsdSchema, InitializingBean {
/**
* Create a new instance of the {@link SimpleXsdSchema} class with the specified resource.
*
* @param xsdResource the XSD resource; must not be <code>null</code>
* @throws IllegalArgumentException if the supplied <code>xsdResource</code> is <code>null</code>
* @param xsdResource the XSD resource; must not be {@code null}
* @throws IllegalArgumentException if the supplied {@code xsdResource} is {@code null}
*/
public SimpleXsdSchema(Resource xsdResource) {
Assert.notNull(xsdResource, "xsdResource must not be null");

12
spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchema.java
View File

@@ -57,8 +57,8 @@ public class CommonsXsdSchema implements XsdSchema {
/**
* Create a new instance of the {@code CommonsXsdSchema} class with the specified {@link XmlSchema} reference.
*
* @param schema the Commons <code>XmlSchema</code> object; must not be <code>null</code>
* @throws IllegalArgumentException if the supplied <code>schema</code> is <code>null</code>
* @param schema the Commons {@code XmlSchema} object; must not be {@code null}
* @throws IllegalArgumentException if the supplied {@code schema} is {@code null}
*/
protected CommonsXsdSchema(XmlSchema schema) {
this(schema, null);
@@ -68,9 +68,9 @@ public class CommonsXsdSchema implements XsdSchema {
* Create a new instance of the {@code CommonsXsdSchema} class with the specified {@link XmlSchema} and {@link
* XmlSchemaCollection} reference.
*
* @param schema the Commons <code>XmlSchema</code> object; must not be <code>null</code>
* @param collection the Commons <code>XmlSchemaCollection</code> object; can be <code>null</code>
* @throws IllegalArgumentException if the supplied <code>schema</code> is <code>null</code>
* @param schema the Commons {@code XmlSchema} object; must not be {@code null}
* @param collection the Commons {@code XmlSchemaCollection} object; can be {@code null}
* @throws IllegalArgumentException if the supplied {@code schema} is {@code null}
*/
protected CommonsXsdSchema(XmlSchema schema, XmlSchemaCollection collection) {
Assert.notNull(schema, "'schema' must not be null");
@@ -128,7 +128,7 @@ public class CommonsXsdSchema implements XsdSchema {
}
}
/** Returns the wrapped Commons <code>XmlSchema</code> object. */
/** Returns the wrapped Commons {@code XmlSchema} object. */
public XmlSchema getSchema() {
return schema;
}

20
spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchemaCollection.java
View File

@@ -49,8 +49,8 @@ import org.springframework.xml.xsd.XsdSchemaCollection;
/**
* Implementation of the {@link XsdSchemaCollection} that uses Apache WS-Commons XML Schema.
* <p/>
* Setting the {@link #setInline(boolean) inline} flag to <code>true</code> will result in all referenced schemas
*
* <p>Setting the {@link #setInline(boolean) inline} flag to {@code true} will result in all referenced schemas
* (included and imported) being merged into the referred schema. When including the schemas into a WSDL, this greatly
* simplifies the deployment of the schemas.
*
@@ -75,15 +75,15 @@ public class CommonsXsdSchemaCollection implements XsdSchemaCollection, Initiali
private ResourceLoader resourceLoader;
/**
* Constructs a new, empty instance of the <code>CommonsXsdSchemaCollection</code>.
* <p/>
* A subsequent call to the {@link #setXsds(Resource[])} is required.
* Constructs a new, empty instance of the {@code CommonsXsdSchemaCollection}.
*
* <p>A subsequent call to the {@link #setXsds(Resource[])} is required.
*/
public CommonsXsdSchemaCollection() {
}
/**
* Constructs a new instance of the <code>CommonsXsdSchemaCollection</code> based on the given resources.
* Constructs a new instance of the {@code CommonsXsdSchemaCollection} based on the given resources.
*
* @param resources the schema resources to load
*/
@@ -102,8 +102,8 @@ public class CommonsXsdSchemaCollection implements XsdSchemaCollection, Initiali
/**
* Defines whether included schemas should be inlined into the including schema.
* <p/>
* Defaults to <code>false</code>.
*
* <p>Defaults to {@code false}.
*/
public void setInline(boolean inline) {
this.inline = inline;
@@ -111,8 +111,8 @@ public class CommonsXsdSchemaCollection implements XsdSchemaCollection, Initiali
/**
* Sets the WS-Commons uri resolver to use when resolving (relative) schemas.
* <p/>
* Default is an internal subclass of {@link DefaultURIResolver} which correctly handles schemas on the classpath.
*
* <p>Default is an internal subclass of {@link DefaultURIResolver} which correctly handles schemas on the classpath.
*/
public void setUriResolver(URIResolver uriResolver) {
Assert.notNull(uriResolver, "'uriResolver' must not be null");