View Javadoc

1   package com.sun.syndication.feed.sse;
2   
3   import java.util.Date;
4   
5   /***
6    * <pre><sx:history></pre>Element within <pre><sx:sync></pre>.
7    */
8   public class History {
9       // A date-time attribute.
10      private Date when;
11  
12      // A string attribute.
13      private String by;
14  
15      /***
16       * Get the date-time when the most recent modification took place.
17       * <p/>
18       * This is the date-time when the most recent modification took place. If this attribute is omitted the value
19       * defaults to the earliest time representable in RFC 822.
20       *
21       * @return the date-time when the most recent modification took place. 
22       */
23      public Date getWhen() {
24          // TODO: convert to the earliest time in RFC 822 (which is what?)
25  
26          return when;
27      }
28  
29      /***
30       * Set the date-time when the most recent modification took place.
31       * <p/>
32       * Either or both of the when or by attributes MUST be present; it is invalid to have neither.
33       *
34       * @param when the date-time when the most recent modification took place.
35       */
36      public void setWhen(Date when) {
37          this.when = when;
38      }
39  
40      /***
41       * Provides access to a text attribute identifying the unique endpoint that made the most recent modification. This
42       * SHOULD be some combination of user and device (so that a given user can edit a feed on multiple devices). This
43       * attribute is used programmatically to break ties in case two changes happened at the same time (within the same
44       * second).
45       * <p/>
46       * Either or both of the when or by must be present; it is invalid to have neither.
47       * <p/>
48       * If this attribute is omitted the value defaults to the empty string (which must be less than all other values for
49       * purposes of collation).
50       *
51       * @return A text attribute identifying the unique endpoint that made the most recent modification.
52       */
53      public String getBy() {
54          return by;
55      }
56  
57      /***
58       * Sets the endpoint that made the most recent modification.
59       * <p/>
60       * Either or both of the when or by attributes MUST be present; it is invalid to have neither.
61       *
62       * @param by the endpoint that made the most recent modification.
63       */
64      public void setBy(String by) {
65          this.by = by;
66      }
67  }