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.synd;
18  
19  import com.sun.syndication.common.ToString;
20  import com.sun.syndication.common.CopyFrom;
21  
22  /***
23   * Bean interface for images of SyndFeedImpl feeds.
24   * <p>
25   * @author Alejandro Abdelnur
26   *
27   */
28  public interface SyndImage extends ToString,Cloneable,CopyFrom {
29      /***
30       * Returns the image title.
31       * <p>
32       * @return the image title, <b>null</b> if none.
33       *
34       */
35      String getTitle();
36  
37      /***
38       * Sets the image title.
39       * <p>
40       * @param title the image title to set, <b>null</b> if none.
41       *
42       */
43      void setTitle(String title);
44  
45      /***
46       * Returns the image URL.
47       * <p>
48       * @return the image URL, <b>null</b> if none.
49       *
50       */
51      String getUrl();
52  
53      /***
54       * Sets the image URL.
55       * <p>
56       * @param url the image URL to set, <b>null</b> if none.
57       *
58       */
59      void setUrl(String url);
60  
61      /***
62       * Returns the image link.
63       * <p>
64       * @return the image link, <b>null</b> if none.
65       *
66       */
67      String getLink();
68  
69      /***
70       * Sets the image link.
71       * <p>
72       * @param link the image link to set, <b>null</b> if none.
73       *
74       */
75      void setLink(String link);
76  
77      /***
78       * Returns the image description.
79       * <p>
80       * @return the image description, <b>null</b> if none.
81       *
82       */
83      String getDescription();
84  
85      /***
86       * Sets the image description.
87       * <p>
88       * @param description the image description to set, <b>null</b> if none.
89       *
90       */
91      void setDescription(String description);
92  
93      /***
94       * Creates a deep clone of the object.
95       * <p>
96       * @return a clone of the object.
97       * @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
98       *
99       */
100     public Object clone() throws CloneNotSupportedException;
101 
102 }