From 3a59b01be8aa213194631cf928ebf0d64d36b2da Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Wed, 2 Oct 2019 14:26:50 +0200 Subject: [PATCH] Polish Javadoc for abstract JUnit 4 and TestNG base classes --- .../AbstractJUnit4SpringContextTests.java | 14 +++++----- ...TransactionalJUnit4SpringContextTests.java | 5 ++-- .../AbstractTestNGSpringContextTests.java | 27 +++++++++---------- ...TransactionalTestNGSpringContextTests.java | 3 ++- 4 files changed, 24 insertions(+), 25 deletions(-) diff --git a/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractJUnit4SpringContextTests.java b/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractJUnit4SpringContextTests.java index 38afa179ca..3b88316825 100644 --- a/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractJUnit4SpringContextTests.java +++ b/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractJUnit4SpringContextTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,13 +35,13 @@ import org.springframework.test.context.web.ServletTestExecutionListener; /** * Abstract base test class which integrates the Spring TestContext * Framework with explicit {@link ApplicationContext} testing support - * in a JUnit environment. + * in a JUnit 4 environment. * *

Concrete subclasses should typically declare a class-level * {@link ContextConfiguration @ContextConfiguration} annotation to - * configure the {@linkplain ApplicationContext application context} {@link - * ContextConfiguration#locations() resource locations} or {@link - * ContextConfiguration#classes() annotated classes}. If your test does not + * configure the {@linkplain ApplicationContext application context} {@linkplain + * ContextConfiguration#locations() resource locations} or {@linkplain + * ContextConfiguration#classes() component classes}. If your test does not * need to load an application context, you may choose to omit the * {@link ContextConfiguration @ContextConfiguration} declaration and to configure * the appropriate {@link org.springframework.test.context.TestExecutionListener @@ -64,13 +64,13 @@ import org.springframework.test.context.web.ServletTestExecutionListener; * {@link SpringRunner}, {@link ContextConfiguration @ContextConfiguration}, * {@link TestExecutionListeners @TestExecutionListeners}, etc. *

  • If you wish to extend this class and use a runner other than the - * {@link SpringRunner}, as of Spring Framework 4.2 you can use + * {@link SpringRunner}, you can use * {@link org.springframework.test.context.junit4.rules.SpringClassRule SpringClassRule} and * {@link org.springframework.test.context.junit4.rules.SpringMethodRule SpringMethodRule} * and specify your runner of choice via {@link RunWith @RunWith(...)}.
    • * * - *

    NOTE: As of Spring Framework 4.3, this class requires JUnit 4.12 or higher. + *

    NOTE: This class requires JUnit 4.12 or higher. * * @author Sam Brannen * @since 2.5 diff --git a/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java b/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java index 36755cd05f..5dc4b817a1 100644 --- a/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java +++ b/spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -56,6 +56,7 @@ import org.springframework.util.Assert; * *

      *
    • {@link org.springframework.test.context.web.ServletTestExecutionListener} + *
    • {@link org.springframework.test.context.support.DirtiesContextBeforeModesTestExecutionListener} *
    • {@link org.springframework.test.context.support.DependencyInjectionTestExecutionListener} *
    • {@link org.springframework.test.context.support.DirtiesContextTestExecutionListener} *
    • {@link org.springframework.test.context.transaction.TransactionalTestExecutionListener} @@ -75,7 +76,7 @@ import org.springframework.util.Assert; * and specify your runner of choice via {@link org.junit.runner.RunWith @RunWith(...)}.
      • *
    * - *

    NOTE: As of Spring Framework 4.3, this class requires JUnit 4.12 or higher. + *

    NOTE: This class requires JUnit 4.12 or higher. * * @author Sam Brannen * @author Juergen Hoeller diff --git a/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTestNGSpringContextTests.java b/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTestNGSpringContextTests.java index a603f3f838..bc3609c966 100644 --- a/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTestNGSpringContextTests.java +++ b/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTestNGSpringContextTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -46,19 +46,16 @@ import org.springframework.test.context.web.ServletTestExecutionListener; * with explicit {@link ApplicationContext} testing support in a TestNG * environment. * - *

    Concrete subclasses: - *

      - *
    • Typically declare a class-level {@link ContextConfiguration - * @ContextConfiguration} annotation to configure the {@linkplain ApplicationContext - * application context} {@linkplain ContextConfiguration#locations() resource locations} - * or {@linkplain ContextConfiguration#classes() annotated classes}. If your test - * does not need to load an application context, you may choose to omit the - * {@code @ContextConfiguration} declaration and to configure the appropriate - * {@link org.springframework.test.context.TestExecutionListener TestExecutionListeners} - * manually.
      • - *
    • Must have constructors which either implicitly or explicitly delegate to - * {@code super();}.
      • - *
    + *

    Concrete subclasses should typically declare a class-level + * {@link ContextConfiguration @ContextConfiguration} annotation to + * configure the {@linkplain ApplicationContext application context} {@linkplain + * ContextConfiguration#locations() resource locations} or {@linkplain + * ContextConfiguration#classes() component classes}. If your test does not + * need to load an application context, you may choose to omit the + * {@link ContextConfiguration @ContextConfiguration} declaration and to configure + * the appropriate {@link org.springframework.test.context.TestExecutionListener + * TestExecutionListeners} manually. Concrete subclasses must also have + * constructors which either implicitly or explicitly delegate to {@code super();}. * *

    The following {@link org.springframework.test.context.TestExecutionListener * TestExecutionListeners} are configured by default: @@ -105,7 +102,7 @@ public abstract class AbstractTestNGSpringContextTests implements IHookable, App /** - * Construct a new AbstractTestNGSpringContextTests instance and initialize + * Construct a new {@code AbstractTestNGSpringContextTests} instance and initialize * the internal {@link TestContextManager} for the current test class. */ public AbstractTestNGSpringContextTests() { diff --git a/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java b/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java index 08d6046cbe..9e75343464 100644 --- a/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java +++ b/spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -55,6 +55,7 @@ import org.springframework.util.Assert; * *

      *
    • {@link org.springframework.test.context.web.ServletTestExecutionListener} + *
    • {@link org.springframework.test.context.support.DirtiesContextBeforeModesTestExecutionListener} *
    • {@link org.springframework.test.context.support.DependencyInjectionTestExecutionListener} *
    • {@link org.springframework.test.context.support.DirtiesContextTestExecutionListener} *
    • {@link org.springframework.test.context.transaction.TransactionalTestExecutionListener}