1
0

Javadoc and comments

Fix generics warnings
This commit is contained in:
Gary Gregory
2024-08-14 08:12:20 -04:00
parent 2ca6d51f21
commit 8e5855505d
2 changed files with 29 additions and 31 deletions

View File

@@ -29,9 +29,8 @@ import org.apache.commons.logging.PathableClassLoader;
import org.apache.commons.logging.PathableTestSuite; import org.apache.commons.logging.PathableTestSuite;
/** /**
* Verify that by default LogFactoryImpl is loaded from the tccl class loader. * Verifies that by default LogFactoryImpl is loaded from the TCCL class loader.
*/ */
public class TcclDisabledTestCase extends TestCase { public class TcclDisabledTestCase extends TestCase {
public static final String MY_LOG_PKG = public static final String MY_LOG_PKG =
@@ -41,10 +40,10 @@ public class TcclDisabledTestCase extends TestCase {
MY_LOG_PKG + ".MyLog"; MY_LOG_PKG + ".MyLog";
/** /**
* Return the tests included in this test suite. * Returns the tests included in this test suite.
*/ */
public static Test suite() throws Exception { public static Test suite() throws Exception {
final Class thisClass = TcclDisabledTestCase.class; final Class<TcclDisabledTestCase> thisClass = TcclDisabledTestCase.class;
// Determine the URL to this .class file, so that we can then // Determine the URL to this .class file, so that we can then
// append the priority dirs to it. For tidiness, load this // append the priority dirs to it. For tidiness, load this
@@ -61,7 +60,7 @@ public class TcclDisabledTestCase extends TestCase {
// Now set up the desired class loader hierarchy. Everything goes into // Now set up the desired class loader hierarchy. Everything goes into
// the parent classpath, but we exclude the custom Log class. // the parent classpath, but we exclude the custom Log class.
// //
// We then create a tccl class loader that can see the custom // We then create a TCCL class loader that can see the custom
// Log class. Therefore if that class can be found, then the // Log class. Therefore if that class can be found, then the
// TCCL must have been used to load it. // TCCL must have been used to load it.
final PathableClassLoader emptyLoader = new PathableClassLoader(null); final PathableClassLoader emptyLoader = new PathableClassLoader(null);
@@ -80,7 +79,7 @@ public class TcclDisabledTestCase extends TestCase {
final PathableClassLoader tcclLoader = new PathableClassLoader(parentLoader); final PathableClassLoader tcclLoader = new PathableClassLoader(parentLoader);
tcclLoader.addLogicalLib("testclasses"); tcclLoader.addLogicalLib("testclasses");
final Class testClass = parentLoader.loadClass(thisClass.getName()); final Class<?> testClass = parentLoader.loadClass(thisClass.getName());
return new PathableTestSuite(testClass, tcclLoader); return new PathableTestSuite(testClass, tcclLoader);
} }
@@ -93,7 +92,7 @@ public class TcclDisabledTestCase extends TestCase {
} }
/** /**
* Tear down instance variables required by this test case. * Tears down instance variables required by this test case.
*/ */
@Override @Override
public void tearDown() { public void tearDown() {
@@ -101,36 +100,36 @@ public class TcclDisabledTestCase extends TestCase {
} }
/** /**
* Verify that MyLog is only loadable via the tccl. * Verifies that MyLog is only loadable via the TCCL.
*/ */
public void testLoader() throws Exception { public void testLoader() throws Exception {
final ClassLoader thisClassLoader = this.getClass().getClassLoader(); final ClassLoader thisClassLoader = this.getClass().getClassLoader();
final ClassLoader tcclLoader = Thread.currentThread().getContextClassLoader(); final ClassLoader tcclLoader = Thread.currentThread().getContextClassLoader();
// the tccl loader should NOT be the same as the loader that loaded this test class. // the TCCL loader should NOT be the same as the loader that loaded this test class.
assertNotSame("tccl not same as test class loader", thisClassLoader, tcclLoader); assertNotSame("TCCL not same as test class loader", thisClassLoader, tcclLoader);
// MyLog should not be loadable via parent loader // MyLog should not be loadable via parent loader
try { try {
final Class clazz = thisClassLoader.loadClass(MY_LOG_IMPL); final Class<?> clazz = thisClassLoader.loadClass(MY_LOG_IMPL);
fail("Unexpectedly able to load MyLog via test class class loader"); fail("Unexpectedly able to load MyLog via test class class loader");
assertNotNull(clazz); // silence warnings about unused var assertNotNull(clazz); // silence warnings about unused var
} catch (final ClassNotFoundException ex) { } catch (final ClassNotFoundException ex) {
// ok, expected // ok, expected
} }
// MyLog should be loadable via tccl loader // MyLog should be loadable via TCCL loader
try { try {
final Class clazz = tcclLoader.loadClass(MY_LOG_IMPL); final Class<?> clazz = tcclLoader.loadClass(MY_LOG_IMPL);
assertNotNull(clazz); assertNotNull(clazz);
} catch (final ClassNotFoundException ex) { } catch (final ClassNotFoundException ex) {
fail("Unexpectedly unable to load MyLog via tccl class loader"); fail("Unexpectedly unable to load MyLog via TCCL class loader");
} }
} }
/** /**
* Verify that the custom Log implementation which is only accessible * Verifies that the custom Log implementation which is only accessible
* via the TCCL has NOT been loaded. Because this is only accessible via the * via the TCCL has NOT been loaded. Because this is only accessible via the
* TCCL, and we've use a commons-logging.properties that disables TCCL loading, * TCCL, and we've use a commons-logging.properties that disables TCCL loading,
* we should see the default Log rather than the custom one. * we should see the default Log rather than the custom one.
@@ -145,7 +144,7 @@ public class TcclDisabledTestCase extends TestCase {
try { try {
final Log log = instance.getInstance("test"); final Log log = instance.getInstance("test");
fail("Unexpectedly succeeded in loading a custom Log class" fail("Unexpectedly succeeded in loading a custom Log class"
+ " that is only accessible via the tccl."); + " that is only accessible via the TCCL.");
assertNotNull(log); // silence compiler warning about unused var assertNotNull(log); // silence compiler warning about unused var
} catch (final LogConfigurationException ex) { } catch (final LogConfigurationException ex) {
// ok, expected // ok, expected

View File

@@ -28,10 +28,9 @@ import org.apache.commons.logging.PathableClassLoader;
import org.apache.commons.logging.PathableTestSuite; import org.apache.commons.logging.PathableTestSuite;
/** /**
* Verify that by default the standard LogFactoryImpl class loads a * Verifies that by default the standard LogFactoryImpl class loads a
* custom Log implementation via the TCCL. * custom Log implementation via the TCCL.
*/ */
public class TcclEnabledTestCase extends TestCase { public class TcclEnabledTestCase extends TestCase {
public static final String MY_LOG_PKG = public static final String MY_LOG_PKG =
@@ -41,10 +40,10 @@ public class TcclEnabledTestCase extends TestCase {
MY_LOG_PKG + ".MyLog"; MY_LOG_PKG + ".MyLog";
/** /**
* Return the tests included in this test suite. * Returns the tests included in this test suite.
*/ */
public static Test suite() throws Exception { public static Test suite() throws Exception {
final Class thisClass = TcclEnabledTestCase.class; final Class<TcclEnabledTestCase> thisClass = TcclEnabledTestCase.class;
// Determine the URL to this .class file, so that we can then // Determine the URL to this .class file, so that we can then
// append the priority dirs to it. For tidiness, load this // append the priority dirs to it. For tidiness, load this
@@ -61,7 +60,7 @@ public class TcclEnabledTestCase extends TestCase {
// Now set up the desired class loader hierarchy. Everything goes into // Now set up the desired class loader hierarchy. Everything goes into
// the parent classpath, but we exclude the custom Log class. // the parent classpath, but we exclude the custom Log class.
// //
// We then create a tccl class loader that can see the custom // We then create a TCCL class loader that can see the custom
// Log class. Therefore if that class can be found, then the // Log class. Therefore if that class can be found, then the
// TCCL must have been used to load it. // TCCL must have been used to load it.
final PathableClassLoader emptyLoader = new PathableClassLoader(null); final PathableClassLoader emptyLoader = new PathableClassLoader(null);
@@ -80,7 +79,7 @@ public class TcclEnabledTestCase extends TestCase {
final PathableClassLoader tcclLoader = new PathableClassLoader(parentLoader); final PathableClassLoader tcclLoader = new PathableClassLoader(parentLoader);
tcclLoader.addLogicalLib("testclasses"); tcclLoader.addLogicalLib("testclasses");
final Class testClass = parentLoader.loadClass(thisClass.getName()); final Class<?> testClass = parentLoader.loadClass(thisClass.getName());
return new PathableTestSuite(testClass, tcclLoader); return new PathableTestSuite(testClass, tcclLoader);
} }
@@ -93,7 +92,7 @@ public class TcclEnabledTestCase extends TestCase {
} }
/** /**
* Tear down instance variables required by this test case. * Tears down instance variables required by this test case.
*/ */
@Override @Override
public void tearDown() { public void tearDown() {
@@ -101,36 +100,36 @@ public class TcclEnabledTestCase extends TestCase {
} }
/** /**
* Verify that MyLogFactoryImpl is only loadable via the tccl. * Verifies that MyLogFactoryImpl is only loadable via the TCCL.
*/ */
public void testLoader() throws Exception { public void testLoader() throws Exception {
final ClassLoader thisClassLoader = this.getClass().getClassLoader(); final ClassLoader thisClassLoader = this.getClass().getClassLoader();
final ClassLoader tcclLoader = Thread.currentThread().getContextClassLoader(); final ClassLoader tcclLoader = Thread.currentThread().getContextClassLoader();
// the tccl loader should NOT be the same as the loader that loaded this test class. // the TCCL loader should NOT be the same as the loader that loaded this test class.
assertNotSame("tccl not same as test class loader", thisClassLoader, tcclLoader); assertNotSame("TCCL not same as test class loader", thisClassLoader, tcclLoader);
// MyLog should not be loadable via parent loader // MyLog should not be loadable via parent loader
try { try {
final Class clazz = thisClassLoader.loadClass(MY_LOG_IMPL); final Class<?> clazz = thisClassLoader.loadClass(MY_LOG_IMPL);
fail("Unexpectedly able to load MyLog via test class class loader"); fail("Unexpectedly able to load MyLog via test class class loader");
assertNotNull(clazz); // silence warnings about unused var assertNotNull(clazz); // silence warnings about unused var
} catch (final ClassNotFoundException ex) { } catch (final ClassNotFoundException ex) {
// ok, expected // ok, expected
} }
// MyLog should be loadable via tccl loader // MyLog should be loadable via TCCL loader
try { try {
final Class clazz = tcclLoader.loadClass(MY_LOG_IMPL); final Class<?> clazz = tcclLoader.loadClass(MY_LOG_IMPL);
assertNotNull(clazz); assertNotNull(clazz);
} catch (final ClassNotFoundException ex) { } catch (final ClassNotFoundException ex) {
fail("Unexpectedly unable to load MyLog via tccl class loader"); fail("Unexpectedly unable to load MyLog via TCCL class loader");
} }
} }
/** /**
* Verify that the custom Log implementation which is only accessible * Verifies that the custom Log implementation which is only accessible
* via the TCCL has successfully been loaded as specified in the config file. * via the TCCL has successfully been loaded as specified in the config file.
* This proves that the TCCL was used to load that class. * This proves that the TCCL was used to load that class.
*/ */