1 /*
2 The MIT License
3
4 Copyright (c) 2004, The Codehaus
5
6 Permission is hereby granted, free of charge, to any person obtaining a copy of
7 this software and associated documentation files (the "Software"), to deal in
8 the Software without restriction, including without limitation the rights to
9 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10 of the Software, and to permit persons to whom the Software is furnished to do
11 so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in all
14 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 THE
22 SOFTWARE.
23 */
24 package org.codehaus.mojo.scmchangelog.changelog.log;
25
26 import java.util.List;
27
28 /**
29 * Represents the comment message of a log entry from the subversion repository.
30 * It can be one message for several issues.
31 * @author ehsavoie
32 * @version $Id: Message.java 7652 2008-09-11 07:58:40Z ehsavoie $
33 */
34 public class Message
35 {
36
37 /**
38 * The comment cleaned of grammar elements, with the Grammar.issueSeparator
39 * between each issue comment.
40 */
41 private String comment;
42 /**
43 * The issues extracted from the comment.
44 */
45 private List issues;
46
47 /**
48 * Creates a new instance of Message
49 * @param cleanedComment : the original comment.
50 * @param foundIssues : the issues of this log entry.
51 */
52 public Message( String cleanedComment, List foundIssues )
53 {
54 this.comment = cleanedComment;
55 this.issues = foundIssues;
56 }
57
58 /**
59 * Return the comment cleaned of grammar elements, with the Grammar.issueSeparator
60 * between each issue comment.
61 * @return the comment cleaned of grammar elements, with the Grammar.issueSeparator
62 * between each issue comment.
63 */
64 public String getComment()
65 {
66 return comment;
67 }
68
69 /**
70 * Return the issues extracted from the comment.
71 * @return a List of Issue.
72 * @see org.codehaus.mojo.scmchangelog.changelog.log.Issue
73 */
74 public List getIssues()
75 {
76 return issues;
77 }
78 }