/hudson-core/src/main/java/hudson/FeedAdapter.java

http://github.com/hudson/hudson · Java · 74 lines · 10 code · 7 blank · 57 comment · 0 complexity · 45ea7a0e2b5d6cba76ab9892642bae73 MD5 · raw file

  1. /*
  2. * The MIT License
  3. *
  4. * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
  5. *
  6. * Permission is hereby granted, free of charge, to any person obtaining a copy
  7. * of this software and associated documentation files (the "Software"), to deal
  8. * in the Software without restriction, including without limitation the rights
  9. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. * copies of the Software, and to permit persons to whom the Software is
  11. * furnished to do so, subject to the following conditions:
  12. *
  13. * The above copyright notice and this permission notice shall be included in
  14. * all copies or substantial portions of the Software.
  15. *
  16. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. * THE SOFTWARE.
  23. */
  24. package hudson;
  25. import java.util.Calendar;
  26. /**
  27. * Provides a RSS feed view of the data.
  28. *
  29. * <p>
  30. * This interface allows data structure of any form to be exposed
  31. * as RSS feeds, just by writing a stateless singleton adapter code that
  32. * implements this interface.
  33. *
  34. * @author Kohsuke Kawaguchi
  35. */
  36. public interface FeedAdapter<E> {
  37. /**
  38. * Gets the human readable title of the entry.
  39. * In RSS readers, this is usually displayed like an e-mail subject.
  40. */
  41. String getEntryTitle(E entry);
  42. /**
  43. * Gets the URL that represents this entry.
  44. * Relative to context root of the Hudson.
  45. */
  46. String getEntryUrl(E entry);
  47. /**
  48. * Unique ID of each entry.
  49. * RSS readers use this to determine what feeds are new and what are not.
  50. *
  51. * This needs to produce a tag URL as per RFC 4151, required by Atom 1.0.
  52. */
  53. String getEntryID(E entry);
  54. /**
  55. * (Potentially lengthy) plain text to be attached to the feed.
  56. * Can be null.
  57. */
  58. String getEntryDescription(E entry);
  59. /**
  60. * Timestamp of the last change in this entry.
  61. */
  62. Calendar getEntryTimestamp(E entry);
  63. /**
  64. * Author of this entry.
  65. */
  66. String getEntryAuthor(E entry);
  67. }