KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > jforum > util > rss > RSS


1 /*
2  * Copyright (c) 2003, Rafael Steil
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms,
6  * with or without modification, are permitted provided
7  * that the following conditions are met:
8  *
9  * 1) Redistributions of source code must retain the above
10  * copyright notice, this list of conditions and the
11  * following disclaimer.
12  * 2) Redistributions in binary form must reproduce the
13  * above copyright notice, this list of conditions and
14  * the following disclaimer in the documentation and/or
15  * other materials provided with the distribution.
16  * 3) Neither the name of "Rafael Steil" nor
17  * the names of its contributors may be used to endorse
18  * or promote products derived from this software without
19  * specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
22  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
24  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27  * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
32  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
34  * IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
36  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38  *
39  * Created on 20/10/2004 22:59:58
40  * The JForum Project
41  * http://www.jforum.net
42  */
43 package net.jforum.util.rss;
44
45 import java.util.ArrayList JavaDoc;
46 import java.util.List JavaDoc;
47
48 /**
49  * Represents a RSS document
50  *
51  * @author Rafael Steil
52  * @version $Id: RSS.java,v 1.3 2005/07/26 03:04:37 rafaelsteil Exp $
53  */
54 public class RSS
55 {
56     private List JavaDoc itens;
57     private String JavaDoc title;
58     private String JavaDoc description;
59     private String JavaDoc encoding;
60     private String JavaDoc link;
61     
62     /**
63      * Creates a new RSS document.
64      *
65      * @param title The document title
66      * @param description The document description
67      * @param encoding The character encoding
68      * @param link The main document link
69      */
70     public RSS(String JavaDoc title, String JavaDoc description, String JavaDoc encoding, String JavaDoc link)
71     {
72         this.itens = new ArrayList JavaDoc();
73         this.title = title;
74         this.description = description;
75         this.encoding = encoding;
76         this.link = link;
77     }
78     
79     /**
80      * Gets the main document link
81      * @return The document link
82      */
83     public String JavaDoc getLink()
84     {
85         return this.link;
86     }
87     
88     /**
89      * Gets he document title
90      * @return The document title
91      */
92     public String JavaDoc getTitle()
93     {
94         return this.title;
95     }
96     
97     /**
98      * Gets the document description
99      * @return The document description
100      */
101     public String JavaDoc getDescription()
102     {
103         return this.description;
104     }
105     
106     /**
107      * Gets the document character encoding
108      * @return The encoding
109      */
110     public String JavaDoc getEncoding()
111     {
112         return this.encoding;
113     }
114     
115     /**
116      * Gets all <code>RSSItem</code> instances related
117      * to this RSS document.
118      *
119      * @return <code>java.util.List</code> with the entries
120      */
121     public List JavaDoc getItens()
122     {
123         return this.itens;
124     }
125     
126     /**
127      * Add a new item to the RSS document
128      *
129      * @param entry <code>RSSItem</code> object containing the item information
130      */
131     public void addItem(RSSItem item)
132     {
133         this.itens.add(item);
134     }
135 }
136
Popular Tags