com.sun.syndication.io.impl.OPML20Generator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rome-opml Show documentation

Support for OPML 1 and OPML 2 in ROME

The newest version!

/*
 * OPML20Generator.java
 *
 * Created on April 25, 2006, 5:31 PM
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 */
package com.sun.syndication.io.impl;

import com.sun.syndication.feed.WireFeed;
import com.sun.syndication.feed.opml.Opml;
import com.sun.syndication.feed.opml.Outline;
import com.sun.syndication.io.FeedException;

import org.jdom.Document;
import org.jdom.Element;


/**
 *
 * @author cooper
 */
public class OPML20Generator extends OPML10Generator {
    /** Creates a new instance of OPML20Generator */
    public OPML20Generator() {
    }

    /**
     * Returns the type of feed the generator creates.
     * 
     *
     * @return the type of feed the generator creates.
     * @see WireFeed for details on the format of this string.
     * 

     */
    public String getType() {
        return "opml_2.0";
    }

    /**
     * Creates an XML document (JDOM) for the given feed bean.
     * 
     *
     * @param feed the feed bean to generate the XML document from.
     * @return the generated XML document (JDOM).
     * @throws IllegalArgumentException thrown if the type of the given feed bean does not
     *         match with the type of the WireFeedGenerator.
     * @throws FeedException thrown if the XML Document could not be created.
     */
    public Document generate(WireFeed feed) throws IllegalArgumentException, FeedException {
        Document retValue;

        retValue = super.generate(feed);
        retValue.getRootElement().setAttribute("version", "2.0");

        return retValue;
    }

    protected Element generateHead(Opml opml) {
        Element retValue;

        retValue = super.generateHead(opml);

        Element docs = new Element("docs", opml.getDocs());
        retValue.addContent(docs);

        return retValue;
    }

    protected Element generateOutline(Outline outline) {
        Element retValue;

        retValue = super.generateOutline(outline);

        if (outline.getCreated() != null) {
            retValue.setAttribute("created", DateParser.formatRFC822(outline.getCreated()));
        }

        return retValue;
    }
}