| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| SyndEntrySource | 31 | 0 | - | 0 | 0 |
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package com.xpn.xwiki.plugin.feed; | |
| 21 | ||
| 22 | import java.util.Map; | |
| 23 | ||
| 24 | import com.sun.syndication.feed.synd.SyndEntry; | |
| 25 | import com.xpn.xwiki.XWikiContext; | |
| 26 | import com.xpn.xwiki.XWikiException; | |
| 27 | ||
| 28 | /** | |
| 29 | * Abstracts a strategy for computing the field values of a feed entry from a generic source. | |
| 30 | */ | |
| 31 | public interface SyndEntrySource | |
| 32 | { | |
| 33 | /** | |
| 34 | * Overwrites the current values of the given feed entry with new ones computed from the specified source object. | |
| 35 | * | |
| 36 | * @param entry the feed entry whose fields are going to be overwritten | |
| 37 | * @param obj the source for the new values to be set on the fields of the feed entry | |
| 38 | * @param params parameters to adjust the computation. Each concrete strategy may define its own (key, value) pairs | |
| 39 | * @param context the XWiki context | |
| 40 | * @throws XWikiException | |
| 41 | */ | |
| 42 | void source(SyndEntry entry, Object obj, Map<String, Object> params, XWikiContext context) throws XWikiException; | |
| 43 | } |