[java-opensaml] branch master updated: JPAR-131 - Fix doclint issues in test javadoc
Ian Young
ian at iay.org.uk
Fri Dec 20 13:39:13 EST 2019
This is an automated email from the git hooks/post-receive script.
iay pushed a commit to branch master
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=83885357193eb73f6009a9a4a36203d036b7dd8e
The following commit(s) were added to refs/heads/master by this push:
new 8388535 JPAR-131 - Fix doclint issues in test javadoc
8388535 is described below
commit 83885357193eb73f6009a9a4a36203d036b7dd8e
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Fri Dec 20 18:39:04 2019 +0000
JPAR-131 - Fix doclint issues in test javadoc
https://issues.shibboleth.net/jira/browse/JPAR-131
---
.../org/opensaml/core/config/Configuration.java | 2 +-
.../opensaml/core/config/ConfigurationService.java | 2 +-
.../config/provider/MapBasedConfiguration.java | 2 +-
.../opensaml/core/xml/util/XMLObjectSupport.java | 8 +++---
.../opensaml/core/OpenSAMLInitBaseTestCase.java | 2 +-
...ilesystemConfigurationPropertiesSourceTest.java | 7 +++--
.../opensaml/core/xml/AbstractXMLObjectTest.java | 12 ++++-----
.../org/opensaml/core/xml/ElementProxyTest.java | 5 +++-
.../org/opensaml/core/xml/IDAttributeTest.java | 4 +--
.../org/opensaml/core/xml/MarshallingTest.java | 23 ++++++++---------
.../opensaml/core/xml/NamespaceManagerTest.java | 2 --
.../core/xml/UnmarshallingSecurityTest.java | 25 +++++++++---------
.../org/opensaml/core/xml/UnmarshallingTest.java | 23 ++++++++---------
.../opensaml/core/xml/XMLObjectBaseTestCase.java | 18 ++++++++++++-
.../core/xml/config/ConfigurationTest.java | 4 +++
.../opensaml/core/xml/mock/SimpleXMLObject.java | 4 +++
.../core/xml/schema/XSBase64BinaryTest.java | 8 +++---
.../opensaml/core/xml/schema/XSBooleanTest.java | 10 ++++----
.../opensaml/core/xml/schema/XSDateTimeTest.java | 16 ++++++------
.../opensaml/core/xml/schema/XSIntegerTest.java | 11 ++++----
.../org/opensaml/core/xml/schema/XSQNameTest.java | 11 ++++----
.../org/opensaml/core/xml/schema/XSStringTest.java | 11 ++++----
.../org/opensaml/core/xml/schema/XSURITest.java | 11 ++++----
.../handler/AbstractMessageHandlerTest.java | 30 ++++++++++++++++++----
.../impl/HTTPRequestValidationHandlerTest.java | 12 ++++++---
.../handler/impl/SchemaValidateXMLMessageTest.java | 26 +++++++++++++++----
26 files changed, 179 insertions(+), 110 deletions(-)
diff --git a/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java b/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java
index d46f2a6..2c18237 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java
@@ -44,7 +44,7 @@ public interface Configuration {
* Register a configuration instance.
*
* @param <T> the type of configuration being registered, typically an interface
- * @param <I> the configuration implementation being registered, which will be an instance of {@link T}
+ * @param <I> the configuration implementation being registered, which will be an instance of {@code T}
*
* @param configClass the type of configuration class being registered, typically an interface
* @param configInstance the configuration implementation instance being registered
diff --git a/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java b/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java
index 07f6233..5cb71b1 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java
@@ -91,7 +91,7 @@ public class ConfigurationService {
* Register a configuration instance.
*
* @param <T> the type of configuration being registered
- * @param <I> the configuration object instance type being registered, which must be an instance of {@link T}
+ * @param <I> the configuration object instance type being registered, which must be an instance of {@code T}
*
* @param configClass the type of configuration being registered
* @param configInstance the configuration object instance being registered
diff --git a/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java b/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java
index d04e0e7..d5dc369 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java
@@ -55,7 +55,7 @@ public class MapBasedConfiguration implements Configuration {
* Register a configuration instance.
*
* @param <T> the type of configuration being registered, typically an interface
- * @param <I> the configuration implementation being registered, which will be an instance of {@link T}
+ * @param <I> the configuration implementation being registered, which will be an instance of {@code T}
*
* @param configClass the type of configuration class being registered, typically an interface
* @param configuration the configuration implementation instance being registered
diff --git a/opensaml-core/src/main/java/org/opensaml/core/xml/util/XMLObjectSupport.java b/opensaml-core/src/main/java/org/opensaml/core/xml/util/XMLObjectSupport.java
index f2d04b6..3dafe62 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/xml/util/XMLObjectSupport.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/xml/util/XMLObjectSupport.java
@@ -93,12 +93,12 @@ public final class XMLObjectSupport {
*
*
* @param originalXMLObject the object to be cloned
+ * @param <T> the type of object being cloned
+ *
* @return a clone of the original object
*
* @throws MarshallingException if original object can not be marshalled
* @throws UnmarshallingException if cloned object tree can not be unmarshalled
- *
- * @param <T> the type of object being cloned
*/
public static <T extends XMLObject> T cloneXMLObject(final T originalXMLObject)
throws MarshallingException, UnmarshallingException {
@@ -116,12 +116,12 @@ public final class XMLObjectSupport {
*
* @param originalXMLObject the object to be cloned
* @param cloneOutputOption the option for handling the cloned object output
+ * @param <T> the type of object being cloned
+ *
* @return a clone of the original object
*
* @throws MarshallingException if original object can not be marshalled
* @throws UnmarshallingException if cloned object tree can not be unmarshalled
- *
- * @param <T> the type of object being cloned
*/
@Nullable public static <T extends XMLObject> T cloneXMLObject(@Nullable final T originalXMLObject,
@Nonnull final CloneOutputOption cloneOutputOption) throws MarshallingException, UnmarshallingException {
diff --git a/opensaml-core/src/test/java/org/opensaml/core/OpenSAMLInitBaseTestCase.java b/opensaml-core/src/test/java/org/opensaml/core/OpenSAMLInitBaseTestCase.java
index 27b2064..913f492 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/OpenSAMLInitBaseTestCase.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/OpenSAMLInitBaseTestCase.java
@@ -29,7 +29,7 @@ public abstract class OpenSAMLInitBaseTestCase {
/**
* Initialize OpenSAML.
*
- * @throws InitializationException
+ * @throws InitializationException ...
*/
@BeforeSuite(groups={"opensaml.init"})
public void initOpenSAML() throws InitializationException {
diff --git a/opensaml-core/src/test/java/org/opensaml/core/config/provider/FilesystemConfigurationPropertiesSourceTest.java b/opensaml-core/src/test/java/org/opensaml/core/config/provider/FilesystemConfigurationPropertiesSourceTest.java
index aef7ec3..2d5acb8 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/config/provider/FilesystemConfigurationPropertiesSourceTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/config/provider/FilesystemConfigurationPropertiesSourceTest.java
@@ -43,8 +43,11 @@ public class FilesystemConfigurationPropertiesSourceTest {
/** Actual target file test runs against. */
private File targetFile;
- /** Constructor.
- * @throws IOException */
+ /**
+ * Constructor.
+ *
+ * @throws IOException ...
+ */
public FilesystemConfigurationPropertiesSourceTest() throws IOException {
masterFile = new File("src/test/resources/opensaml-config.properties");
targetFile = File.createTempFile("opensaml-config.properties", "");
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/AbstractXMLObjectTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/AbstractXMLObjectTest.java
index adfcddb..0fa2c34 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/AbstractXMLObjectTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/AbstractXMLObjectTest.java
@@ -37,8 +37,8 @@ public class AbstractXMLObjectTest extends XMLObjectBaseTestCase {
/**
* Tests of DOM and XMLObjectSource drop.
*
- * @throws MarshallingException
- * @throws IOException
+ * @throws MarshallingException ...
+ * @throws IOException ...
*/
@Test
public void testDOMAndXMLObjectSourceDropOnMutateContent() throws MarshallingException, IOException {
@@ -63,8 +63,8 @@ public class AbstractXMLObjectTest extends XMLObjectBaseTestCase {
/**
* Tests of DOM and XMLObjectSource drop.
*
- * @throws MarshallingException
- * @throws IOException
+ * @throws MarshallingException ...
+ * @throws IOException ...
*/
@Test
public void testDOMAndXMLObjectSourceDropOnMutateAttribute() throws MarshallingException, IOException {
@@ -90,8 +90,8 @@ public class AbstractXMLObjectTest extends XMLObjectBaseTestCase {
/**
* Tests of DOM and XMLObjectSource drop.
*
- * @throws MarshallingException
- * @throws IOException
+ * @throws MarshallingException ...
+ * @throws IOException ...
*/
@Test
public void testDOMAndXMLObjectSourceDropOnMutateChildElements() throws MarshallingException, IOException {
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/ElementProxyTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/ElementProxyTest.java
index f5b27f5..dce9c1b 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/ElementProxyTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/ElementProxyTest.java
@@ -33,6 +33,9 @@ public class ElementProxyTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling unknown content into the element proxy.
+ *
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallUnknownContent() throws XMLParserException, UnmarshallingException{
@@ -47,4 +50,4 @@ public class ElementProxyTest extends XMLObjectBaseTestCase {
Assert.assertEquals(((XSAny) xmlobject.getOrderedChildren().get(1).getOrderedChildren().get(0)).getTextContent(),
"<strong>XSLT Perfect IDE</strong>", "Unexpected CDATA content");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/IDAttributeTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/IDAttributeTest.java
index 29834d2..c8f1b34 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/IDAttributeTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/IDAttributeTest.java
@@ -300,8 +300,8 @@ public class IDAttributeTest extends XMLObjectBaseTestCase {
/**
* Tests that attributes registered globally on {@link org.opensaml.core.xml.config.XMLObjectProviderRegistrySupport} are being
* handled properly in the AttributeMap.
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testGlobalIDRegistration() throws XMLParserException, UnmarshallingException {
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/MarshallingTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/MarshallingTest.java
index 5b803e1..df49423 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/MarshallingTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/MarshallingTest.java
@@ -50,8 +50,7 @@ public class MarshallingTest extends XMLObjectBaseTestCase {
/**
* Tests marshalling an object that has DOM Attrs.
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
*/
@Test
public void testMarshallingWithAttributes() throws XMLParserException {
@@ -71,7 +70,7 @@ public class MarshallingTest extends XMLObjectBaseTestCase {
/**
* Tests marshalling an object that has DOM Element textual content.
*
- * @throws XMLParserException
+ * @throws XMLParserException ...
*/
@Test
public void testMarshallingWithElementContent() throws XMLParserException {
@@ -105,8 +104,8 @@ public class MarshallingTest extends XMLObjectBaseTestCase {
/**
* Tests marshalling an object that has DOM Element children
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
+ * @throws MarshallingException ...
*/
@Test
public void testMarshallingWithChildElements() throws XMLParserException, MarshallingException {
@@ -128,8 +127,8 @@ public class MarshallingTest extends XMLObjectBaseTestCase {
/**
* Tests marshalling a fragment of an already marshalled tree into an existing, but different, DOM tree.
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
+ * @throws MarshallingException ...
*/
@Test
public void testMarshallingXMLFragment() throws XMLParserException, MarshallingException {
@@ -162,8 +161,8 @@ public class MarshallingTest extends XMLObjectBaseTestCase {
* Tests marshalling into an existing new empty document. Marshalled DOM should become the
* new root element of the document.
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
+ * @throws MarshallingException ...
*/
@Test
public void testMarshallingExistingEmptyDocument() throws XMLParserException, MarshallingException {
@@ -182,8 +181,8 @@ public class MarshallingTest extends XMLObjectBaseTestCase {
* Tests marshalling into an existing document which already has a document root element. Existing
* root element should be replaced.
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
+ * @throws MarshallingException ...
*/
@Test
public void testMarshallingReplaceDocumentRoot() throws XMLParserException, MarshallingException {
@@ -199,4 +198,4 @@ public class MarshallingTest extends XMLObjectBaseTestCase {
Assert.assertFalse(document.getDocumentElement().isSameNode(element), "Document root should have been replaced");
Assert.assertTrue(document.getDocumentElement().isSameNode(sxo.getDOM()), "Incorrect document root");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/NamespaceManagerTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/NamespaceManagerTest.java
index fdbe785..19b73da 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/NamespaceManagerTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/NamespaceManagerTest.java
@@ -224,8 +224,6 @@ public class NamespaceManagerTest extends XMLObjectBaseTestCase {
}
- /**********************/
-
private void checkPrefixes(NamespaceManager manager, String ... controlPrefixes) {
Set<String> nonVisiblePrefixes = manager.getNonVisibleNamespacePrefixes();
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingSecurityTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingSecurityTest.java
index 5721e48..db597cb 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingSecurityTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingSecurityTest.java
@@ -17,7 +17,6 @@
package org.opensaml.core.xml;
-import org.opensaml.core.xml.io.MarshallingException;
import org.opensaml.core.xml.io.Unmarshaller;
import org.opensaml.core.xml.io.UnmarshallingException;
import org.opensaml.core.xml.mock.SimpleXMLObject;
@@ -51,8 +50,8 @@ public class UnmarshallingSecurityTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with comment in content with default parser.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallingWithCommentInElementContentDefaults() throws XMLParserException, UnmarshallingException {
@@ -68,8 +67,8 @@ public class UnmarshallingSecurityTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with comment in content with insecure parser.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test(expectedExceptions=UnmarshallingException.class)
public void testUnmarshallingWithCommentInElementContentInsecure() throws XMLParserException, UnmarshallingException {
@@ -83,8 +82,8 @@ public class UnmarshallingSecurityTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with CDATA in content with default parser.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallingWithCDATAInElementContentDefaults() throws XMLParserException, UnmarshallingException {
@@ -100,8 +99,8 @@ public class UnmarshallingSecurityTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with CDATA in content with insecure parser.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test(expectedExceptions=UnmarshallingException.class)
public void testUnmarshallingWithCDATAInElementContentInsecure() throws XMLParserException, UnmarshallingException {
@@ -115,8 +114,8 @@ public class UnmarshallingSecurityTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with comment between child elements with default parser.
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallingWithCommentBetweenChildElementsDefaults() throws XMLParserException, UnmarshallingException {
@@ -132,8 +131,8 @@ public class UnmarshallingSecurityTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with comment between child elements with insecure parser.
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test(expectedExceptions=UnmarshallingException.class)
public void testUnmarshallingWithCommentBetweenChildElementsInsecure() throws XMLParserException, UnmarshallingException {
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingTest.java
index afde22a..10a7b88 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/UnmarshallingTest.java
@@ -17,18 +17,17 @@
package org.opensaml.core.xml;
-import org.testng.annotations.Test;
-import org.testng.Assert;
import java.util.List;
-import net.shibboleth.utilities.java.support.xml.XMLParserException;
-
-import org.opensaml.core.xml.io.MarshallingException;
import org.opensaml.core.xml.io.Unmarshaller;
import org.opensaml.core.xml.io.UnmarshallingException;
import org.opensaml.core.xml.mock.SimpleXMLObject;
+import org.testng.Assert;
+import org.testng.annotations.Test;
import org.w3c.dom.Document;
+import net.shibboleth.utilities.java.support.xml.XMLParserException;
+
/**
* Unit test for unmarshalling functions.
*/
@@ -44,8 +43,8 @@ public class UnmarshallingTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element that has attributes.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallingWithAttributes() throws XMLParserException, UnmarshallingException {
@@ -63,8 +62,8 @@ public class UnmarshallingTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with content.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallingWithElementContent() throws XMLParserException, UnmarshallingException {
@@ -98,8 +97,8 @@ public class UnmarshallingTest extends XMLObjectBaseTestCase {
/**
* Tests unmarshalling an element with child elements.
*
- * @throws XMLParserException
- * @throws MarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallingWithChildElements() throws XMLParserException, UnmarshallingException {
@@ -113,4 +112,4 @@ public class UnmarshallingTest extends XMLObjectBaseTestCase {
Assert.assertEquals(sxObject.getSimpleXMLObjects().size(), 2, "Number of children elements was not expected value");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java b/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java
index 1d1a68b..f211d27 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java
@@ -128,8 +128,9 @@ public abstract class XMLObjectBaseTestCase extends OpenSAMLInitBaseTestCase {
* Builds the requested XMLObject.
*
* @param name name of the XMLObject
+ * @param <T> type of the result
*
- * @return the build XMLObject
+ * @return the built XMLObject
*/
protected <T extends XMLObject> T buildXMLObject(QName name) {
final XMLObjectBuilder<T> builder = getBuilder(name);
@@ -144,6 +145,9 @@ public abstract class XMLObjectBaseTestCase extends OpenSAMLInitBaseTestCase {
/**
* Unmarshalls an element file into its XMLObject.
*
+ * @param elementFile the element file to unmarshall
+ * @param <T> expected type
+ *
* @return the XMLObject from the file
*/
protected <T extends XMLObject> T unmarshallElement(String elementFile) {
@@ -159,9 +163,14 @@ public abstract class XMLObjectBaseTestCase extends OpenSAMLInitBaseTestCase {
/**
* Unmarshalls an element file into its XMLObject.
*
+ * @param elementFile the element file to unmarshall
* @param propagateErrors if true, checked exceptions will be thrown, if false then they cause assertion of test failure
+ * @param <T> expected type
+ *
* @return the XMLObject from the file
*
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
protected <T extends XMLObject> T unmarshallElement(String elementFile, boolean propagateErrors)
throws XMLParserException, UnmarshallingException {
@@ -191,6 +200,8 @@ public abstract class XMLObjectBaseTestCase extends OpenSAMLInitBaseTestCase {
* For convenience when testing, pretty-print the specified DOM node to a file, or to
* the console if filename is null.
*
+ * @param node node to print
+ * @param filename name of file to print to
*/
protected void printXML(Node node, String filename) {
try {
@@ -204,6 +215,8 @@ public abstract class XMLObjectBaseTestCase extends OpenSAMLInitBaseTestCase {
* For convenience when testing, pretty-print the specified XMLObject to a file, or to
* the console if filename is null.
*
+ * @param xmlObject {@link XMLObject} to print
+ * @param filename name of file to print to
*/
protected void printXML(XMLObject xmlObject, String filename) {
Element elem = null;
@@ -217,7 +230,10 @@ public abstract class XMLObjectBaseTestCase extends OpenSAMLInitBaseTestCase {
/**
* Lookup the XMLObjectBuilder for a QName.
+ *
* @param qname the QName for which to find the builder
+ * @param <T> type of result for the {@link XMLObjectBuilder}
+ *
* @return the XMLObjectBuilder
*/
protected <T extends XMLObject> XMLObjectBuilder<T> getBuilder(QName qname) {
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/config/ConfigurationTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/config/ConfigurationTest.java
index bff709d..dba05b6 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/config/ConfigurationTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/config/ConfigurationTest.java
@@ -54,6 +54,8 @@ public class ConfigurationTest {
/**
* Tests that a schema invalid configuration file is properly identified as such.
+ *
+ * @throws Exception if something bad happens
*/
@Test
public void testInvalidConfiguration() throws Exception {
@@ -71,6 +73,8 @@ public class ConfigurationTest {
/**
* Tests loading of multiple configuration files.
+ *
+ * @throws Exception if something bad happens
*/
@Test
public void testObjectProviderConfiguration() throws Exception {
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/mock/SimpleXMLObject.java b/opensaml-core/src/test/java/org/opensaml/core/xml/mock/SimpleXMLObject.java
index b7abca7..5d53a04 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/mock/SimpleXMLObject.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/mock/SimpleXMLObject.java
@@ -71,6 +71,10 @@ public class SimpleXMLObject extends AbstractXMLObject implements ElementExtens
/**
* Constructor
+ *
+ * @param namspaceURI namespace for the node
+ * @param localName local name for the node
+ * @param namespacePrefix namespace prefix for the node
*/
public SimpleXMLObject(String namspaceURI, String localName, String namespacePrefix) {
super(namspaceURI, localName, namespacePrefix);
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBase64BinaryTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBase64BinaryTest.java
index abc8c01..28e576a 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBase64BinaryTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBase64BinaryTest.java
@@ -51,8 +51,8 @@ public class XSBase64BinaryTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a base64Binary type.
- * @throws MarshallingException
- * @throws XMLParserException
+ * @throws MarshallingException ...
+ * @throws XMLParserException ...
*/
@Test
public void testMarshall() throws MarshallingException, XMLParserException{
@@ -70,8 +70,8 @@ public class XSBase64BinaryTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a base64Binary type.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshall() throws XMLParserException, UnmarshallingException{
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBooleanTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBooleanTest.java
index 1d77417..ab23b61 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBooleanTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSBooleanTest.java
@@ -50,8 +50,8 @@ public class XSBooleanTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a boolean type.
- * @throws MarshallingException
- * @throws XMLParserException
+ * @throws MarshallingException ...
+ * @throws XMLParserException ...
*/
@Test
public void testMarshall() throws MarshallingException, XMLParserException{
@@ -69,8 +69,8 @@ public class XSBooleanTest extends XMLObjectBaseTestCase {
/**
* Tests Unmarshalling a boolean type.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshall() throws XMLParserException, UnmarshallingException{
@@ -83,4 +83,4 @@ public class XSBooleanTest extends XMLObjectBaseTestCase {
Assert.assertEquals(xsBoolean.getSchemaType(), XSBoolean.TYPE_NAME, "Unexpected XSBoolean schema type");
Assert.assertEquals(expectedValue, xsBoolean.getValue().toString(), "Unexpected value of XSBoolean");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSDateTimeTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSDateTimeTest.java
index 530d4ca..0cab0e9 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSDateTimeTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSDateTimeTest.java
@@ -54,8 +54,8 @@ public class XSDateTimeTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a dateTime type.
*
- * @throws MarshallingException
- * @throws XMLParserException
+ * @throws MarshallingException ...
+ * @throws XMLParserException ...
*/
@Test
public void testMarshall() throws MarshallingException, XMLParserException{
@@ -75,8 +75,8 @@ public class XSDateTimeTest extends XMLObjectBaseTestCase {
/**
* Tests Unmarshalling a dateTime type.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshall() throws XMLParserException, UnmarshallingException{
@@ -96,8 +96,8 @@ public class XSDateTimeTest extends XMLObjectBaseTestCase {
/**
* Tests Unmarshalling a dateTime type in canonical form, i.e. no trailing zeros in fractional seconds.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallCanonical() throws XMLParserException, UnmarshallingException{
@@ -117,8 +117,8 @@ public class XSDateTimeTest extends XMLObjectBaseTestCase {
/**
* Tests Unmarshalling a dateTime type that has no fractional seconds.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshallNoFractional() throws XMLParserException, UnmarshallingException{
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSIntegerTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSIntegerTest.java
index 708120d..74526f0 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSIntegerTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSIntegerTest.java
@@ -51,8 +51,9 @@ public class XSIntegerTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a integer type.
- * @throws MarshallingException
- * @throws XMLParserException
+ *
+ * @throws MarshallingException ...
+ * @throws XMLParserException ...
*/
@Test
public void testMarshall() throws MarshallingException, XMLParserException{
@@ -70,8 +71,8 @@ public class XSIntegerTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a integer type.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshall() throws XMLParserException, UnmarshallingException{
@@ -84,4 +85,4 @@ public class XSIntegerTest extends XMLObjectBaseTestCase {
Assert.assertEquals(xsInteger.getSchemaType(), XSInteger.TYPE_NAME, "Unexpected XSInteger schema type");
Assert.assertEquals(expectedValue, xsInteger.getValue(), "Unexpected value of XSInteger");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSQNameTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSQNameTest.java
index eaef59c..fb1d811 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSQNameTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSQNameTest.java
@@ -51,8 +51,9 @@ public class XSQNameTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a QName type.
- * @throws MarshallingException
- * @throws XMLParserException
+ *
+ * @throws MarshallingException ...
+ * @throws XMLParserException ...
*/
@Test
public void testMarshall() throws MarshallingException, XMLParserException{
@@ -70,8 +71,8 @@ public class XSQNameTest extends XMLObjectBaseTestCase {
/**
* Tests Unmarshalling a QName type.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshall() throws XMLParserException, UnmarshallingException{
@@ -84,4 +85,4 @@ public class XSQNameTest extends XMLObjectBaseTestCase {
Assert.assertEquals(xsQName.getSchemaType(), XSQName.TYPE_NAME, "Unexpected XSQName schema type");
Assert.assertEquals(xsQName.getValue(), expectedValue, "Unexpected value of XSQName");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSStringTest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSStringTest.java
index a56fba9..b6fb9e7 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSStringTest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSStringTest.java
@@ -51,8 +51,9 @@ public class XSStringTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a string type.
- * @throws MarshallingException
- * @throws XMLParserException
+ *
+ * @throws MarshallingException ...
+ * @throws XMLParserException ...
*/
@Test
public void testMarshall() throws MarshallingException, XMLParserException{
@@ -70,8 +71,8 @@ public class XSStringTest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a string type.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshall() throws XMLParserException, UnmarshallingException{
@@ -84,4 +85,4 @@ public class XSStringTest extends XMLObjectBaseTestCase {
Assert.assertEquals(xsString.getSchemaType(), XSString.TYPE_NAME, "Unexpected XSString schema type");
Assert.assertEquals(expectedValue, xsString.getValue(), "Unexpected value of XSString");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSURITest.java b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSURITest.java
index ae35504..a04e84c 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSURITest.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/schema/XSURITest.java
@@ -51,8 +51,9 @@ public class XSURITest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a URI type.
- * @throws MarshallingException
- * @throws XMLParserException
+ *
+ * @throws MarshallingException ...
+ * @throws XMLParserException ...
*/
@Test
public void testMarshall() throws MarshallingException, XMLParserException{
@@ -70,8 +71,8 @@ public class XSURITest extends XMLObjectBaseTestCase {
/**
* Tests Marshalling a URI type.
*
- * @throws XMLParserException
- * @throws UnmarshallingException
+ * @throws XMLParserException ...
+ * @throws UnmarshallingException ...
*/
@Test
public void testUnmarshall() throws XMLParserException, UnmarshallingException{
@@ -84,4 +85,4 @@ public class XSURITest extends XMLObjectBaseTestCase {
Assert.assertEquals(xsURI.getSchemaType(), XSURI.TYPE_NAME, "Unexpected XSURI schema type");
Assert.assertEquals(expectedValue, xsURI.getURI(), "Unexpected value of XSURI");
}
-}
\ No newline at end of file
+}
diff --git a/opensaml-messaging-api/src/test/java/org/opensaml/messaging/handler/AbstractMessageHandlerTest.java b/opensaml-messaging-api/src/test/java/org/opensaml/messaging/handler/AbstractMessageHandlerTest.java
index 8910d78..bdfcccf 100644
--- a/opensaml-messaging-api/src/test/java/org/opensaml/messaging/handler/AbstractMessageHandlerTest.java
+++ b/opensaml-messaging-api/src/test/java/org/opensaml/messaging/handler/AbstractMessageHandlerTest.java
@@ -30,7 +30,11 @@ import com.google.common.base.Predicates;
public class AbstractMessageHandlerTest {
- /** Test a successful action run. */
+ /**
+ * Test a successful action run.
+ *
+ * @throws Exception if something bad happens
+ */
@Test
public void testSuccess() throws Exception {
@@ -43,7 +47,11 @@ public class AbstractMessageHandlerTest {
Assert.assertTrue(handler.didPost);
}
- /** Test a failure in the preexec step. */
+ /**
+ * Test a failure in the preexec step.
+ *
+ * @throws Exception if something bad happens
+ */
@Test
public void testPreFailure() throws Exception {
@@ -59,7 +67,11 @@ public class AbstractMessageHandlerTest {
}
}
- /** Test a failure in the exec step. */
+ /**
+ * Test a failure in the exec step.
+ *
+ * @throws Exception if something bad happens
+ */
@Test
public void testExecFailure() throws Exception {
@@ -76,7 +88,11 @@ public class AbstractMessageHandlerTest {
}
}
- /** Test an unchecked error in the exec step. */
+ /**
+ * Test an unchecked error in the exec step.
+ *
+ * @throws Exception if something bad happens
+ */
@Test
public void testExecUnchecked() throws Exception {
@@ -93,7 +109,11 @@ public class AbstractMessageHandlerTest {
}
}
- /** Test a failure in the post step. */
+ /**
+ * Test a failure in the post step.
+ *
+ * @throws Exception if something bad happens
+ */
@Test
public void testPostFailure() throws Exception {
diff --git a/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandlerTest.java b/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandlerTest.java
index a6919e5..9705d0b 100644
--- a/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandlerTest.java
+++ b/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/HTTPRequestValidationHandlerTest.java
@@ -70,7 +70,8 @@ public class HTTPRequestValidationHandlerTest {
/**
* Test all parameters valid.
- * @throws MessageHandlerException
+ *
+ * @throws MessageHandlerException ...
*/
@Test
public void testAllGood() throws MessageHandlerException {
@@ -79,7 +80,8 @@ public class HTTPRequestValidationHandlerTest {
/**
* Bad request content type.
- * @throws MessageHandlerException
+ *
+ * @throws MessageHandlerException ...
*/
@Test(expectedExceptions=MessageHandlerException.class)
public void testContentTypeBad() throws MessageHandlerException {
@@ -89,7 +91,8 @@ public class HTTPRequestValidationHandlerTest {
/**
* Bad request method.
- * @throws MessageHandlerException
+ *
+ * @throws MessageHandlerException ...
*/
@Test(expectedExceptions=MessageHandlerException.class)
public void testRequestMethodBad() throws MessageHandlerException {
@@ -99,7 +102,8 @@ public class HTTPRequestValidationHandlerTest {
/**
* Bad request secure flag.
- * @throws MessageHandlerException
+ *
+ * @throws MessageHandlerException ...
*/
@Test(expectedExceptions=MessageHandlerException.class)
public void testRequireSecureBad() throws MessageHandlerException {
diff --git a/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/SchemaValidateXMLMessageTest.java b/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/SchemaValidateXMLMessageTest.java
index ca73c12..fae9fde 100644
--- a/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/SchemaValidateXMLMessageTest.java
+++ b/opensaml-messaging-impl/src/test/java/org/opensaml/messaging/handler/impl/SchemaValidateXMLMessageTest.java
@@ -55,7 +55,7 @@ public class SchemaValidateXMLMessageTest extends XMLObjectBaseTestCase {
/**
* Build the schema.
*
- * @throws Exception
+ * @throws Exception if something bad happens
*/
@BeforeClass public void setUp() throws Exception {
@@ -65,7 +65,11 @@ public class SchemaValidateXMLMessageTest extends XMLObjectBaseTestCase {
schema = schemaBuilder.buildSchema();
}
- /** Test a null inbound message context. */
+ /**
+ * Test a null inbound message context.
+ *
+ * @throws Exception if something bad happens
+ */
@Test(expectedExceptions=MessageHandlerException.class)
public void testNullInboundMessageContext() throws Exception {
@@ -77,7 +81,11 @@ public class SchemaValidateXMLMessageTest extends XMLObjectBaseTestCase {
handler.invoke(messageContext);
}
- /** Test a null dom. */
+ /**
+ * Test a null dom.
+ *
+ * @throws Exception if something bad happens
+ */
@Test(expectedExceptions=MessageHandlerException.class)
public void testNullDom() throws Exception {
@@ -93,7 +101,11 @@ public class SchemaValidateXMLMessageTest extends XMLObjectBaseTestCase {
handler.invoke(messageContext);
}
- /** Test validation of an invalid xml file. */
+ /**
+ * Test validation of an invalid xml file.
+ *
+ * @throws Exception if something bad happens
+ */
@Test(expectedExceptions=MessageHandlerException.class)
public void testInvalidSchema() throws Exception {
@@ -112,7 +124,11 @@ public class SchemaValidateXMLMessageTest extends XMLObjectBaseTestCase {
handler.invoke(messageContext);
}
- /** Test validation of a valid xml file. */
+ /**
+ * Test validation of a valid xml file.
+ *
+ * @throws Exception if something bad happens
+ */
@Test public void testValidSchema() throws Exception {
final SchemaValidateXMLMessage handler = new SchemaValidateXMLMessage(schema);
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list