com.rometools.rome.feed.synd.SyndContent 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.
 *
 * 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 content of SyndFeedImpl entries.
 */
public interface SyndContent extends Cloneable, CopyFrom {
    /**
     * Returns the content type.
     * 
     * When used for the description of an entry, if null 'text/plain' must be assumed.
     * 

     *
     * @return the content type, null if none.
     *
     */
    String getType();

    /**
     * Sets the content type.
     * 

     * When used for the description of an entry, if null 'text/plain' must be assumed.
     * 

     *
     * @param type the content type to set, null if none.
     *
     */
    void setType(String type);

    /**
     * Gets the content mode (needed for Atom 0.3 support).
     *
     * @return type the content, null if none.
     *
     */
    String getMode();

    /**
     * Sets the content mode (needed for Atom 0.3 support).
     *
     * @param mode the content mode to set, null if none.
     *
     */
    void setMode(String mode);

    /**
     * Returns the content value.
     * 

     *
     * @return the content value, null if none.
     *
     */
    String getValue();

    /**
     * Sets the content value.
     * 

     *
     * @param value the content value to set, null if none.
     *
     */
    void setValue(String value);

    /**
     * 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;

}