File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\FeedAdapter.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
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 hudson;
25
26 import java.util.Calendar;
27
28 /**
29 * Provides a RSS feed view of the data.
30 *
31 * <p>
32 * This interface allows data structure of any form to be exposed
33 * as RSS feeds, just by writing a stateless singleton adapter code that
34 * implements this interface.
35 *
36 * @author Kohsuke Kawaguchi
37 */
38 public interface FeedAdapter<E> {
39 /**
40 * Gets the human readable title of the entry.
41 * In RSS readers, this is usually displayed like an e-mail subject.
42 */
43 String getEntryTitle(E entry);
44
45 /**
46 * Gets the URL that represents this entry.
47 * Relative to context root of the Hudson.
48 */
49 String getEntryUrl(E entry);
50
51 /**
52 * Unique ID of each entry.
53 * RSS readers use this to determine what feeds are new and what are not.
54 *
55 * This needs to produce a tag URL as per RFC 4151, required by Atom 1.0.
56 */
57 String getEntryID(E entry);
58
59 /**
60 * (Potentially lengthy) plain text to be attached to the feed.
61 * Can be null.
62 */
63 String getEntryDescription(E entry);
64
65 /**
66 * Timestamp of the last change in this entry.
67 */
68 Calendar getEntryTimestamp(E entry);
69
70 /**
71 * Author of this entry.
72 */
73 String getEntryAuthor(E entry);
74 }
75