View Javadoc

1   /*
2    * Copyright 2004 Sun Microsystems, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   */
17  package com.sun.syndication.feed.rss;
18  
19  import com.sun.syndication.feed.impl.ObjectBean;
20  import com.sun.syndication.feed.impl.ObjectBean;
21  
22  import java.io.Serializable;
23  
24  /***
25   * Bean for item enclosures of RSS feeds.
26   * <p>
27   * @author Alejandro Abdelnur
28   *
29   */
30  public class Enclosure implements Cloneable,Serializable {
31      private ObjectBean _objBean;
32      private String _url;
33      private long _length;
34      private String _type;
35  
36      /***
37       * Default constructor. All properties are set to <b>null</b>.
38       * <p>
39       *
40       */
41      public Enclosure() {
42          _objBean = new ObjectBean(this.getClass(),this);
43      }
44  
45      /***
46       * Creates a deep 'bean' clone of the object.
47       * <p>
48       * @return a clone of the object.
49       * @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
50       *
51       */
52      public Object clone() throws CloneNotSupportedException {
53          return _objBean.clone();
54      }
55  
56      /***
57       * Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
58       * <p>
59       * @param other he reference object with which to compare.
60       * @return <b>true</b> if 'this' object is equal to the 'other' object.
61       *
62       */
63      public boolean equals(Object other) {
64          return _objBean.equals(other);
65      }
66  
67      /***
68       * Returns a hashcode value for the object.
69       * <p>
70       * It follows the contract defined by the Object hashCode() method.
71       * <p>
72       * @return the hashcode of the bean object.
73       *
74       */
75      public int hashCode() {
76          return _objBean.hashCode();
77      }
78  
79      /***
80       * Returns the String representation for the object.
81       * <p>
82       * @return String representation for the object.
83       *
84       */
85      public String toString() {
86          return _objBean.toString();
87      }
88  
89      /***
90       * Returns the enclosure URL.
91       * <p>
92       * @return the enclosure URL, <b>null</b> if none.
93       *
94       */
95      public String getUrl() {
96          return _url;
97      }
98  
99      /***
100      * Sets the enclosure URL.
101      * <p>
102      * @param url the enclosure URL to set, <b>null</b> if none.
103      *
104      */
105     public void setUrl(String url) {
106         _url = url;
107     }
108 
109     /***
110      * Returns the enclosure length.
111      * <p>
112      * @return the enclosure length, <b>null</b> if none.
113      *
114      */
115     public long getLength() {
116         return _length;
117     }
118 
119     /***
120      * Sets the enclosure length.
121      * <p>
122      * @param length the enclosure length to set, <b>null</b> if none.
123      *
124      */
125     public void setLength(long length) {
126         _length = length;
127     }
128 
129     /***
130      * Returns the enclosure type.
131      * <p>
132      * @return the enclosure type, <b>null</b> if none.
133      *
134      */
135     public String getType() {
136         return _type;
137     }
138 
139     /***
140      * Sets the enclosure type.
141      * <p>
142      * @param type the enclosure type to set, <b>null</b> if none.
143      *
144      */
145     public void setType(String type) {
146         _type = type;
147     }
148 
149 }