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

/**
 * Interface that defines the functionality to convert a SyndFeedImpl to a real feed (RSS or Atom)
 * and vice versa.
 * 
 * Each implementation knows how to deal with a specific type (version) of a real feed.
 * 

 * Implementations must be thread safe.
 * 

 * TODO: explain how developers can plugin their own implementations.
 * 

 *
 * @author Alejandro Abdelnur
 *
 */
public interface Converter {

    /**
     * Returns the type (version) of the real feed this converter handles.
     * 

     *
     * @see WireFeed for details on the format of this string.
     *      

     * @return the real feed type.
     *
     */
    public String getType();

    /**
     * Makes a deep copy/conversion of the values of a real feed into a SyndFeedImpl.
     * 

     * It assumes the given SyndFeedImpl has no properties set.
     * 

     *
     * @param feed real feed to copy/convert.
     * @param syndFeed the SyndFeedImpl that will contain the copied/converted values of the real
     *            feed.
     *
     */
    public void copyInto(WireFeed feed, SyndFeed syndFeed);

    /**
     * Creates real feed with a deep copy/conversion of the values of a SyndFeedImpl.
     * 
     *
     * @param syndFeed SyndFeedImpl to copy/convert value from.
     * @return a real feed with copied/converted values of the SyndFeedImpl.
     *
     */
    public WireFeed createRealFeed(SyndFeed syndFeed);

}