| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| FeedDecorator |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright (c) 2003-2011, Simon Brown | |
| 3 | * All rights reserved. | |
| 4 | * | |
| 5 | * Redistribution and use in source and binary forms, with or without | |
| 6 | * modification, are permitted provided that the following conditions are met: | |
| 7 | * | |
| 8 | * - Redistributions of source code must retain the above copyright | |
| 9 | * notice, this list of conditions and the following disclaimer. | |
| 10 | * | |
| 11 | * - Redistributions in binary form must reproduce the above copyright | |
| 12 | * notice, this list of conditions and the following disclaimer in | |
| 13 | * the documentation and/or other materials provided with the | |
| 14 | * distribution. | |
| 15 | * | |
| 16 | * - Neither the name of Pebble nor the names of its contributors may | |
| 17 | * be used to endorse or promote products derived from this software | |
| 18 | * without specific prior written permission. | |
| 19 | * | |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
| 21 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 22 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 23 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |
| 24 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
| 25 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
| 26 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
| 27 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
| 28 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
| 29 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
| 30 | * POSSIBILITY OF SUCH DAMAGE. | |
| 31 | */ | |
| 32 | package net.sourceforge.pebble.api.decorator; | |
| 33 | ||
| 34 | import com.sun.syndication.feed.synd.SyndEntry; | |
| 35 | import com.sun.syndication.feed.synd.SyndFeed; | |
| 36 | import net.sourceforge.pebble.domain.Blog; | |
| 37 | import net.sourceforge.pebble.domain.BlogEntry; | |
| 38 | import net.sourceforge.pebble.domain.Response; | |
| 39 | ||
| 40 | /** | |
| 41 | * A feed decorator plugin, used by plugins to modify feeds | |
| 42 | * | |
| 43 | * @author James Roper | |
| 44 | */ | |
| 45 | public interface FeedDecorator { | |
| 46 | ||
| 47 | /** | |
| 48 | * Decorate a synd feed element. This will be called after decoration of all the synd entries. | |
| 49 | * | |
| 50 | * @param feed The feed to decorate | |
| 51 | * @param blog The blog the feed is for | |
| 52 | */ | |
| 53 | void decorate(SyndFeed feed, Blog blog); | |
| 54 | ||
| 55 | /** | |
| 56 | * Decorate a synd feed element, for response feeds. This will be called after decoration of all the synd entries. | |
| 57 | * | |
| 58 | * @param feed The feed to decorate | |
| 59 | * @param blog The blog the feed is for | |
| 60 | * @param blogEntry The blog entry the feed is for | |
| 61 | */ | |
| 62 | void decorate(SyndFeed feed, Blog blog, BlogEntry blogEntry); | |
| 63 | ||
| 64 | /** | |
| 65 | * Decorate a synd entry element. | |
| 66 | * | |
| 67 | * @param entry The entry to decorate | |
| 68 | * @param blog The blog the feed is for | |
| 69 | * @param blogEntry The blog entry the entry is for | |
| 70 | */ | |
| 71 | void decorate(SyndEntry entry, Blog blog, BlogEntry blogEntry); | |
| 72 | ||
| 73 | /** | |
| 74 | * Decorate a synd entry element, for response feeds. | |
| 75 | * | |
| 76 | * @param entry The entry to decorate | |
| 77 | * @param blog The blog the feed is for | |
| 78 | * @param response The response the entry is for | |
| 79 | */ | |
| 80 | void decorate(SyndEntry entry, Blog blog, Response response); | |
| 81 | ||
| 82 | } |