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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rome Show documentation

All Roads Lead to ROME. ROME is a set of Atom/RSS Java utilities that make it easy to work in Java with most syndication formats. Today it accepts all flavors of RSS (0.90, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0), Atom 0.3 and Atom 1.0 feeds. Rome includes a set of parsers and generators for the various flavors of feeds, as well as converters to convert from one format to another. The parsers can give you back Java objects that are either specific for the format you want to work with, or a generic normalized SyndFeed object that lets you work on with the data without bothering about the underlying format.

There is a newer version: 2.1.0

Show newest version

/*
 * 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 java.util.Collections;

import com.rometools.rome.feed.impl.CloneableBean;
import com.rometools.rome.feed.impl.EqualsBean;
import com.rometools.rome.feed.impl.ToStringBean;

/**
 * Bean for text input of RSS feeds.
 */
public class TextInput implements Cloneable, Serializable {
    private static final long serialVersionUID = 1L;

    private String title;
    private String description;
    private String name;
    private String link;

    public TextInput() { }

    /**
     * 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 CloneableBean.beanClone(this, Collections.emptySet());
    }

    /**
     * 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 TextInput)) {
            return false;
        }
        return EqualsBean.beanEquals(this.getClass(), this, 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 EqualsBean.beanHashCode(this);
    }

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

     *
     * @return String representation for the object.
     *
     */
    @Override
    public String toString() {
        return ToStringBean.toString(this.getClass(), this);
    }

    /**
     * Returns the text input title.
     * 

     *
     * @return the text input title, null if none.
     *
     */
    public String getTitle() {
        return title;
    }

    /**
     * Sets the text input title.
     * 

     *
     * @param title the text input title to set, null if none.
     *
     */
    public void setTitle(final String title) {
        this.title = title;
    }

    /**
     * Returns the text input description.
     * 

     *
     * @return the text input description, null if none.
     *
     */
    public String getDescription() {
        return description;
    }

    /**
     * Sets the text input description.
     * 

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

    /**
     * Returns the text input name.
     * 

     *
     * @return the text input name, null if none.
     *
     */
    public String getName() {
        return name;
    }

    /**
     * Sets the text input name.
     * 

     *
     * @param name the text input name to set, null if none.
     *
     */
    public void setName(final String name) {
        this.name = name;
    }

    /**
     * Returns the text input link.
     * 

     *
     * @return the text input link, null if none.
     *
     */
    public String getLink() {
        return link;
    }

    /**
     * Sets the text input link.
     * 
     *
     * @param link the text input link to set, null if none.
     *
     */
    public void setLink(final String link) {
        this.link = link;
    }

}