com.rometools.rome.feed.synd.SyndImage 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 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.synd;

import com.rometools.rome.feed.CopyFrom;

/**
 * Bean interface for images of SyndFeedImpl feeds.
 * 
 *
 * @author Alejandro Abdelnur
 *
 */
public interface SyndImage extends Cloneable, CopyFrom {
    /**
     * Returns the image title.
     * 

     *
     * @return the image title, null if none.
     *
     */
    String getTitle();

    /**
     * Sets the image title.
     * 

     *
     * @param title the image title to set, null if none.
     *
     */
    void setTitle(String title);

    /**
     * Returns the image URL.
     * 

     *
     * @return the image URL, null if none.
     *
     */
    String getUrl();

    /**
     * Sets the image URL.
     * 

     *
     * @param url the image URL to set, null if none.
     *
     */
    void setUrl(String url);

    /**
     * Returns the image width.
     * 

     *
     * @return the image width, null if none.
     *
     */
    public Integer getWidth();

    /**
     * Sets the image width.
     * 

     *
     * @param width the image width to set, null if none.
     *
     */
    public void setWidth(Integer width);

    /**
     * Returns the image height.
     * 

     *
     * @return the image height, null if none.
     *
     */
    public Integer getHeight();

    /**
     * Sets the image height.
     * 

     *
     * @param height the image height to set, null if none.
     *
     */
    public void setHeight(Integer height);

    /**
     * Returns the image link.
     * 

     *
     * @return the image link, null if none.
     *
     */
    String getLink();

    /**
     * Sets the image link.
     * 

     *
     * @param link the image link to set, null if none.
     *
     */
    void setLink(String link);

    /**
     * Returns the image description.
     * 

     *
     * @return the image description, null if none.
     *
     */
    String getDescription();

    /**
     * Sets the image description.
     * 

     *
     * @param description the image description to set, null if none.
     *
     */
    void setDescription(String description);

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

}