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