1   /*
2    * The MIT License
3    *
4    * Copyright (c) <2010> <tap4j>
5    * 
6    * Permission is hereby granted, free of charge, to any person obtaining a copy
7    * of this software and associated documentation files (the "Software"), to deal
8    * in the Software without restriction, including without limitation the rights
9    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10   * copies of the Software, and to permit persons to whom the Software is
11   * furnished to do so, subject to the following conditions:
12   * 
13   * The above copyright notice and this permission notice shall be included in
14   * all copies or substantial portions of the Software.
15   * 
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22   * THE SOFTWARE.
23   */
24  package org.tap4j.model;
25  
26  /**
27   * Represents a Bail Out TAP Line. The test execution should be suspended if
28   * there is a Bail Out.
29   * 
30   * @since 1.0
31   */
32  public class BailOut extends TapResult {
33  
34      /*
35       * Serial Version UID.
36       */
37      private static final long serialVersionUID = -354950715195034445L;
38  
39      /**
40       * Reason to Bail Out.
41       */
42      private String reason;
43  
44      /**
45       * Optional comment.
46       */
47      private Comment comment;
48  
49      /**
50       * Constructor with parameter.
51       * 
52       * @param reason Reason to Bail Out.
53       */
54      public BailOut(String reason) {
55          super();
56          this.reason = reason;
57      }
58  
59      /**
60       * Get the reason for bailing out.
61       * 
62       * @return Reason to Bail Out.
63       */
64      public String getReason() {
65          return this.reason;
66      }
67  
68      /**
69       * Get the comment.
70       * 
71       * @return Bail Out comment.
72       */
73      public Comment getComment() {
74          return this.comment;
75      }
76  
77      /**
78       * Set the comment.
79       * 
80       * @param comment Bail Out comment.
81       */
82      public void setComment(Comment comment) {
83          this.comment = comment;
84      }
85  
86  }