com.rometools.rome.io.impl.FeedParsers 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.io.impl;

import java.util.List;

import org.jdom2.Document;

import com.rometools.rome.io.WireFeedParser;

/**
 * Parses an XML document (JDOM Document) into a Feed.
 * 
 * It accepts all flavors of RSS (0.90, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0) and Atom 0.3 feeds.
 * 

 * The WireFeedParser is a liberal parser.
 * 

 * WireFeedParser instances are thread safe.
 * 

 * Parsers for a specific type must extend this class and register in the parser list. (Right now
 * registration is hardcoded in the WireFeedParser constructor).
 * 

 *
 * @author Alejandro Abdelnur
 *
 */
public class FeedParsers extends PluginManager {

    /**
     * WireFeedParser.classes= [className] ...
     *
     */
    public static final String FEED_PARSERS_KEY = "WireFeedParser.classes";

    /**
     * Creates a parser instance.
     * 

     *
     */
    public FeedParsers() {
        super(FEED_PARSERS_KEY);
    }

    public List getSupportedFeedTypes() {
        return getKeys();
    }

    /**
     * Finds the real parser type for the given document feed.
     * 
     *
     * @param document document feed to find the parser for.
     * @return the parser for the given document or null if there is no parser for that
     *         document.
     *
     */
    public WireFeedParser getParserFor(final Document document) {
        final List parsers = getPlugins();
        for (final WireFeedParser parser : parsers) {
            if (parser.isMyType(document)) {
                return parser;
            }
        }
        return null;
    }

    @Override
    protected String getKey(final WireFeedParser obj) {
        return obj.getType();
    }

}