Java Doc for AssertThrows.java in  » J2EE » spring-framework-2.0.6 » org » springframework » test » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.0.6 » org.springframework.test 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.test.AssertThrows

AssertThrows
abstract public class AssertThrows (Code)
Simple method object encapsulation of the 'test-for-Exception' scenario (for JUnit).

Used like so:

 // the class under test
 public class Foo {
 public void someBusinessLogic(String name) {
 if (name == null) {
 throw new IllegalArgumentException("The 'name' argument is required");
 }
 // rest of business logic here...
 }
 }
The test for the above bad argument path can be expressed using the AssertThrows class like so:
 public class FooTest {
 public void testSomeBusinessLogicBadArgumentPath() {
 new AssertThrows(IllegalArgumentException.class) {
 public void test() {
 new Foo().someBusinessLogic(null);
 }
 }.runTest();
 }
 }
This will result in the test passing if the Foo.someBusinessLogic(..) method threw an java.lang.IllegalArgumentException ; if it did not, the test would fail with the following message:
 "Must have thrown a [class java.lang.IllegalArgumentException]"
If the wrong type of java.lang.Exception was thrown, the test will also fail, this time with a message similar to the following:
 "junit.framework.AssertionFailedError: Was expecting a [class java.lang.UnsupportedOperationException] to be thrown, but instead a [class java.lang.IllegalArgumentException] was thrown"
The test for the correct java.lang.Exception respects polymorphism, so you can test that any old java.lang.Exception is thrown like so:
 public class FooTest {
 public void testSomeBusinessLogicBadArgumentPath() {
 // any Exception will do...
 new AssertThrows(Exception.class) {
 public void test() {
 new Foo().someBusinessLogic(null);
 }
 }.runTest();
 }
 }
You might want to compare this class with the junit.extensions.ExceptionTestCase class.

Note: This class requires JDK 1.4 or higher.
author:
   Rick Evans
author:
   Juergen Hoeller
since:
   2.0




Constructor Summary
public  AssertThrows(Class expectedException)
     Create a new instance of the AssertThrows class.
public  AssertThrows(Class expectedException, String failureMessage)
     Create a new instance of the AssertThrows class.

Method Summary
protected  voidcheckExceptionExpectations(Exception actualException)
     Does the donkey work of checking (verifying) that the java.lang.Exception that was thrown in the body of a test is an instance of the AssertThrows.getExpectedException() class (or an instance of a subclass).
protected  StringcreateMessageForNoExceptionThrown()
     Creates the failure message used if the test fails (i.e.
protected  StringcreateMessageForWrongThrownExceptionType(Exception actualException)
     Creates the failure message used if the wrong type of java.lang.Exception is thrown in the body of the test.
protected  voiddoFail()
     Template method called when the test fails; i.e.
final public  ExceptiongetActualException()
     Expose the actual exception thrown from AssertThrows.test , if any.
protected  ClassgetExpectedException()
     Return the java.lang.Exception expected to be thrown during the execution of the surrounding test.
protected  StringgetFailureMessage()
     Return the extra, contextual failure message that will be included in the failure text if the text fails.
public  voidrunTest()
     The main template method that drives the running of the AssertThrows.test() test logic and the AssertThrows.checkExceptionExpectations(Exception) checking of the resulting (expected) java.lang.Exception .
public  voidsetFailureMessage(String failureMessage)
     Set the extra, contextual failure message that will be included in the failure text if the text fails.
abstract public  voidtest()
     Subclass must override this abstract method and provide the test logic.


Constructor Detail
AssertThrows
public AssertThrows(Class expectedException)(Code)
Create a new instance of the AssertThrows class.
Parameters:
  expectedException - the java.lang.Exception expected to bethrown during the execution of the surrounding test
throws:
  IllegalArgumentException - if the supplied expectedException isnull; or if said argument is not an java.lang.Exception-derived class



AssertThrows
public AssertThrows(Class expectedException, String failureMessage)(Code)
Create a new instance of the AssertThrows class.
Parameters:
  expectedException - the java.lang.Exception expected to bethrown during the execution of the surrounding test
Parameters:
  failureMessage - the extra, contextual failure message that will beincluded in the failure text if the text fails (can be null)
throws:
  IllegalArgumentException - if the supplied expectedException isnull; or if said argument is not an java.lang.Exception-derived class




Method Detail
checkExceptionExpectations
protected void checkExceptionExpectations(Exception actualException)(Code)
Does the donkey work of checking (verifying) that the java.lang.Exception that was thrown in the body of a test is an instance of the AssertThrows.getExpectedException() class (or an instance of a subclass).

If you want to customise the failure message, consider overriding AssertThrows.createMessageForWrongThrownExceptionType(Exception) .
Parameters:
  actualException - the java.lang.Exception that has been thrownin the body of a test method (will never be null)




createMessageForNoExceptionThrown
protected String createMessageForNoExceptionThrown()(Code)
Creates the failure message used if the test fails (i.e. the expected exception is not thrown in the body of the test). the failure message used if the test fails
See Also:   AssertThrows.getFailureMessage()



createMessageForWrongThrownExceptionType
protected String createMessageForWrongThrownExceptionType(Exception actualException)(Code)
Creates the failure message used if the wrong type of java.lang.Exception is thrown in the body of the test.
Parameters:
  actualException - the actual exception thrown the message for the given exception



doFail
protected void doFail()(Code)
Template method called when the test fails; i.e. the expected java.lang.Exception is not thrown.

The default implementation simply fails the test via a call to junit.framework.Assert.fail(String) .

If you want to customise the failure message, consider overriding AssertThrows.createMessageForNoExceptionThrown() , and / or supplying an extra, contextual failure message via the appropriate constructor overload.
See Also:   AssertThrows.getFailureMessage()




getActualException
final public Exception getActualException()(Code)
Expose the actual exception thrown from AssertThrows.test , if any. the actual exception, or null if none



getExpectedException
protected Class getExpectedException()(Code)
Return the java.lang.Exception expected to be thrown during the execution of the surrounding test.



getFailureMessage
protected String getFailureMessage()(Code)
Return the extra, contextual failure message that will be included in the failure text if the text fails.



runTest
public void runTest()(Code)
The main template method that drives the running of the AssertThrows.test() test logic and the AssertThrows.checkExceptionExpectations(Exception) checking of the resulting (expected) java.lang.Exception .
See Also:   AssertThrows.test()
See Also:   
See Also:   AssertThrows.doFail()
See Also:   AssertThrows.checkExceptionExpectations(Exception)



setFailureMessage
public void setFailureMessage(String failureMessage)(Code)
Set the extra, contextual failure message that will be included in the failure text if the text fails.



test
abstract public void test() throws Exception(Code)
Subclass must override this abstract method and provide the test logic.
throws:
  Exception - if an error occurs during the execution of theaformentioned test logic



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.