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

import java.util.Locale;

import org.jdom2.Document;

import com.rometools.rome.feed.WireFeed;

/**
 * Parses an XML document (JDOM) into a feed bean.
 * 
 * WireFeedParser instances must thread safe.
 * 

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

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

    /**
     * Returns the type of feed the parser handles.
     * 

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

     * @return the type of feed the parser handles.
     *
     */
    public String getType();

    /**
     * Inspects an XML Document (JDOM) to check if it can parse it.
     * 

     * It checks if the given document if the type of feeds the parser understands.
     * 

     *
     * @param document XML Document (JDOM) to check if it can be parsed by this parser.
     * @return true if the parser know how to parser this feed, false otherwise.
     *
     */
    public boolean isMyType(Document document);

    /**
     * Parses an XML document (JDOM Document) into a feed bean.
     * 
     *
     * @param document XML document (JDOM) to parse.
     * @param validate indicates if the feed should be strictly validated (NOT YET IMPLEMENTED).
     * @return the resulting feed bean.
     * @throws IllegalArgumentException thrown if the parser cannot handle the given feed type.
     * @throws FeedException thrown if a feed bean cannot be created out of the XML document (JDOM).
     *
     */
    public WireFeed parse(Document document, boolean validate, final Locale locale) throws IllegalArgumentException, FeedException;

}