AssertException


1   /*
2   
3      Copyright 2001-2003  The Apache Software Foundation 
4   
5      Licensed under the Apache License, Version 2.0 (the "License");
6      you may not use this file except in compliance with the License.
7      You may obtain a copy of the License at
8   
9          http://www.apache.org/licenses/LICENSE-2.0
10  
11     Unless required by applicable law or agreed to in writing, software
12     distributed under the License is distributed on an "AS IS" BASIS,
13     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14     See the License for the specific language governing permissions and
15     limitations under the License.
16  
17   */
18  package org.apache.batik.test;
19  
20  /**
21   * Exception which Tests can throw when a specific assertion fails.
22   *
23   * @author <a HREF="mailto:vhardy@apache.org">Vincent Hardy</a>
24   * @version $Id: AssertException.java,v 1.5 2004/08/18 07:16:56 vhardy Exp $
25   */
26  public abstract class AssertException extends TestErrorConditionException {
27      public static final String   ENTRY_KEY_ASSERTION_TYPE 
28          = "AssertException.entry.key.assertion.type";
29  
30      /**
31       * <tt>TestErrorConditionException</tt> implementation.
32       */
33      public TestReport getTestReport(Test test){
34          DefaultTestReport report = new DefaultTestReport(test);
35          report.setErrorCode(TestReport.ERROR_ASSERTION_FAILED);
36          report.addDescriptionEntry(ENTRY_KEY_ASSERTION_TYPE,
37                                     getAssertionType());
38          addDescription(report);
39          addStackTraceDescription(report);  
40          report.setPassed(false);
41          return report;
42      }
43  
44      /**
45       * Requests that the exception populates the TestReport with the
46       * relevant information.
47       */
48      public abstract void addDescription(TestReport report);
49  
50      /**
51       * Returns the type of assertion which failed. e.g., "assertEquals"
52       */
53      public abstract String   getAssertionType();
54  }
55
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags