Class Sharing
- java.lang.Object
-
- com.rometools.modules.sse.modules.SSEModule
-
- com.rometools.modules.sse.modules.Sharing
-
- All Implemented Interfaces:
CopyFrom,Module,Serializable,Cloneable
public class Sharing extends SSEModule
Element within RSS
or OPML
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringNAMEstatic StringORDERED_ATTRIBUTEstatic StringSINCE_ATTRIBUTEstatic StringUNTIL_ATTRIBUTEstatic StringVERSIONstatic StringVERSION_ATTRIBUTEstatic StringWINDOW_ATTRIBUTE-
Fields inherited from class com.rometools.modules.sse.modules.SSEModule
NAMESPACES, PREFIX, SSE_NS, SSE_SCHEMA_URI
-
-
Constructor Summary
Constructors Constructor Description Sharing()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcopyFrom(CopyFrom obj)BooleangetOrdered()ordered An optional, Boolean attribute.RelatedgetRelated()DategetSince()since An optional date-time attribute.DategetUntil()until An optional date-time attribute.ObjectgetVersion()IntegergetWindow()Provides an Integer that expresses the size of the window of change history kept by the publisher.voidsetOrdered(Boolean ordered)Set whether subscribers MUST tread the item list as an ordered set.voidsetRelated(Related related)voidsetSince(Date since)Sets the optional date-time attribute where all items updated on or after this date-time are included in the feed.voidsetUntil(Date until)Set the date where items updated after this date are not included in the feed.voidsetVersion(String version)voidsetWindow(Integer window)Set an Integer that expresses the size of the window of change history kept by the publisher.-
Methods inherited from class com.rometools.modules.sse.modules.SSEModule
clone, getInterface, getUri
-
-
-
-
Field Detail
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
UNTIL_ATTRIBUTE
public static final String UNTIL_ATTRIBUTE
- See Also:
- Constant Field Values
-
SINCE_ATTRIBUTE
public static final String SINCE_ATTRIBUTE
- See Also:
- Constant Field Values
-
ORDERED_ATTRIBUTE
public static final String ORDERED_ATTRIBUTE
- See Also:
- Constant Field Values
-
WINDOW_ATTRIBUTE
public static final String WINDOW_ATTRIBUTE
- See Also:
- Constant Field Values
-
VERSION_ATTRIBUTE
public static final String VERSION_ATTRIBUTE
- See Also:
- Constant Field Values
-
VERSION
public static final String VERSION
- See Also:
- Constant Field Values
-
-
Method Detail
-
copyFrom
public void copyFrom(CopyFrom obj)
-
getOrdered
public Boolean getOrdered()
ordered An optional, Boolean attribute. If present and its value is "true" (lower-case), subscribers MUST treat the item list as an ordered set (see section 3.2). If this attribute is omitted or blank, it is assumed that this is an unordered feed.- Returns:
- a Boolean indicating if subscribers must treat the item list as an ordered set.
-
setOrdered
public void setOrdered(Boolean ordered)
Set whether subscribers MUST tread the item list as an ordered set.- Parameters:
ordered- whether subscribers MUST tread the item list as an ordered set.
-
getWindow
public Integer getWindow()
Provides an Integer that expresses the size of the window of change history kept by the publisher. Subscribers MAY use this value to determine the frequency with which they must read a feed.- Returns:
- an Integer that expresses the size of the window of change history kept by the publisher.
-
setWindow
public void setWindow(Integer window)
Set an Integer that expresses the size of the window of change history kept by the publisher.- Parameters:
window- an Integer that expresses the size of the window of change history kept by the publisher.
-
getSince
public Date getSince()
since An optional date-time attribute. All items updated on or after this date-time are included in the feed. If not present or null, the "beginning of time" is assumed and the feed contains the node's complete item set as of the until date-time.- Returns:
- An optional date-time attribute.
-
setSince
public void setSince(Date since)
Sets the optional date-time attribute where all items updated on or after this date-time are included in the feed.- Parameters:
since- An optional date-time attribute.
-
getUntil
public Date getUntil()
until An optional date-time attribute. Items updated after this date are not included in the feed. The publisher must guarantee that the value of until will increase if any items in the feed are updated. If this attribute is omitted or blank, the subscriber cannot make assumptions about when the feed was updated.- Returns:
- the date where items updated after this date are not included in the feed.
-
setUntil
public void setUntil(Date until)
Set the date where items updated after this date are not included in the feed.- Parameters:
until- the date where items updated after this date are not included in the feed.
-
setRelated
public void setRelated(Related related)
-
getRelated
public Related getRelated()
-
setVersion
public void setVersion(String version)
-
getVersion
public Object getVersion()
-
-