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 * A TAP Comment. In TAP files the comments have a # before the text.
28 *
29 * @since 1.0
30 */
31 public class Comment extends TapResult {
32
33 /*
34 * Serial Version UID.
35 */
36 private static final long serialVersionUID = 6694406960961188778L;
37
38 /**
39 * Comment text.
40 */
41 private final String text;
42
43 /**
44 * Whether the comment is inline or not.
45 */
46 private boolean inline;
47
48 /**
49 * Constructor with text. A comment must always have a text.
50 *
51 * @param text Text of the comment.
52 */
53 public Comment(String text) {
54 super();
55 this.text = text;
56 }
57
58 /**
59 * @return Comment text.
60 */
61 public String getText() {
62 return this.text;
63 }
64
65 /**
66 * @return the inline
67 */
68 public boolean isInline() {
69 return inline;
70 }
71
72 /**
73 * @param inline the inline to set
74 */
75 public void setInline(boolean inline) {
76 this.inline = inline;
77 }
78
79 }