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.atom;
18  
19  import com.sun.syndication.feed.impl.ObjectBean;
20  
21  import java.io.Serializable;
22  
23  /***
24   * Bean for link elements of Atom feeds.
25   * <p>
26   * @author Alejandro Abdelnur
27   *
28   */
29  public class Link implements Cloneable,Serializable {
30      private ObjectBean _objBean;
31      private String _rel;
32      private String _type;
33      private String _href;
34      private String _title;
35  
36      /***
37       * Default constructor. All properties are set to <b>null</b>.
38       * <p>
39       *
40       */
41      public Link() {
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 link rel.
91       * <p>
92       * @return the link rel, <b>null</b> if none.
93       *
94       */
95      public String getRel() {
96          return _rel;
97      }
98  
99      /***
100      * Sets the link rel.
101      * <p>
102      * @param rel the link rel,, <b>null</b> if none.
103      *
104      */
105     public void setRel(String rel) {
106         //TODO add check, ask P@ about the check
107         _rel = rel;
108     }
109 
110     /***
111      * Returns the link type.
112      * <p>
113      * @return the link type, <b>null</b> if none.
114      *
115      */
116     public String getType() {
117         return _type;
118     }
119 
120     /***
121      * Sets the link type.
122      * <p>
123      * @param type the link type, <b>null</b> if none.
124      *
125      */
126     public void setType(String type) {
127         _type = type;
128     }
129 
130     /***
131      * Returns the link href.
132      * <p>
133      * @return the link href, <b>null</b> if none.
134      *
135      */
136     public String getHref() {
137         return _href;
138     }
139 
140     /***
141      * Sets the link href.
142      * <p>
143      * @param href the link href, <b>null</b> if none.
144      *
145      */
146     public void setHref(String href) {
147         _href = href;
148     }
149 
150     /***
151      * Returns the link title.
152      * <p>
153      * @return the link title, <b>null</b> if none.
154      *
155      */
156     public String getTitle() {
157         return _title;
158     }
159 
160     /***
161      * Sets the link title.
162      * <p>
163      * @param title the link title, <b>null</b> if none.
164      *
165      */
166     public void setTitle(String title) {
167         _title = title;
168     }
169 
170 }