com.rometools.rome.feed.rss.Description Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2004 Sun Microsystems, Inc.
 * Copyright 2011 The ROME Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package com.rometools.rome.feed.rss;

import java.io.Serializable;

import com.rometools.rome.feed.impl.ObjectBean;

/**
 * Bean for item descriptions of RSS feeds.
 */
public class Description implements Cloneable, Serializable {
    private static final long serialVersionUID = 1L;
    private final ObjectBean objBean;
    private String type;
    private String value;

    public Description() {
        objBean = new ObjectBean(this.getClass(), this);
    }

    /**
     * Creates a deep 'bean' clone of the object.
     * 
     *
     * @return a clone of the object.
     * @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
     *
     */
    @Override
    public Object clone() throws CloneNotSupportedException {
        return objBean.clone();
    }

    /**
     * Indicates whether some other object is "equal to" this one as defined by the Object equals()
     * method.
     * 

     *
     * @param other he reference object with which to compare.
     * @return true if 'this' object is equal to the 'other' object.
     *
     */
    @Override
    public boolean equals(final Object other) {
        if (!(other instanceof Description)) {
            return false;
        }
        return objBean.equals(other);
    }

    /**
     * Returns a hashcode value for the object.
     * 

     * It follows the contract defined by the Object hashCode() method.
     * 

     *
     * @return the hashcode of the bean object.
     *
     */
    @Override
    public int hashCode() {
        return objBean.hashCode();
    }

    /**
     * Returns the String representation for the object.
     * 

     *
     * @return String representation for the object.
     *
     */
    @Override
    public String toString() {
        return objBean.toString();
    }

    /**
     * Returns the description type.
     * 

     *
     * @return the description type, null if none.
     *
     */
    public String getType() {
        return type;
    }

    /**
     * Sets the description type.
     * 

     *
     * @param type the description type to set, null if none.
     *
     */
    public void setType(final String type) {
        this.type = type;
    }

    /**
     * Returns the description value.
     * 

     *
     * @return the description value, null if none.
     *
     */
    public String getValue() {
        return value;
    }

    /**
     * Sets the description value.
     * 
     *
     * @param value the description value to set, null if none.
     *
     */
    public void setValue(final String value) {
        this.value = value;
    }

}