com.sun.syndication.feed.rss.Enclosure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sesame-tools-rio-rss
There is a newer version: 3.1.0-incubating
/*
 * 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.sun.syndication.feed.rss;

import com.sun.syndication.feed.impl.ObjectBean;

import java.io.Serializable;

/**
 * Bean for item enclosures of RSS feeds.
 * 
 * @author Alejandro Abdelnur
 *
 */
public class Enclosure implements Cloneable,Serializable {
    private ObjectBean _objBean;
    private String _url;
    private long _length;
    private String _type;

    /**
     * Default constructor. All properties are set to null.
     * 

     *
     */
    public Enclosure() {
        _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(Object other) {
        if(!(other instanceof Enclosure)){
            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 enclosure URL.
     * 

     * @return the enclosure URL, null if none.
     *
     */
    public String getUrl() {
        return _url;
    }

    /**
     * Sets the enclosure URL.
     * 

     * @param url the enclosure URL to set, null if none.
     *
     */
    public void setUrl(String url) {
        _url = url;
    }

    /**
     * Returns the enclosure length.
     * 

     * @return the enclosure length, 0 if none.
     *
     */
    public long getLength() {
        return _length;
    }

    /**
     * Sets the enclosure length.
     * 

     * @param length the enclosure length to set, 0 if none.
     *
     */
    public void setLength(long length) {
        _length = length;
    }

    /**
     * Returns the enclosure type.
     * 

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

    /**
     * Sets the enclosure type.
     * 
     * @param type the enclosure type to set, null if none.
     *
     */
    public void setType(String type) {
        _type = type;
    }

}