com.rometools.rome.feed.module.SyModuleImpl 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.module;

import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import com.rometools.rome.feed.CopyFrom;
import com.rometools.rome.feed.impl.CopyFromHelper;
import com.rometools.utils.Dates;

/**
 * Syndication ModuleImpl, default implementation.
 * 
 *
 * @see Syndication module.
 */
public class SyModuleImpl extends ModuleImpl implements SyModule {

    private static final long serialVersionUID = 1L;

    private static final Set PERIODS = new HashSet();
    private static final CopyFromHelper COPY_FROM_HELPER;

    private String updatePeriod;
    private int updateFrequency;
    private Date updateBase;

    static {

        PERIODS.add(HOURLY);
        PERIODS.add(DAILY);
        PERIODS.add(WEEKLY);
        PERIODS.add(MONTHLY);
        PERIODS.add(YEARLY);

        final Map> basePropInterfaceMap = new HashMap>();
        basePropInterfaceMap.put("updatePeriod", String.class);
        basePropInterfaceMap.put("updateFrequency", Integer.TYPE);
        basePropInterfaceMap.put("updateBase", Date.class);
        final Map, Class> basePropClassImplMap = Collections., Class> emptyMap();
        COPY_FROM_HELPER = new CopyFromHelper(SyModule.class, basePropInterfaceMap, basePropClassImplMap);

    }

    public SyModuleImpl() {
        super(SyModule.class, URI);
    }

    /**
     * Returns the Syndication module update period.
     * 

     *
     * @return the Syndication module update period, null if none.
     *
     */
    @Override
    public String getUpdatePeriod() {
        return updatePeriod;
    }

    /**
     * Sets the Syndication module update period.
     * 

     *
     * @param updatePeriod the Syndication module update period to set, null if none.
     *
     */
    @Override
    public void setUpdatePeriod(final String updatePeriod) {
        if (!PERIODS.contains(updatePeriod)) {
            throw new IllegalArgumentException("Invalid period [" + updatePeriod + "]");
        }
        this.updatePeriod = updatePeriod;
    }

    /**
     * Returns the Syndication module update frequency.
     * 

     *
     * @return the Syndication module update frequency, null if none.
     *
     */
    @Override
    public int getUpdateFrequency() {
        return updateFrequency;
    }

    /**
     * Sets the Syndication module update frequency.
     * 

     *
     * @param updateFrequency the Syndication module update frequency to set, null if none.
     *
     */
    @Override
    public void setUpdateFrequency(final int updateFrequency) {
        this.updateFrequency = updateFrequency;
    }

    /**
     * Returns the Syndication module update base date.
     * 

     *
     * @return the Syndication module update base date, null if none.
     *
     */
    @Override
    public Date getUpdateBase() {
        return Dates.copy(updateBase);
    }

    /**
     * Sets the Syndication module update base date.
     * 
     *
     * @param updateBase the Syndication module update base date to set, null if none.
     *
     */
    @Override
    public void setUpdateBase(final Date updateBase) {
        this.updateBase = Dates.copy(updateBase);
    }

    @Override
    public Class getInterface() {
        return SyModule.class;
    }

    @Override
    public void copyFrom(final CopyFrom obj) {
        COPY_FROM_HELPER.copy(this, obj);
    }

}