diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Article.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Article.java index 78b671e..88b303e 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Article.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Article.java @@ -18,13 +18,16 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "article" Object type indicates that the Object is an article, such as a news article, a knowledge base entry, or other similar construct. + * The "article" Object type indicates that the Object is an article, such as a news article, a + * knowledge base entry, or other similar construct. *

*

- * Articles generally consist of paragraphs of text, in some cases incorporating embedded media such as photos and inline hyperlinks to other resources. + * Articles generally consist of paragraphs of text, in some cases incorporating embedded media such + * as photos and inline hyperlinks to other resources. *

*

- * The "Article" Object type is identified by the URL http://activitystrea.ms/schema/1.0/article. + * The "Article" Object type is identified by the URL + * http://activitystrea.ms/schema/1.0/article. *

*

* An article has the following additional components: @@ -36,8 +39,9 @@ package org.rometools.feed.module.activitystreams.types; *

Name
*
The title of the article. Represented by the Name component of the base Object Construct.
*
Content
- *
The main body content of the article. Represented in JSON as a property called content whose value is a JSON string containing a fragment of - * HTML that represents the content.
+ *
The main body content of the article. Represented in JSON as a property called + * content whose value is a JSON string containing a fragment of HTML that represents the + * content.
* * * diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Audio.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Audio.java index db8b2b2..5d0c533 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Audio.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Audio.java @@ -21,7 +21,8 @@ package org.rometools.feed.module.activitystreams.types; * The "audio" Object type represents audio content. *

*

- * The "audio" Object type is identified by the URI http://activitystrea.ms/schema/1.0/audio. + * The "audio" Object type is identified by the URI + * http://activitystrea.ms/schema/1.0/audio. *

*

* An audio has the following additional components: @@ -31,11 +32,13 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Audio Stream Link
- *
A Media Link Construct linking to the audio content itself. Represented in JSON as a property called stream whose value is a JSON object with - * properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]
+ *
A Media Link Construct linking to the audio content itself. Represented in JSON as a property + * called stream whose value is a JSON object with properties as defined in [TODO: xref the + * JSON serialization of a Media Link Construct]
*
Embed Code
- *
An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI for the audio stream. Represented in JSON as a property - * called embedCode whose value is a JSON string containing the fragment of HTML.
+ *
An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI + * for the audio stream. Represented in JSON as a property called embedCode whose value is + * a JSON string containing the fragment of HTML.
*
* * @author robert.cooper diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Bookmark.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Bookmark.java index 4827c47..a399811 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Bookmark.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Bookmark.java @@ -21,27 +21,34 @@ import com.sun.syndication.feed.atom.Link; /** *

- * The "bookmark" Object type represents a pointer to some URL -- typically a web page. In most cases, a bookmark is specific to a given user and contains - * metadata chosen by that user. Bookmark Objects are similar in principle to the concept of bookmarks or favorites in a web browser. A bookmark represents a - * pointer to the URL, not the URL or the associated resource itself. + * The "bookmark" Object type represents a pointer to some URL -- typically a web page. In most + * cases, a bookmark is specific to a given user and contains metadata chosen by that user. Bookmark + * Objects are similar in principle to the concept of bookmarks or favorites in a web browser. A + * bookmark represents a pointer to the URL, not the URL or the associated resource itself. *

*

- * When dealing with bookmarks it is important to note the distinction between the title, description, and URL of the bookmark itself and the title, content, - * and URL of the resource that is the target of the bookmark. In some implementations these MAY be the same, but bookmark managers often allow a user to edit - * the title and description of his or her own bookmarks to differ from the metadata on the target itself. + * When dealing with bookmarks it is important to note the distinction between the title, + * description, and URL of the bookmark itself and the title, content, and URL of the resource that + * is the target of the bookmark. In some implementations these MAY be the same, but bookmark + * managers often allow a user to edit the title and description of his or her own bookmarks to + * differ from the metadata on the target itself. *

*

- * Some implementations refer to this Object type as a "link". This specification uses the term "bookmark" to avoid confusion with the general concept of - * hyperlinks which apply to all Object types. + * Some implementations refer to this Object type as a "link". This specification uses the term + * "bookmark" to avoid confusion with the general concept of hyperlinks which apply to all Object + * types. *

*

- * Since bookmarks are often specific to a particular user, even though multiple users might have bookmarks pointing at the same resource, it is appropriate to - * use the "post" Verb to describe the publication of such a bookmark. The "mark as favorite" Verb SHOULD be used when a user flags another user's bookmark as - * being a favorite without creating his own bookmark, or when a user flags his own bookmark as being a favorite as a special classification within his own - * bookmark collection. + * Since bookmarks are often specific to a particular user, even though multiple users might have + * bookmarks pointing at the same resource, it is appropriate to use the "post" Verb to describe the + * publication of such a bookmark. The "mark as favorite" Verb SHOULD be used when a user flags + * another user's bookmark as being a favorite without creating his own bookmark, or when a user + * flags his own bookmark as being a favorite as a special classification within his own bookmark + * collection. *

*

- * The "bookmark" Object type is identified by the URI http://activitystrea.ms/schema/1.0/bookmark. + * The "bookmark" Object type is identified by the URI + * http://activitystrea.ms/schema/1.0/bookmark. *

*

* A bookmark has the following additional components: @@ -51,14 +58,16 @@ import com.sun.syndication.feed.atom.Link; *

*
*
Title
- *
The title of the bookmark, as entered by the user who created the bookmark. Represented by the Name component of the base Object Construct. Publishers - * MAY use the title of the target resource as a default for this property where a user hasn't entered a customized value.
+ *
The title of the bookmark, as entered by the user who created the bookmark. Represented by + * the Name component of the base Object Construct. Publishers MAY use the title of the target + * resource as a default for this property where a user hasn't entered a customized value.
*
Target URL
- *
The URL of the item that is the target of the bookmark. Represented in JSON by a property called targetUrl whose value is a JSON string - * containing the target URL.
+ *
The URL of the item that is the target of the bookmark. Represented in JSON by a property + * called targetUrl whose value is a JSON string containing the target URL.
*
Thumbnail
- *
The URL and metadata for a thumbnail version of the page. Represented by the Representative Image component of the base Object Construct. Processors MAY - * ignore thumbnails that are of an inappropriate size for their user interface.
+ *
The URL and metadata for a thumbnail version of the page. Represented by the Representative + * Image component of the base Object Construct. Processors MAY ignore thumbnails that are of an + * inappropriate size for their user interface.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Comment.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Comment.java index ffba3ab..a0842e6 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Comment.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Comment.java @@ -22,10 +22,12 @@ package org.rometools.feed.module.activitystreams.types; * The "comment" object type represents a textual response to another object. *

*

- * The comment object type MUST NOT be used for other kinds of replies, such as video replies or reviews. + * The comment object type MUST NOT be used for other kinds of replies, such as video replies or + * reviews. *

*

- * The "comment" object type is identified by the URI http://activitystrea.ms/schema/1.0/comment. + * The "comment" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/comment. *

*

* A comment has the following additional components: @@ -35,13 +37,16 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Subject
- *
The subject of the comment. Represented by the Name component of the base Object Construct. Many systems do not have the concept of a title or subject - * for a comment; such systems MUST omit the Name component. Processors SHOULD refer to such comments as simply being "a comment", with appropriate - * localization, if they are to be described in a sentence.
+ *
The subject of the comment. Represented by the Name component of the base Object Construct. + * Many systems do not have the concept of a title or subject for a comment; such systems MUST omit + * the Name component. Processors SHOULD refer to such comments as simply being "a comment", with + * appropriate localization, if they are to be described in a sentence.
*
Content
- *
The content of the comment. Represented in JSON as a property called content whose value is a JSON string containing a fragment of HTML that - * represents the content. Publishers SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's own HTML pages, including - * any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text.
+ *
The content of the comment. Represented in JSON as a property called content whose + * value is a JSON string containing a fragment of HTML that represents the content. Publishers + * SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's + * own HTML pages, including any links that the service automatically adds. Processors MAY remove + * all HTML markup and consider the comment to be plain text.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Event.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Event.java index 30ef9f8..3ea5e01 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Event.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Event.java @@ -19,10 +19,12 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "event" object type represents an event that occurs in a certain place during a particular interval of time. + * The "event" object type represents an event that occurs in a certain place during a particular + * interval of time. *

*

- * The object type URL for the "event" object type is http://activitystrea.ms/schema/1.0/event. + * The object type URL for the "event" object type is + * http://activitystrea.ms/schema/1.0/event. *

*

* An event has the following additional components: @@ -32,11 +34,13 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Start Date and Time
- *
The date and time that the event begins. Represented in JSON as a property called startTime whose value is JSON string containing a W3CDTF - * timestamp. [TODO: Reference W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]
+ *
The date and time that the event begins. Represented in JSON as a property called + * startTime whose value is JSON string containing a W3CDTF timestamp. [TODO: Reference + * W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]
*
End Date and Time
- *
The date and time that the event ends. Represented in JSON as a property called endTime whose value is JSON string containing a W3CDTF - * timestamp. [TODO: Reference W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]
+ *
The date and time that the event ends. Represented in JSON as a property called + * endTime whose value is JSON string containing a W3CDTF timestamp. [TODO: Reference + * W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/File.java b/src/main/java/org/rometools/feed/module/activitystreams/types/File.java index 43ded46..5c120ad 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/File.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/File.java @@ -19,11 +19,13 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "file" Object type represents some document or other file with no additional machine-readable semantics. + * The "file" Object type represents some document or other file with no additional machine-readable + * semantics. *

*

- * It is intended that this type be used as a base type for other Objects that manifest as files, so that additional semantics can be added while providing a - * fallback ability for clients that do not support the more specific Object type. + * It is intended that this type be used as a base type for other Objects that manifest as files, so + * that additional semantics can be added while providing a fallback ability for clients that do not + * support the more specific Object type. *

*

* The "file" Object type is identified by the URI http://activitystrea.ms/schema/1.0/file. @@ -36,11 +38,11 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Associated File URL
- *
The URL of the file described by this Object Construct. Represented in JSON by a property called fileUrl whose value is a JSON string containing - * the URL.
+ *
The URL of the file described by this Object Construct. Represented in JSON by a property + * called fileUrl whose value is a JSON string containing the URL.
*
File MIME Type
- *
The MIME type of the file described by this Object Construct. Represented in JSON by a property called mimeType whose value is a JSON string - * containing the MIME type.
+ *
The MIME type of the file described by this Object Construct. Represented in JSON by a + * property called mimeType whose value is a JSON string containing the MIME type.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Folder.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Folder.java index fc1980b..5c73e4f 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Folder.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Folder.java @@ -19,11 +19,12 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "folder" object type represents a collection of files or media objects. This is similar to the "photo album" object type, but not specifically - * representing a collection of "photos." + * The "folder" object type represents a collection of files or media objects. This is similar to + * the "photo album" object type, but not specifically representing a collection of "photos." *

*

- * The "folder" object type is identified by the URI http://activitystrea.ms/schema/1.0/folder. + * The "folder" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/folder. *

*

* A folder has the following additional components: @@ -33,8 +34,9 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Preview Image Link
- *
A Media Link Construct describing an image file that can be used as a preview image for the folder. Represented by the Representative Image component of - * the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.
+ *
A Media Link Construct describing an image file that can be used as a preview image for the + * folder. Represented by the Representative Image component of the base Object Construct. + * Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Group.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Group.java index b1972ba..5694179 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Group.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Group.java @@ -19,10 +19,12 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "group" Object type represents a social networking group. A group is a collection of people which people can join and leave. + * The "group" Object type represents a social networking group. A group is a collection of people + * which people can join and leave. *

*

- * The "group" Object type is identified by the URI http://activitystrea.ms/schema/1.0/group. + * The "group" Object type is identified by the URI + * http://activitystrea.ms/schema/1.0/group. *

*

* A group has no additional components. diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/HasLocation.java b/src/main/java/org/rometools/feed/module/activitystreams/types/HasLocation.java index 688a36e..854f706 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/HasLocation.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/HasLocation.java @@ -22,15 +22,19 @@ import org.rometools.feed.module.portablecontacts.ContactModule; /** *

- * Location is a concept which can be used inside the atom:entry level, atom:author and activity:object. Location can be specified via geographic coordinates, a - * street address, a free-form location name or a combination of these. Geographic coordinates should be included as a geo:point element as described by the - * GeoRSS specification. Addresses should be included using a poco:address element defined at Portable Contacts specification. The entry level location - * represents the location of the author at the time the activity was performed. The author level location represents the primary location of the author. - * Finally, the location within other objects represents the physical location of those objects. All location fields are optional. For free form addresses use - * the poco:formatted field. + * Location is a concept which can be used inside the atom:entry level, atom:author and + * activity:object. Location can be specified via geographic coordinates, a street address, a + * free-form location name or a combination of these. Geographic coordinates should be included as a + * geo:point element as described by the GeoRSS specification. Addresses should be included using a + * poco:address element defined at Portable Contacts specification. The entry level location + * represents the location of the author at the time the activity was performed. The author level + * location represents the primary location of the author. Finally, the location within other + * objects represents the physical location of those objects. All location fields are optional. For + * free form addresses use the poco:formatted field. *

*

- * Figure 1 (Location Example) + * Figure 1 (Location + * Example) *

*

*
@@ -77,7 +81,8 @@ import org.rometools.feed.module.portablecontacts.ContactModule; *

* * - * * *
 Figure 1: Location Example 
+ * 		 Figure 1: Location + * Example 
*
diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Mood.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Mood.java index 9773f0d..28e2b37 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Mood.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Mood.java @@ -19,8 +19,10 @@ package org.rometools.feed.module.activitystreams.types; /** * *

- * Mood describes the mood of the user when the activity was performed. This is usually collected via an extra field in the user interface used to perform the - * activity. For the purpose of this schema, a mood is a freeform, short mood keyword or phrase along with an optional mood icon image. + * Mood describes the mood of the user when the activity was performed. This is usually collected + * via an extra field in the user interface used to perform the activity. For the purpose of this + * schema, a mood is a freeform, short mood keyword or phrase along with an optional mood icon + * image. *

*

* Moods are included via a mood element in the namespace http://activitystrea.ms/context/. @@ -29,8 +31,9 @@ package org.rometools.feed.module.activitystreams.types; * The content of the mood element is the mood keyword or phrase. *

*

- * The mood element may have an optional icon attribute which contains the URL of a mood icon image. The mood icon image SHOULD be small and - * appropriate to be displayed alongside the mood keyword at a normal text size. + * The mood element may have an optional icon attribute which contains the URL of a mood + * icon image. The mood icon image SHOULD be small and appropriate to be displayed alongside the + * mood keyword at a normal text size. *

* * @author robert.cooper diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Note.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Note.java index a242a1c..b058bab 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Note.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Note.java @@ -19,12 +19,14 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "note" Object type represents short-form text messages. This Object type is intended for use in "micro-blogging" and in systems where users are invited - * to publish short, often plain-text messages whose useful lifespan is generally shorter than that of an article or weblog entry. + * The "note" Object type represents short-form text messages. This Object type is intended for use + * in "micro-blogging" and in systems where users are invited to publish short, often plain-text + * messages whose useful lifespan is generally shorter than that of an article or weblog entry. *

*

- * A note is similar in structure to an article, but it does not have a title and its body tends to be shorter. Applications will often display the entire - * content of a note in an activity stream UI, whereas they MAY display only the title or the title and summary for a weblog entry. + * A note is similar in structure to an article, but it does not have a title and its body tends to + * be shorter. Applications will often display the entire content of a note in an activity stream + * UI, whereas they MAY display only the title or the title and summary for a weblog entry. *

*

* The "note" Object type is identified by the URI http://activitystrea.ms/schema/1.0/note. @@ -37,9 +39,11 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Content
- *
The content of the comment. Represented in JSON as a property called content whose value is a JSON string containing a fragment of HTML that - * represents the content. Publishers SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's own HTML pages, including - * any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text.
+ *
The content of the comment. Represented in JSON as a property called content whose + * value is a JSON string containing a fragment of HTML that represents the content. Publishers + * SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's + * own HTML pages, including any links that the service automatically adds. Processors MAY remove + * all HTML markup and consider the comment to be plain text.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Person.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Person.java index 48cb650..3d64fdd 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Person.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Person.java @@ -21,11 +21,12 @@ import com.sun.syndication.feed.atom.Link; /** *

- * The "person" Object type represents a user account. This is often represents a person, but might also be a company or fictitious character that is being - * represented by a user account. + * The "person" Object type represents a user account. This is often represents a person, but might + * also be a company or fictitious character that is being represented by a user account. *

*

- * The "person" Object type is identified by the URI http://activitystrea.ms/schema/1.0/person. + * The "person" Object type is identified by the URI + * http://activitystrea.ms/schema/1.0/person. *

*

* A person has the following additional components: @@ -35,10 +36,12 @@ import com.sun.syndication.feed.atom.Link; *

*
*
Display Name
- *
A name that can be used for the person in the user interface. This is often a name by which the individual is known in a given context; no restriction is - * placed on what kind of name may be used here. Represented by the Name component of the base Object Construct.
+ *
A name that can be used for the person in the user interface. This is often a name by which + * the individual is known in a given context; no restriction is placed on what kind of name may be + * used here. Represented by the Name component of the base Object Construct.
*
Avatar
- *
A link to an "avatar" or "userpic" image for the user. Represented by the Representative Image component of the base Object Construct.
+ *
A link to an "avatar" or "userpic" image for the user. Represented by the Representative + * Image component of the base Object Construct.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Photo.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Photo.java index d73ecad..1d0f641 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Photo.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Photo.java @@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types; * The "photo" object type represents a graphical still image. *

*

- * The "photo" Object type is identified by the URI http://activitystrea.ms/schema/1.0/photo. + * The "photo" Object type is identified by the URI + * http://activitystrea.ms/schema/1.0/photo. *

*

* A photo has the following additional components: @@ -32,11 +33,14 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Thumbnail
- *
A link to a thumbnail version of the image. Represented by the Representative Image component of the base Object Construct. Processors MAY ignore - * thumbnails that are of an inappropriate size for their user interface.
+ *
A link to a thumbnail version of the image. Represented by the Representative Image component + * of the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size + * for their user interface.
*
Larger Image
- *
A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo intended for standalone viewing. Represented in JSON as a - * property named fullImage whose value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct].
+ *
A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo + * intended for standalone viewing. Represented in JSON as a property named fullImage whose + * value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a + * Media Link Construct].
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/PhotoAlbum.java b/src/main/java/org/rometools/feed/module/activitystreams/types/PhotoAlbum.java index e3f8d90..faa42e1 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/PhotoAlbum.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/PhotoAlbum.java @@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types; * The "photo album" object type represents a collection of images. *

*

- * The "photo album" object type is identified by the URI http://activitystrea.ms/schema/1.0/photo-album. + * The "photo album" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/photo-album. *

*

* The photo album has the following additional components: @@ -32,8 +33,9 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Preview Image Link
- *
A Media Link Construct describing an image file that can be used as a preview image for the album. Represented by the Representative Image component of - * the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.
+ *
A Media Link Construct describing an image file that can be used as a preview image for the + * album. Represented by the Representative Image component of the base Object Construct. Processors + * MAY ignore thumbnails that are of an inappropriate size for their user interface.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Place.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Place.java index 70078af..c0d34bd 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Place.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Place.java @@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types; * The "place" object type represents a location on Earth. *

*

- * The "place" object type is identified by the URI http://activitystrea.ms/schema/1.0/place. + * The "place" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/place. *

*

* A place has the following additional components: @@ -32,11 +33,13 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Latitude
- *
The latitude of the place as a point on Earth. Represented in JSON as a property named latitude whose value is a JSON number containing a - * decimal representation of the latitude in degrees.
+ *
The latitude of the place as a point on Earth. Represented in JSON as a property named + * latitude whose value is a JSON number containing a decimal representation of the + * latitude in degrees.
*
Longitude
- *
The longitude of the place as a point on Earth. Represented in JSON as a property named longitude whose value is a JSON number containing a - * decimal representation of the longitude in degrees.
+ *
The longitude of the place as a point on Earth. Represented in JSON as a property named + * longitude whose value is a JSON number containing a decimal representation of the + * longitude in degrees.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Playlist.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Playlist.java index ec40303..9d65457 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Playlist.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Playlist.java @@ -20,10 +20,12 @@ package org.rometools.feed.module.activitystreams.types; /** * *

- * The "playlist" object type represents an ordered list of time-based media items, such as video and audio objects. + * The "playlist" object type represents an ordered list of time-based media items, such as video + * and audio objects. *

*

- * The "playlist" object type is identified by the URI http://activitystrea.ms/schema/1.0/playlist. + * The "playlist" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/playlist. *

*

* A playlist has no additional components. diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Product.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Product.java index 0de1c8b..8c039ca 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Product.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Product.java @@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types; * The "product" object type represents a commercial good or service. *

*

- * The "product" object type is identified by the URI http://activitystrea.ms/schema/1.0/product. + * The "product" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/product. *

*

* A product has the following additional components: @@ -32,11 +33,14 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Thumbnail
- *
A link to a thumbnail-sized image that contains a photo of the product. Represented by the Representative Image component of the base Object Construct. - * Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.
+ *
A link to a thumbnail-sized image that contains a photo of the product. Represented by the + * Representative Image component of the base Object Construct. Processors MAY ignore thumbnails + * that are of an inappropriate size for their user interface.
*
Larger Image
- *
A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo of the product. Represented in JSON as a property named - * fullImage whose value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct].
+ *
A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo of + * the product. Represented in JSON as a property named fullImage whose value is a JSON + * object with properties as defined in [TODO: xref the JSON serialization of a Media Link + * Construct].
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Review.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Review.java index ffe6dcc..81f7971 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Review.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Review.java @@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types; * The "review" object type represents a primarily prose-based commentary on another object. *

*

- * The "review" object type is identified by the URI http://activitystrea.ms/schema/1.0/review. + * The "review" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/review. *

*

* A review has the following additional components: @@ -32,18 +33,23 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Title
- *
The title of the review. Represented by the Name component of the base Object Construct. Many systems do not have the concept of a title for a review; - * such systems MUST omit the Name component. Processors SHOULD refer to such reviews as simply being "a review", with appropriate localization, if they are to - * be described in a sentence.
+ *
The title of the review. Represented by the Name component of the base Object Construct. Many + * systems do not have the concept of a title for a review; such systems MUST omit the Name + * component. Processors SHOULD refer to such reviews as simply being "a review", with appropriate + * localization, if they are to be described in a sentence.
*
Content
- *
The content of the comment. Represented in JSON as a property called content whose value is a JSON string containing a fragment of HTML that - * represents the content. Publishers SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's own HTML pages, including - * any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text.
+ *
The content of the comment. Represented in JSON as a property called content whose + * value is a JSON string containing a fragment of HTML that represents the content. Publishers + * SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's + * own HTML pages, including any links that the service automatically adds. Processors MAY remove + * all HTML markup and consider the comment to be plain text.
*
Reviewed Object
- *
The Object Construct representing the item that this review applies to. Represented as the In Reply To Object component of the base Object Construct.
+ *
The Object Construct representing the item that this review applies to. Represented as the In + * Reply To Object component of the base Object Construct.
*
Rating
- *
A rating for the item, given as a number between 1.0 and 5.0 inclusive with one decimal place of precision. Represented in JSON as a property called - * rating whose value is a JSON number giving the rating.
+ *
A rating for the item, given as a number between 1.0 and 5.0 inclusive with one decimal place + * of precision. Represented in JSON as a property called rating whose value is a JSON + * number giving the rating.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Service.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Service.java index c9748bd..27a1d4b 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Service.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Service.java @@ -19,11 +19,13 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "service" Object type represents a website, personal website or blog, business, brand, or other entity that performs some kind of work for other - * entities, people, or services, or acts as kind of container for other objects. + * The "service" Object type represents a website, personal website or blog, business, brand, or + * other entity that performs some kind of work for other entities, people, or services, or acts as + * kind of container for other objects. *

*

- * The "service" Object type is identified by the URI http://activitystrea.ms/schema/1.0/service. + * The "service" Object type is identified by the URI + * http://activitystrea.ms/schema/1.0/service. *

*

* A service has the following additional components: @@ -33,9 +35,11 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
icon
- *
A Media Link Construct representing a link to a small image representing the service. Represented in JSON as a property named icon whose value - * is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]. The linked image MUST have an aspect ratio of - * one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size.
+ *
A Media Link Construct representing a link to a small image representing the service. + * Represented in JSON as a property named icon whose value is a JSON object with + * properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]. The + * linked image MUST have an aspect ratio of one (horizontal) to one (vertical) and SHOULD be + * suitable for presentation at a small size.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Song.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Song.java index 0f3495a..697bbb5 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Song.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Song.java @@ -21,13 +21,16 @@ package org.rometools.feed.module.activitystreams.types; * The "song" Object type represents a song or a recording of a song. *

*

- * Objects of type Song might contain information about the song or recording, or they might contain some representation of the recording itself. In the latter - * case, the song SHOULD also be annotated with the "audio" object type as described in Section 3.2.2 (Audio) and use its properties. This type should only be used when the publisher can guarantee that the object is a song - * rather than merely a generic audio stream. + * Objects of type Song might contain information about the song or recording, or they might contain + * some representation of the recording itself. In the latter case, the song SHOULD also be + * annotated with the "audio" object type as described in Section 3.2.2 (Audio) + * and use its properties. This type should only be used when the publisher can guarantee that the + * object is a song rather than merely a generic audio stream. *

*

- * The Object type URL for the "song" Object type is http://activitystrea.ms/schema/1.0/song. + * The Object type URL for the "song" Object type is + * http://activitystrea.ms/schema/1.0/song. *

*

* A song has no additional components. diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Status.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Status.java index e7f8c0e..9e6bdbf 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Status.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Status.java @@ -19,18 +19,21 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "status" Object type represents a human-readable update of the author's situation, mood, location or other status. + * The "status" Object type represents a human-readable update of the author's situation, mood, + * location or other status. *

*

- * A status is similar in structure to a note, but carries the additional meaning that the content is primarily describing something its author is doing, - * feeling or experiencing. + * A status is similar in structure to a note, but carries the additional meaning that the content + * is primarily describing something its author is doing, feeling or experiencing. *

*

- * A consumers MAY consider the content of the most recent status object it encountered to be the user's current status, unless the most recent status update is - * old. When a status becomes too old is not defined by this specification. + * A consumers MAY consider the content of the most recent status object it encountered to be the + * user's current status, unless the most recent status update is old. When a status becomes too old + * is not defined by this specification. *

*

- * The "status" object type is identified by the URI http://activitystrea.ms/schema/1.0/status. + * The "status" object type is identified by the URI + * http://activitystrea.ms/schema/1.0/status. *

*

* A status has the same components as a note. diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Verb.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Verb.java index 0794d79..1cc3909 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Verb.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Verb.java @@ -22,20 +22,24 @@ package org.rometools.feed.module.activitystreams.types; */ public enum Verb { /** - * The "mark as favorite" Verb indicates that the Subject marked the Object as an item of special interest. Objects so marked often appear in a collection - * of such Objects which MAY be published as a feed of entries annotated with this Verb. If a particular service uses favorites as a mechanism by which a - * user can recall items that were earlier marked, it MAY be appropriate to also mark activities of this type with the "save" Verb as described in Section - * 3.1.8. The verb URI for the "mark as favorite" Verb is http://activitystrea.ms/schema/1.0/favorite. + * The "mark as favorite" Verb indicates that the Subject marked the Object as an item of + * special interest. Objects so marked often appear in a collection of such Objects which MAY be + * published as a feed of entries annotated with this Verb. If a particular service uses + * favorites as a mechanism by which a user can recall items that were earlier marked, it MAY be + * appropriate to also mark activities of this type with the "save" Verb as described in Section + * 3.1.8. The verb URI for the "mark as favorite" Verb is + * http://activitystrea.ms/schema/1.0/favorite. */ MARK_AS_FAVORITE("http://activitystrea.ms/schema/1.0/favorite"), /** - * The "start following" Verb indicates that the Subject began following the activity of the Object. In most cases, the Object of this Verb will be a user, - * but it can potentially be of any type that can sensibly generate activity. + * The "start following" Verb indicates that the Subject began following the activity of the + * Object. In most cases, the Object of this Verb will be a user, but it can potentially be of + * any type that can sensibly generate activity. * * The verb URI for the "start following" Verb is http://activitystrea.ms/schema/1.0/follow. * - * Processors MAY ignore (silently drop) successive identical "start following" activities regardless of whether they maintain state sufficient to determine - * (A), (B), or (C) above. + * Processors MAY ignore (silently drop) successive identical "start following" activities + * regardless of whether they maintain state sufficient to determine (A), (B), or (C) above. */ START_FOLLOWING("http://activitystrea.ms/schema/1.0/follow"), /** @@ -45,68 +49,79 @@ public enum Verb { */ MARK_AS_LIKED("http://activitystrea.ms/schema/1.0/like"), /** - * The "make friend" Verb indicates the creation of a friendship that is reciprocated by the object. + * The "make friend" Verb indicates the creation of a friendship that is reciprocated by the + * object. * - * Since this verb implies an activity on the part of its object, processors MUST NOT accept activities with this Verb unless they are able to verify - * through some external means that there is in fact a reciprocated connection. For example, a processor MAY have received a guarantee from a particular - * publisher that the publisher will only use this Verb in cases where a reciprocal relationship exists. + * Since this verb implies an activity on the part of its object, processors MUST NOT accept + * activities with this Verb unless they are able to verify through some external means that + * there is in fact a reciprocated connection. For example, a processor MAY have received a + * guarantee from a particular publisher that the publisher will only use this Verb in cases + * where a reciprocal relationship exists. * * The verb URI for the "make friend" Verb is http://activitystrea.ms/schema/1.0/make-friend. */ MAKE_FRIEND("http://activitystrea.ms/schema/1.0/make-friend"), /** - * The "join" Verb indicates that the actor has become a member of the Object. This specification only defines the meaning of this Verb when its Object is a - * Group, though implementors SHOULD be prepared to handle other Object types as meaning MAY be provided by extension specifications. + * The "join" Verb indicates that the actor has become a member of the Object. This + * specification only defines the meaning of this Verb when its Object is a Group, though + * implementors SHOULD be prepared to handle other Object types as meaning MAY be provided by + * extension specifications. * - * Processors MAY ignore (silently drop) successive identical "join" activities regardless of whether they maintain state sufficient to determine (A) or (B) - * above. + * Processors MAY ignore (silently drop) successive identical "join" activities regardless of + * whether they maintain state sufficient to determine (A) or (B) above. * * The "join" Verb is identified by the URI http://activitystrea.ms/schema/1.0/join. */ JOIN("http://activitystrea.ms/schema/1.0/join"), /** - * The "play" verb indicates that the subject spent some time enjoying the object. For example, if the object is a video this indicates that the subject - * watched all or part of the video. + * The "play" verb indicates that the subject spent some time enjoying the object. For example, + * if the object is a video this indicates that the subject watched all or part of the video. * * The "play" Verb is identified by the URI http://activitystrea.ms/schema/1.0/play. */ PLAY("http://activitystrea.ms/schema/1.0/play"), /** - * The "Post" Verb is described in section 8 of the AtomActivity specification. It is only referenced here for completeness. + * The "Post" Verb is described in section 8 of the AtomActivity specification. It is only + * referenced here for completeness. * * http://activitystrea.ms/schema/1.0/post */ POST("http://activitystrea.ms/schema/1.0/post"), /** - * The "save" Verb indicates that the Subject has called out the Object as being of interest primarily to him- or herself. Though this action MAY be shared - * publicly, the implication is that the Object has been saved primarily for the actor's own benefit rather than to show it to others as would be indicated - * by the "share" Verb (Section 3.1.9). + * The "save" Verb indicates that the Subject has called out the Object as being of interest + * primarily to him- or herself. Though this action MAY be shared publicly, the implication is + * that the Object has been saved primarily for the actor's own benefit rather than to show it + * to others as would be indicated by the "share" Verb (Section 3.1.9). * * The "save" Verb is identified by the URI http://activitystrea.ms/schema/1.0/save. */ SAVE("http://activitystrea.ms/schema/1.0/save"), /** - * The "share" Verb indicates that the Subject has called out the Object to readers. In most cases, the actor did not create the Object being shared, but is - * instead drawing attention to it. + * The "share" Verb indicates that the Subject has called out the Object to readers. In most + * cases, the actor did not create the Object being shared, but is instead drawing attention to + * it. * * The "share" Verb is identified by the URI http://activitystrea.ms/schema/1.0/share. */ SHARE("http://activitystrea.ms/schema/1.0/share"), /** - * The "tag" verb indicates that the actor has identified the presence of a target inside another object. For example, the actor may have specified that a - * particular user appears in a photo. + * The "tag" verb indicates that the actor has identified the presence of a target inside + * another object. For example, the actor may have specified that a particular user appears in a + * photo. * * The "tag" verb is identified by the URI http://activitystrea.ms/schema/1.0/tag. * - * The target of the "tag" verb gives the object in which the tag has been added. For example, if a user appears in a photo, the activity:object is the user - * and the activity:target is the photo. + * The target of the "tag" verb gives the object in which the tag has been added. For example, + * if a user appears in a photo, the activity:object is the user and the activity:target is the + * photo. */ TAG("http://activitystrea.ms/schema/1.0/tag"), /** * The "update" Verb indicates that the Subject has modified the referenced Object. * - * Implementors SHOULD use verbs such as Section 3.1.7 where the Subject is adding new items to a Section 3.2.8 or similar. Update is reserved for - * modifications to existing Objects or data such as changing a user's profile information. + * Implementors SHOULD use verbs such as Section 3.1.7 where the Subject is adding new items to + * a Section 3.2.8 or similar. Update is reserved for modifications to existing Objects or data + * such as changing a user's profile information. * * The "update" Verb is identified by the URI http://activitystrea.ms/schema/1.0/update. */ @@ -114,46 +129,58 @@ public enum Verb { /** * *

- * The "positive RSVP" verb indicates that the actor has made a positive RSVP for the object. This specification only defines the meaning of this verb when - * its object is an event (see Section 4.2.1 (Event)), though - * implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. + * The "positive RSVP" verb indicates that the actor has made a positive RSVP for the object. + * This specification only defines the meaning of this verb when its object is an event (see Section 4.2.1 (Event)), though implementors SHOULD be prepared to + * handle other object types as meaning MAY be provided by extension specifications. *

*

- * The use of this Verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user - * has been added as an attendee by an event organiser or administrator. + * The use of this Verb is only appropriate when the RSVP was created by an explicit action by + * the actor. It is not appropriate to use this verb when a user has been added as an attendee + * by an event organiser or administrator. *

*

- * The verb URI for the "positive RSVP" Verb is http://activitystrea.ms/schema/1.0/rsvp-yes. + * The verb URI for the "positive RSVP" Verb is + * http://activitystrea.ms/schema/1.0/rsvp-yes. *

*/ RSVP_YES("http://activitystrea.ms/schema/1.0/rsvp-yes"), /** *

- * The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object. This specification only defines the meaning of this verb when - * its object is an event (see Section 4.2.1 (Event)), though - * implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. + * The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object. + * This specification only defines the meaning of this verb when its object is an event (see Section 4.2.1 (Event)), though implementors SHOULD be prepared to + * handle other object types as meaning MAY be provided by extension specifications. *

*

- * The use of this Verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user - * has been added as an attendee by an event organiser or administrator. + * The use of this Verb is only appropriate when the RSVP was created by an explicit action by + * the actor. It is not appropriate to use this verb when a user has been added as an attendee + * by an event organiser or administrator. *

*

- * The verb URI for the "possible RSVP" Verb is http://activitystrea.ms/schema/1.0/rsvp-maybe. + * The verb URI for the "possible RSVP" Verb is + * http://activitystrea.ms/schema/1.0/rsvp-maybe. *

*/ RSVP_MAYBE("http://activitystrea.ms/schema/1.0/rsvp-maybe"), /** *

- * The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object. This specification only defines the meaning of this verb when - * its object is an event (see Section 4.2.1 (Event)), though - * implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications. + * The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object. + * This specification only defines the meaning of this verb when its object is an event (see Section 4.2.1 (Event)), though implementors SHOULD be prepared to + * handle other object types as meaning MAY be provided by extension specifications. *

*

- * The use of this Verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user - * has been added as an attendee by an event organiser or administrator. + * The use of this Verb is only appropriate when the RSVP was created by an explicit action by + * the actor. It is not appropriate to use this verb when a user has been added as an attendee + * by an event organiser or administrator. *

*

- * The verb URI for the "negative RSVP" Verb is http://activitystrea.ms/schema/1.0/rsvp-no. + * The verb URI for the "negative RSVP" Verb is + * http://activitystrea.ms/schema/1.0/rsvp-no. *

*/ RSVP_NO("http://activitystrea.ms/schema/1.0/rsvp-no"); diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/Video.java b/src/main/java/org/rometools/feed/module/activitystreams/types/Video.java index ef0e959..0411b5f 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/Video.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/Video.java @@ -19,10 +19,12 @@ package org.rometools.feed.module.activitystreams.types; /** *

- * The "video" Object type represents video content, which usually consists of a motion picture track and an audio track. + * The "video" Object type represents video content, which usually consists of a motion picture + * track and an audio track. *

*

- * The "video" Object type is identified by the URI http://activitystrea.ms/schema/1.0/video. + * The "video" Object type is identified by the URI + * http://activitystrea.ms/schema/1.0/video. *

*

* A video has the following additional components: @@ -32,11 +34,13 @@ package org.rometools.feed.module.activitystreams.types; *

*
*
Video Stream Link
- *
A Media Link Construct linking to the video content itself. Represented in JSON as a property called stream whose value is a JSON object with - * properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]
+ *
A Media Link Construct linking to the video content itself. Represented in JSON as a property + * called stream whose value is a JSON object with properties as defined in [TODO: xref the + * JSON serialization of a Media Link Construct]
*
Embed Code
- *
An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI for the video stream. Represented in JSON as a property - * called embedCode whose value is a JSON string containing the fragment of HTML.
+ *
An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI + * for the video stream. Represented in JSON as a property called embedCode whose value is + * a JSON string containing the fragment of HTML.
*
*
* diff --git a/src/main/java/org/rometools/feed/module/base/Article.java b/src/main/java/org/rometools/feed/module/base/Article.java index 45045ec..0642503 100644 --- a/src/main/java/org/rometools/feed/module/base/Article.java +++ b/src/main/java/org/rometools/feed/module/base/Article.java @@ -42,7 +42,8 @@ package org.rometools.feed.module.base; import java.util.Date; /** - * This is an interface for the GoogleBase plug in that exposes methods used for Article or News entry types. + * This is an interface for the GoogleBase plug in that exposes methods used for Article or News + * entry types. * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ @@ -54,7 +55,8 @@ public interface Article extends GlobalInterface { * * * - * author + * author * * * Details @@ -89,7 +91,8 @@ public interface Article extends GlobalInterface { * * * - * author + * author * * * Details @@ -126,7 +129,8 @@ public interface Article extends GlobalInterface { * * * - * news_source + * news_source * * * Details @@ -165,7 +169,8 @@ public interface Article extends GlobalInterface { * * * - * news_source + * news_source * * * Details @@ -204,7 +209,8 @@ public interface Article extends GlobalInterface { * * * - * pages + * pages * * * @@ -245,7 +251,8 @@ public interface Article extends GlobalInterface { * * * - * pages + * pages * * * @@ -285,15 +292,17 @@ public interface Article extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -329,15 +338,17 @@ public interface Article extends GlobalInterface { *
publish_date publish_date
* * Details Date the item was published in ISO 8601 format: - * YYYY-MM-DD Date the item was published in ISO 8601 + * format: YYYY-MM-DD
* * - * + * * * * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/Course.java b/src/main/java/org/rometools/feed/module/base/Course.java index b042944..b025b3d 100644 --- a/src/main/java/org/rometools/feed/module/base/Course.java +++ b/src/main/java/org/rometools/feed/module/base/Course.java @@ -41,7 +41,8 @@ package org.rometools.feed.module.base; import org.rometools.feed.module.base.types.DateTimeRange; /** - * This is an interface for the GoogleBase plug in that exposes methods used for Class or Course information entry types. + * This is an interface for the GoogleBase plug in that exposes methods used for Class or Course + * information entry types. * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ @@ -56,12 +57,14 @@ public interface Course extends GlobalInterface { * * * - * + * * * * - * * * - * + * * * * - *
publish_date publish_date
* * Details Date the item was published in ISO 8601 format: - * YYYY-MM-DD Date the item was published in ISO 8601 + * format: YYYY-MM-DD
course_date_range course_date_range
DetailsDate and time range a class is in session, in ISO - * 8601. Two sub-attributes are included in course_date_range attribute. + * Date and time range a class is in session, in ISO 8601. Two + * sub-attributes are included in course_date_range attribute. *
    * *
  • start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • @@ -107,12 +110,14 @@ public interface Course extends GlobalInterface { *
course_date_range course_date_range
DetailsDate and time range a class is in session, in ISO - * 8601. Two sub-attributes are included in course_date_range attribute. + * Date and time range a class is in session, in ISO 8601. Two + * sub-attributes are included in course_date_range attribute. *
    * *
  • start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • @@ -156,7 +161,8 @@ public interface Course extends GlobalInterface { * * * - * + * * * * @@ -195,7 +201,8 @@ public interface Course extends GlobalInterface { *
    course_numbercourse_number
    Details
    * * - * + * * * * @@ -233,7 +240,8 @@ public interface Course extends GlobalInterface { *
    course_numbercourse_number
    Details
    * * - * + * * * * @@ -272,7 +280,8 @@ public interface Course extends GlobalInterface { *
    course_timescourse_times
    * * - * + * * * * @@ -311,13 +320,15 @@ public interface Course extends GlobalInterface { *
    course_timescourse_times
    * * - * + * * * * * * - * + * * * * @@ -354,13 +365,15 @@ public interface Course extends GlobalInterface { *
    salary salary
    Details Salary for this position. Non-numeric values such as "$" symbols are not acceptable. Salary for this position. Non-numeric values such as "$" symbols are not + * acceptable.
    * * - * + * * * * * * - * + * * * * @@ -397,7 +410,8 @@ public interface Course extends GlobalInterface { *
    salary salary
    Details Salary for this position. Non-numeric values such as "$" symbols are not acceptable. Salary for this position. Non-numeric values such as "$" symbols are not + * acceptable.
    * * - * + * * * * @@ -436,7 +450,8 @@ public interface Course extends GlobalInterface { *
    subject subject
    * * - * + * * * * @@ -473,7 +488,8 @@ public interface Course extends GlobalInterface { *
    subject subject
    * * - * + * * * * @@ -512,7 +528,8 @@ public interface Course extends GlobalInterface { *
    university university
    * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/CustomTag.java b/src/main/java/org/rometools/feed/module/base/CustomTag.java index b3c8d74..646cc44 100644 --- a/src/main/java/org/rometools/feed/module/base/CustomTag.java +++ b/src/main/java/org/rometools/feed/module/base/CustomTag.java @@ -92,8 +92,8 @@ public interface CustomTag { * * * - * + * * * *
    university university
    dateTimeRange (DateTimeRange)Start and end dates for an event. An attribute of this type will contain two sub-attributes, <start> and <end> in format - * YYYY-MM-DDStart and end dates for an event. An attribute of this type will contain + * two sub-attributes, <start> and <end> in format YYYY-MM-DD<start>1975-09-25</start>
    * <end>1975-09-25</end> @@ -123,7 +123,8 @@ public interface CustomTag { *
    * - * @return The value of the tag. The objects class is determined by the "type" attribute on the tag. + * @return The value of the tag. The objects class is determined by the "type" attribute on the + * tag. */ public Object getValue(); diff --git a/src/main/java/org/rometools/feed/module/base/CustomTagImpl.java b/src/main/java/org/rometools/feed/module/base/CustomTagImpl.java index 008a7c2..aafa838 100644 --- a/src/main/java/org/rometools/feed/module/base/CustomTagImpl.java +++ b/src/main/java/org/rometools/feed/module/base/CustomTagImpl.java @@ -146,8 +146,9 @@ public class CustomTagImpl implements CustomTag { } /** - * Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any - * object x, the expression:
    + * Creates and returns a copy of this object. The precise meaning of "copy" may depend on the + * class of the object. The general intent is that, for any object x, the expression: + *
    * * 
          * x.clone() != x
@@ -159,7 +160,8 @@ public class CustomTagImpl implements CustomTag {
      * x.clone().getClass() == x.getClass()
      *
    * - *
    will be true, but these are not absolute requirements. While it is typically the case that:
    + *
    will be true, but these are not absolute requirements. While it is + * typically the case that:
    * * 
          * x.clone().equals(x)
@@ -167,27 +169,36 @@ public class CustomTagImpl implements CustomTag {
      *
      *
    will be true, this is not an absolute requirement. *

    - * By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) - * obey this convention, it will be the case that x.clone().getClass() == x.getClass(). + * By convention, the returned object should be obtained by calling super.clone. If a + * class and all of its superclasses (except Object) obey this convention, it will be + * the case that x.clone().getClass() == x.getClass(). *

    - * By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be - * necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable - * objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the - * copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned - * by super.clone need to be modified. + * By convention, the object returned by this method should be independent of this object (which + * is being cloned). To achieve this independence, it may be necessary to modify one or more + * fields of the object returned by super.clone before returning it. Typically, this + * means copying any mutable objects that comprise the internal "deep structure" of the object + * being cloned and replacing the references to these objects with references to the copies. If + * a class contains only primitive fields or references to immutable objects, then it is usually + * the case that no fields in the object returned by super.clone need to be modified. *

    - * The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the - * interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface - * Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of - * the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a - * "shallow copy" of this object, not a "deep copy" operation. + * The method clone for class Object performs a specific cloning operation. + * First, if the class of this object does not implement the interface Cloneable, then + * a CloneNotSupportedException is thrown. Note that all arrays are considered to + * implement the interface Cloneable. Otherwise, this method creates a new instance of + * the class of this object and initializes all its fields with exactly the contents of the + * corresponding fields of this object, as if by assignment; the contents of the fields are not + * themselves cloned. Thus, this method performs a "shallow copy" of this object, not a + * "deep copy" operation. *

    - * The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is - * Object will result in throwing an exception at run time. + * The class Object does not itself implement the interface Cloneable, so + * calling the clone method on an object whose class is Object will result in + * throwing an exception at run time. * * @return a clone of this instance. - * @exception CloneNotSupportedException if the object's class does not support the Cloneable interface. Subclasses that override the - * clone method can also throw this exception to indicate that an instance cannot be cloned. + * @exception CloneNotSupportedException if the object's class does not support the + * Cloneable interface. Subclasses that override the + * clone method can also throw this exception to indicate that an + * instance cannot be cloned. * @see java.lang.Cloneable */ @Override diff --git a/src/main/java/org/rometools/feed/module/base/Event.java b/src/main/java/org/rometools/feed/module/base/Event.java index a21c737..00df831 100644 --- a/src/main/java/org/rometools/feed/module/base/Event.java +++ b/src/main/java/org/rometools/feed/module/base/Event.java @@ -59,14 +59,16 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -101,14 +103,16 @@ public interface Event extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -143,7 +147,8 @@ public interface Event extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * @@ -153,7 +158,8 @@ public interface Event extends GlobalInterface { * * * * @@ -181,7 +187,8 @@ public interface Event extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -191,7 +198,8 @@ public interface Event extends GlobalInterface { * * * * @@ -218,7 +226,8 @@ public interface Event extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -255,7 +264,8 @@ public interface Event extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -293,14 +303,16 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * * * * - * + * * * * * * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -441,32 +460,37 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -488,14 +512,17 @@ public interface Event extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -536,14 +563,17 @@ public interface Event extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -583,7 +613,8 @@ public interface Event extends GlobalInterface { *
    delivery_radiusdelivery_radius
    event_date_range event_date_range
    Details * - * Information on the date and time an event will take place, in ISO 8601 + * Information on the date and time an event will take place, in ISO 8601 * format. Two sub-attributes are included in the event_date_range attribute: *
      * @@ -344,14 +356,16 @@ public interface Event extends GlobalInterface { *
    event_date_range event_date_range
    Details * - * Information on the date and time an event will take place, in ISO 8601 + * Information on the date and time an event will take place, in ISO 8601 * format. Two sub-attributes are included in the event_date_range attribute: *
      * @@ -395,32 +409,37 @@ public interface Event extends GlobalInterface { *
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    * * - * + * * * * @@ -594,7 +625,8 @@ public interface Event extends GlobalInterface { * * * - * + * * * * @@ -617,7 +649,8 @@ public interface Event extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -628,7 +661,8 @@ public interface Event extends GlobalInterface { * * * - * + * * * * @@ -651,7 +685,8 @@ public interface Event extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -662,7 +697,8 @@ public interface Event extends GlobalInterface { * * * - * + * * * * @@ -690,7 +726,8 @@ public interface Event extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -701,7 +738,8 @@ public interface Event extends GlobalInterface { * * * - * + * * * * @@ -732,14 +770,16 @@ public interface Event extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -784,14 +824,16 @@ public interface Event extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -836,12 +878,14 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -877,12 +921,14 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -917,13 +963,14 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -965,13 +1012,14 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -1020,12 +1068,14 @@ public interface Event extends GlobalInterface { * * * - * @@ -1077,12 +1127,14 @@ public interface Event extends GlobalInterface { * * * - * @@ -1126,7 +1178,8 @@ public interface Event extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    price price
    * * Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    price price
    * * Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are "negotiable," or "starting." The default is "starting"The type of pricing for the item. Acceptable values are "negotiable," or + * "starting." The default is "starting"
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are "negotiable," or "starting." The default is "starting"The type of pricing for the item. Acceptable values are "negotiable," or + * "starting." The default is "starting"
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    * * - * + * * * * @@ -1168,7 +1221,8 @@ public interface Event extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/GlobalInterface.java b/src/main/java/org/rometools/feed/module/base/GlobalInterface.java index 6ff89a2..260fc72 100644 --- a/src/main/java/org/rometools/feed/module/base/GlobalInterface.java +++ b/src/main/java/org/rometools/feed/module/base/GlobalInterface.java @@ -56,13 +56,15 @@ public interface GlobalInterface extends Serializable { *
    tax_percent tax_percent
    * * - * + * * * * * - * + * * * * @@ -72,7 +74,8 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * @@ -92,13 +95,15 @@ public interface GlobalInterface extends Serializable { *
    expiration_dateexpiration_date
    Details Date that the item expires in ISO 8601 format: - * YYYY-MM-DD Date that the item expires in ISO 8601 + * format: YYYY-MM-DD
    Example
    Attribute of Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads. Reference Items, Events, Housing, Jobs, People profiles, Products, + * Services, Travel, Vehicles, Wanted Ads.
    Content type
    * * - * + * * * * * - * + * * * * @@ -108,7 +113,8 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * @@ -128,24 +134,28 @@ public interface GlobalInterface extends Serializable { *
    expiration_dateexpiration_date
    Details Date that the item expires in ISO 8601 format: - * YYYY-MM-DD Date that the item expires in ISO 8601 + * format: YYYY-MM-DD
    Example
    Attribute of Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads. Reference Items, Events, Housing, Jobs, People profiles, Products, + * Services, Travel, Vehicles, Wanted Ads.
    Content type
    * * - * + * * * * * - * * * * * * - * + * * * * * - * + * * * * @@ -166,24 +176,28 @@ public interface GlobalInterface extends Serializable { *
    expiration_date_timeexpiration_date_time
    Details Date and time that the item expires in ISO 8601 + * Date and time that the item expires in ISO 8601 * format: YYYY-MM-DDThh:mm:ss
    Example <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time> + * <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time>
    Attribute of Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads. Reference Items, Events, Housing, Jobs, People profiles, Products, + * Services, Travel, Vehicles, Wanted Ads.
    * * - * + * * * * * - * * * * * * - * + * * * * * - * + * * * * @@ -203,14 +217,17 @@ public interface GlobalInterface extends Serializable { *
    expiration_date_timeexpiration_date_time
    Details Date and time that the item expires in ISO 8601 + * Date and time that the item expires in ISO 8601 * format: YYYY-MM-DDThh:mm:ss
    Example <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time> + * <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time>
    Attribute of Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads. Reference Items, Events, Housing, Jobs, People profiles, Products, + * Services, Travel, Vehicles, Wanted Ads.
    * * - * + * * * * * - * + * * * * @@ -220,8 +237,8 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * @@ -241,14 +258,17 @@ public interface GlobalInterface extends Serializable { *
    idid
    Details Unique alphanumeric identifier for each item - e.g., your internal ID code.
    - * IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you send in a new bulk upload. Each item must retain the same - * id in subsequent bulk uploads.    		 Unique alphanumeric identifier for each item - e.g., your internal ID + * code.
    + * IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you + * send in a new bulk upload. Each item must retain the same id in subsequent bulk + * uploads.
    Example
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    * * - * + * * * * * - * + * * * * @@ -258,8 +278,8 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * @@ -280,14 +300,17 @@ public interface GlobalInterface extends Serializable { *
    idid
    Details Unique alphanumeric identifier for each item - e.g., your internal ID code.
    - * IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you send in a new bulk upload. Each item must retain the same - * id in subsequent bulk uploads.    		 Unique alphanumeric identifier for each item - e.g., your internal ID + * code.
    + * IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you + * send in a new bulk upload. Each item must retain the same id in subsequent bulk + * uploads.
    Example
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    * * - * + * * * * * - * + * * * * @@ -305,8 +328,8 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * @@ -327,14 +350,17 @@ public interface GlobalInterface extends Serializable { *
    image_linkimage_link
    Details URL of an associated image if available online. Use your full-sized images; do not use thumbnail images. Up to ten image_links, all - * placed in between their own <image_link> and </image_link> attributes, can be included with each item. If you do not have an image available, - * do not include this attribute. Please do not include an image that says "Image not available." Relative URLs and logo images are not acceptable. URL of an associated image if available online. Use your full-sized + * images; do not use thumbnail images. Up to ten image_links, all placed in between their own + * <image_link> and </image_link> attributes, can be included with each item. If you + * do not have an image available, do not include this attribute. Please do not include an image + * that says "Image not available." Relative URLs and logo images are not acceptable.
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    Content type
    * * - * + * * * * * - * + * * * * @@ -352,8 +378,8 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * @@ -383,10 +409,12 @@ public interface GlobalInterface extends Serializable { * * Details * + * and </label> tags, can be included with each item. These attributes will be used to + * match your items to search queries. Each attribute value will be checked for policy + * compliance. * * * @@ -419,15 +447,16 @@ public interface GlobalInterface extends Serializable { *
    * Not acceptable:
    * - *     <g:label> leater, power locks, sunroof, ABS </g:label> + * <g:label> leater, power locks, sunroof, ABS + * </g:label> * * * * * + * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, + * Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * * * * + * and </label> tags, can be included with each item. These attributes will be used to + * match your items to search queries. Each attribute value will be checked for policy + * compliance. * * * @@ -495,15 +526,16 @@ public interface GlobalInterface extends Serializable { *
    * Not acceptable:
    * - *     <g:label> leater, power locks, sunroof, ABS </g:label> + * <g:label> leater, power locks, sunroof, ABS + * </g:label> * * * * * + * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, + * Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * * *
    image_linkimage_link
    Details URL of an associated image if available online. Use your full-sized images; do not use thumbnail images. Up to ten image_links, all - * placed in between their own <image_link> and </image_link> attributes, can be included with each item. If you do not have an image available, - * do not include this attribute. Please do not include an image that says "Image not available." Relative URLs and logo images are not acceptable. URL of an associated image if available online. Use your full-sized + * images; do not use thumbnail images. Up to ten image_links, all placed in between their own + * <image_link> and </image_link> attributes, can be included with each item. If you + * do not have an image available, do not include this attribute. Please do not include an image + * that says "Image not available." Relative URLs and logo images are not acceptable.
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    Content type - * A list of classifications the item may fall under. Up to ten user-selected label, each placed in between their own <label> + * A list of classifications the item may fall under. Up to ten user-selected + * label, each placed in between their own <label> * - * and </label> tags, can be included with each item. These attributes will be used to match your items to search queries. Each attribute value will - * be checked for policy compliance.
    * Attribute of - * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads.
    @@ -459,10 +488,12 @@ public interface GlobalInterface extends Serializable { * * Details - * A list of classifications the item may fall under. Up to ten user-selected label, each placed in between their own <label> + * A list of classifications the item may fall under. Up to ten user-selected + * label, each placed in between their own <label> * - * and </label> tags, can be included with each item. These attributes will be used to match your items to search queries. Each attribute value will - * be checked for policy compliance.
    * Attribute of - * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads.
    diff --git a/src/main/java/org/rometools/feed/module/base/GoogleBase.java b/src/main/java/org/rometools/feed/module/base/GoogleBase.java index 8a1fa8e..b72a97c 100644 --- a/src/main/java/org/rometools/feed/module/base/GoogleBase.java +++ b/src/main/java/org/rometools/feed/module/base/GoogleBase.java @@ -45,15 +45,16 @@ import com.sun.syndication.feed.module.Module; * This is the root interface for the Google Base module. * *

    - * It supports all the individual data "types". If you want to work with, for instance, just the Article or Job datatype, you can cast it to the respective - * interface and see only methods related to a particular entry type. + * It supports all the individual data "types". If you want to work with, for instance, just the + * Article or Job datatype, you can cast it to the respective interface and see only methods related + * to a particular entry type. *

    * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public interface GoogleBase extends Module, Article, Course, Event, Job, Person, Product, Review, ScholarlyArticle, Service, Travel, Unknown, Vehicle, Wanted, -Housing { + Housing { /** This is the URI for the Google Base Schema. */ public static final String URI = "http://base.google.com/ns/1.0"; } diff --git a/src/main/java/org/rometools/feed/module/base/Housing.java b/src/main/java/org/rometools/feed/module/base/Housing.java index 6882234..0fa3167 100644 --- a/src/main/java/org/rometools/feed/module/base/Housing.java +++ b/src/main/java/org/rometools/feed/module/base/Housing.java @@ -47,7 +47,8 @@ import org.rometools.feed.module.base.types.PriceTypeEnumeration; import org.rometools.feed.module.base.types.YearType; /** - * This is an interface for the GoogleBase plug in that exposes methods used for Housing entry types. + * This is an interface for the GoogleBase plug in that exposes methods used for Housing entry + * types. * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ @@ -58,7 +59,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -94,7 +96,8 @@ public interface Housing extends GlobalInterface { *
    agentagent
    * * - * + * * * * @@ -132,7 +135,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -169,7 +173,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -205,7 +210,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * * - * + * * * * * - * + * * * * @@ -1178,7 +1221,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -1374,7 +1418,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -1412,7 +1457,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -1449,14 +1495,17 @@ public interface Product extends GlobalInterface { * * * - * + * * * * - * + * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, + * include multiple instances of the <payment_accepted> attribute for each acceptable + * method. * * * @@ -1495,14 +1544,17 @@ public interface Product extends GlobalInterface { * * * - * + * * * * - * + * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, + * include multiple instances of the <payment_accepted> attribute for each acceptable + * method. * * * @@ -1540,7 +1592,8 @@ public interface Product extends GlobalInterface { *
    agentagent
    areaarea
    areaarea
    bathrooms bathrooms
    @@ -250,7 +256,8 @@ public interface Housing extends GlobalInterface { * *
    bathrooms bathrooms
    @@ -294,7 +301,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -335,7 +343,8 @@ public interface Housing extends GlobalInterface { *
    bedrooms bedrooms
    * * - * + * * * * @@ -376,14 +385,16 @@ public interface Housing extends GlobalInterface { *
    bedrooms bedrooms
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -418,14 +429,16 @@ public interface Housing extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -460,7 +473,8 @@ public interface Housing extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * @@ -497,7 +511,8 @@ public interface Housing extends GlobalInterface { *
    hoa_dueshoa_dues
    Details
    * * - * + * * * * @@ -536,13 +551,15 @@ public interface Housing extends GlobalInterface { *
    hoa_dueshoa_dues
    Details
    * * - * + * * * * * * - * + * * * * @@ -583,13 +600,15 @@ public interface Housing extends GlobalInterface { *
    listing_typelisting_type
    Details Information about whether or not a property is for sale or not. Acceptable values are "True" or "False". Information about whether or not a property is for sale or not. + * Acceptable values are "True" or "False".
    Example
    * * - * + * * * * * * - * + * * * * @@ -628,32 +647,37 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -674,32 +698,37 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -721,14 +750,17 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -769,14 +801,17 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -816,7 +851,8 @@ public interface Housing extends GlobalInterface { *
    listing_typelisting_type
    Details Information about whether or not a property is for sale or not. Acceptable values are "True" or "False". Information about whether or not a property is for sale or not. + * Acceptable values are "True" or "False".
    Example
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    * * - * + * * * * @@ -827,7 +863,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -855,7 +892,8 @@ public interface Housing extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -866,7 +904,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -896,12 +935,14 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -942,12 +983,14 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -987,13 +1030,15 @@ public interface Housing extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    * * - * + * * * * * * - * + * * * * @@ -1029,13 +1074,15 @@ public interface Housing extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�The type of pricing for the item. Acceptable values are �negotiable,� or + * �starting.� The default is �starting�
    * * - * + * * * * * * - * + * * * * @@ -1070,7 +1117,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * - * + * * * * @@ -1164,8 +1214,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -1194,7 +1244,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -1205,8 +1256,8 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * @@ -1233,7 +1284,8 @@ public interface Housing extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�The type of pricing for the item. Acceptable values are �negotiable,� or + * �starting.� The default is �starting�
    property_type property_type
    @@ -1111,7 +1159,8 @@ public interface Housing extends GlobalInterface { * *
    property_type property_type
    @@ -1153,7 +1202,8 @@ public interface Housing extends GlobalInterface { *
    school_district school_district
    Example <g:school_district>Union School - * District</g:school_district> <g:school_district>Union + * School District</g:school_district>
    school_district school_district
    Example <g:school_district>Union School - * District</g:school_district> <g:school_district>Union + * School District</g:school_district>
    * * - * + * * * * @@ -1274,7 +1326,8 @@ public interface Housing extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * @@ -1398,7 +1451,8 @@ public interface Housing extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * @@ -1444,7 +1498,8 @@ public interface Housing extends GlobalInterface { *
    year year
    * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/Job.java b/src/main/java/org/rometools/feed/module/base/Job.java index 91a0656..3bda751 100644 --- a/src/main/java/org/rometools/feed/module/base/Job.java +++ b/src/main/java/org/rometools/feed/module/base/Job.java @@ -43,7 +43,8 @@ import org.rometools.feed.module.base.types.CurrencyEnumeration; import org.rometools.feed.module.base.types.PriceTypeEnumeration; /** - * This is an interface for the GoogleBase plug in that exposes methods used for Job listing entry types. + * This is an interface for the GoogleBase plug in that exposes methods used for Job listing entry + * types. * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ @@ -54,7 +55,8 @@ public interface Job extends GlobalInterface { *
    year year
    * * - * + * * * * @@ -87,7 +89,8 @@ public interface Job extends GlobalInterface { *
    educationeducation
    Details
    * * - * + * * * * @@ -120,7 +123,8 @@ public interface Job extends GlobalInterface { *
    educationeducation
    Details
    * * - * + * * * * @@ -153,7 +157,8 @@ public interface Job extends GlobalInterface { *
    employeremployer
    * * - * + * * * * @@ -187,7 +192,8 @@ public interface Job extends GlobalInterface { *
    employeremployer
    * * - * + * * * * @@ -198,7 +204,8 @@ public interface Job extends GlobalInterface { * * * - * + * * * * @@ -224,7 +231,8 @@ public interface Job extends GlobalInterface { *
    immigration_statusimmigration_status
    Example<g:immigration_status>Permanent resident</g:immigration_status><g:immigration_status>Permanent + * resident</g:immigration_status>
    * * - * + * * * * @@ -235,7 +243,8 @@ public interface Job extends GlobalInterface { * * * - * + * * * * @@ -262,7 +271,8 @@ public interface Job extends GlobalInterface { * * * - * + * * * * @@ -303,7 +313,8 @@ public interface Job extends GlobalInterface { * * * - * + * * * * @@ -419,12 +430,14 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -457,12 +470,14 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -495,32 +510,37 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -541,32 +561,37 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -586,13 +611,15 @@ public interface Job extends GlobalInterface { *
    immigration_statusimmigration_status
    Example<g:immigration_status>Permanent resident</g:immigration_status><g:immigration_status>Permanent + * resident</g:immigration_status>
    job_function job_function
    job_function job_function
    job_type job_type
    Details Type of employment position. Example: Full-time, part-time, contractor, etc. Type of employment position. Example: Full-time, part-time, contractor, + * etc.
    job_type job_type
    Details Type of employment position. Example: Full-time, part-time, contractor, etc. Type of employment position. Example: Full-time, part-time, contractor, + * etc.
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    * * - * + * * * * * * - * + * * * * @@ -618,7 +645,8 @@ public interface Job extends GlobalInterface { * *
    salary salary
    Details Salary for this position. Non-numeric values such as "$" symbols are not acceptable. Salary for this position. Non-numeric values such as "$" symbols are not + * acceptable.
    * - * @param salary Salary for this position. Non-numeric values such as "$" symbols are not acceptable. + * @param salary Salary for this position. Non-numeric values such as "$" symbols are not + * acceptable. */ public void setSalary(Float salary); @@ -627,13 +655,15 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -668,13 +698,15 @@ public interface Job extends GlobalInterface { *
    salary salary
    Details Salary for this position. Non-numeric values such as "$" symbols are not acceptable. Salary for this position. Non-numeric values such as "$" symbols are not + * acceptable.
    * * - * + * * * * * * - * + * * * * @@ -709,13 +741,15 @@ public interface Job extends GlobalInterface { *
    salary_type salary_type
    Details The type of salary included. Accepted values are �starting� or �negotiable;� The default is �starting at.� The type of salary included. Accepted values are �starting� or + * �negotiable;� The default is �starting at.�
    * * - * + * * * * * * - * + * * * * @@ -751,14 +785,16 @@ public interface Job extends GlobalInterface { *
    salary_type salary_type
    Details The type of salary included. Accepted values are �starting� or �negotiable;� The default is �starting at.� The type of salary included. Accepted values are �starting� or + * �negotiable;� The default is �starting at.�
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -793,14 +829,16 @@ public interface Job extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * diff --git a/src/main/java/org/rometools/feed/module/base/Person.java b/src/main/java/org/rometools/feed/module/base/Person.java index 0a123c8..613f3ff 100644 --- a/src/main/java/org/rometools/feed/module/base/Person.java +++ b/src/main/java/org/rometools/feed/module/base/Person.java @@ -42,7 +42,8 @@ package org.rometools.feed.module.base; import org.rometools.feed.module.base.types.GenderEnumeration; /** - * This is an interface for the GoogleBase plug in that exposes methods used for Person (personal ad, resume, profile) entry types. + * This is an interface for the GoogleBase plug in that exposes methods used for Person (personal + * ad, resume, profile) entry types. * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ @@ -53,11 +54,13 @@ public interface Person extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * - * + * * * * @@ -90,11 +93,13 @@ public interface Person extends GlobalInterface { *
    ageage + *
    DetailsMinimum age requirement for the event or the age of the individual in a People profiles bulk upload entry.Minimum age requirement for the event or the age of the individual in a + * People profiles bulk upload entry.
    * * - * + * * * * - * + * * * * @@ -127,7 +132,8 @@ public interface Person extends GlobalInterface { *
    ageage + *
    DetailsMinimum age requirement for the event or the age of the individual in a People profiles bulk upload entry.Minimum age requirement for the event or the age of the individual in a + * People profiles bulk upload entry.
    * * - * + * * * * @@ -160,7 +166,8 @@ public interface Person extends GlobalInterface { *
    educationeducation
    Details
    * * - * + * * * * @@ -194,7 +201,8 @@ public interface Person extends GlobalInterface { *
    educationeducation
    Details
    * * - * + * * * * @@ -228,7 +236,8 @@ public interface Person extends GlobalInterface { *
    employeremployer
    * * - * + * * * * @@ -262,12 +271,14 @@ public interface Person extends GlobalInterface { *
    employeremployer
    * * - * + * * * * * - * + * * * * @@ -299,12 +310,14 @@ public interface Person extends GlobalInterface { *
    ethnicityethnicity
    Details Ethnicity of the individual in the People profiles bulk upload entry. Ethnicity of the individual in the People profiles bulk upload + * entry.
    * * - * + * * * * * - * + * * * * @@ -336,13 +349,15 @@ public interface Person extends GlobalInterface { *
    ethnicityethnicity
    Details Ethnicity of the individual in the People profiles bulk upload entry. Ethnicity of the individual in the People profiles bulk upload + * entry.
    * * - * + * * * * * * - * + * * * * @@ -371,13 +386,15 @@ public interface Person extends GlobalInterface { *
    gendergender
    Details Gender of an individual in a People profiles bulk upload item. Acceptable values are �Male�, �M�, �Female�, or �F�. Gender of an individual in a People profiles bulk upload item. + * Acceptable values are �Male�, �M�, �Female�, or �F�.
    Example
    * * - * + * * * * * * - * + * * * * @@ -406,7 +423,8 @@ public interface Person extends GlobalInterface { *
    gendergender
    Details Gender of an individual in a People profiles bulk upload item. Acceptable values are �Male�, �M�, �Female�, or �F�. Gender of an individual in a People profiles bulk upload item. + * Acceptable values are �Male�, �M�, �Female�, or �F�.
    Example
    * * - * + * * * * @@ -417,7 +435,8 @@ public interface Person extends GlobalInterface { * * * - * + * * * * @@ -443,7 +462,8 @@ public interface Person extends GlobalInterface { *
    interested_ininterested_in
    Example <g:interested_in>Long walks on the beach.</g:interested_in> <g:interested_in>Long walks on the + * beach.</g:interested_in>
    Attribute of
    * * - * + * * * * @@ -454,7 +474,8 @@ public interface Person extends GlobalInterface { * * * - * + * * * * @@ -480,32 +501,37 @@ public interface Person extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -526,32 +552,37 @@ public interface Person extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -573,14 +604,15 @@ public interface Person extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -618,14 +650,15 @@ public interface Person extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -663,13 +696,15 @@ public interface Person extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -705,13 +740,15 @@ public interface Person extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -746,19 +783,22 @@ public interface Person extends GlobalInterface { *
    interested_ininterested_in
    Example <g:interested_in>Long walks on the beach.</g:interested_in> <g:interested_in>Long walks on the + * beach.</g:interested_in>
    Attribute of
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    marital_status marital_status
    * * Details Marital status of an individual in a People profiles bulk upload entry. For example -single, divorced, separated, widowed, married, - * and �in relationship.� Marital status of an individual in a People profiles bulk upload entry. + * For example -single, divorced, separated, widowed, married, and �in relationship.�
    marital_status marital_status
    * * Details Marital status of an individual in a People profiles bulk upload entry. For example -single, divorced, separated, widowed, married, - * and �in relationship.� Marital status of an individual in a People profiles bulk upload entry. + * For example -single, divorced, separated, widowed, married, and �in relationship.�
    occupation occupation
    * * Details Industry the individual in a People profiles bulk upload is employed in. Industry the individual in a People profiles bulk upload is employed + * in.
    occupation occupation
    * * Details Industry the individual in a People profiles bulk upload is employed in. Industry the individual in a People profiles bulk upload is employed + * in.
    * * - * + * * * * * - * + * * * * * - * + * * * * @@ -786,19 +826,22 @@ public interface Person extends GlobalInterface { *
    sexual_orientation sexual_orientation
    * * Details Sexual orientation of an individual in a People profiles information type.. Sexual orientation of an individual in a People profiles information + * type..
    Example <g:sexual_orientation>straight</g:sexual_orientation> <g:sexual_orientation>straight</g:sexual_orientation> + *
    * * - * + * * * * * - * + * * * * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/Product.java b/src/main/java/org/rometools/feed/module/base/Product.java index f7eca30..297a574 100644 --- a/src/main/java/org/rometools/feed/module/base/Product.java +++ b/src/main/java/org/rometools/feed/module/base/Product.java @@ -60,7 +60,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -96,7 +97,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -132,7 +134,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -169,7 +172,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -204,7 +208,8 @@ public interface Product extends GlobalInterface { *
    sexual_orientation sexual_orientation
    * * Details Sexual orientation of an individual in a People profiles information type.. Sexual orientation of an individual in a People profiles information + * type..
    Example <g:sexual_orientation>straight</g:sexual_orientation> <g:sexual_orientation>straight</g:sexual_orientation> + *
    actoractor
    Details
    actoractor
    Details
    apparel_typeapparel_type
    Details
    apparel_typeapparel_type
    Details
    * * - * + * * * * @@ -242,7 +247,8 @@ public interface Product extends GlobalInterface { *
    artist artist
    * * - * + * * * * @@ -282,7 +288,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -318,7 +325,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -352,7 +360,8 @@ public interface Product extends GlobalInterface { *
    artist artist
    author author
    Details
    author author
    Details
    * * - * + * * * * @@ -386,7 +395,8 @@ public interface Product extends GlobalInterface { *
    brand brand
    Details
    * * - * + * * * * @@ -422,7 +432,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -462,7 +473,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -501,7 +513,8 @@ public interface Product extends GlobalInterface { *
    brand brand
    Details
    color color
    color color
    * * - * + * * * * @@ -539,7 +552,8 @@ public interface Product extends GlobalInterface { *
    conditioncondition
    * * - * + * * * * @@ -577,14 +591,16 @@ public interface Product extends GlobalInterface { *
    conditioncondition
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -619,14 +635,16 @@ public interface Product extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -661,7 +679,8 @@ public interface Product extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * @@ -671,7 +690,8 @@ public interface Product extends GlobalInterface { * * * * @@ -698,7 +718,8 @@ public interface Product extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -708,7 +729,8 @@ public interface Product extends GlobalInterface { * * * * @@ -735,7 +757,8 @@ public interface Product extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -772,7 +795,8 @@ public interface Product extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -809,7 +833,8 @@ public interface Product extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -846,7 +871,8 @@ public interface Product extends GlobalInterface { *
    formatformat
    Details
    * * - * + * * * * @@ -883,7 +909,8 @@ public interface Product extends GlobalInterface { *
    formatformat
    Details
    * * - * + * * * * @@ -918,7 +945,8 @@ public interface Product extends GlobalInterface { *
    isbnisbn
    Details
    * * - * + * * * * @@ -949,37 +977,43 @@ public interface Product extends GlobalInterface { public String getIsbn(); /** - * Location of a property. Should include street, city, state, postal code, and country, in that order. + * Location of a property. Should include street, city, state, postal code, and country, in that + * order. *
    isbnisbn
    Details
    * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -990,42 +1024,49 @@ public interface Product extends GlobalInterface { * *
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    * - * @param location Location of a property. Should include street, city, state, postal code, and country, in that order. + * @param location Location of a property. Should include street, city, state, postal code, and + * country, in that order. */ public void setLocation(String location); /** - * Location of a property. Should include street, city, state, postal code, and country, in that order. + * Location of a property. Should include street, city, state, postal code, and country, in that + * order. * * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -1036,7 +1077,8 @@ public interface Product extends GlobalInterface { * *
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    * - * @return Location of a property. Should include street, city, state, postal code, and country, in that order. + * @return Location of a property. Should include street, city, state, postal code, and country, + * in that order. */ public String getLocation(); @@ -1141,7 +1183,8 @@ public interface Product extends GlobalInterface { * *
    manufacturer_id manufacturer_id
    Details
    manufacturer_id manufacturer_id
    Details
    model_number model_number
    Details
    model_number model_number
    Details
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” + * Acceptable payment methods for item purchases. Acceptable values are + * “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” * - * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the <payment_accepted> - * attribute for each acceptable method.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” + * Acceptable payment methods for item purchases. Acceptable values are + * “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” * - * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the <payment_accepted> - * attribute for each acceptable method.
    * * - * + * * * * @@ -1552,7 +1605,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -1581,7 +1635,8 @@ public interface Product extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -1593,7 +1648,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -1623,13 +1679,15 @@ public interface Product extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -1667,13 +1725,15 @@ public interface Product extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -1712,12 +1772,14 @@ public interface Product extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -1758,12 +1820,14 @@ public interface Product extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -1802,13 +1866,15 @@ public interface Product extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    pickup pickup
    Details Information about whether or not an item is available for pick up. Acceptable values are "True and "False". Information about whether or not an item is available for pick up. + * Acceptable values are "True and "False".
    Example
    pickup pickup
    Details Information about whether or not an item is available for pick up. Acceptable values are "True and "False". Information about whether or not an item is available for pick up. + * Acceptable values are "True and "False".
    Example
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    * * - * + * * * * * * - * + * * * * @@ -1843,13 +1909,15 @@ public interface Product extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”The type of pricing for the item. Acceptable values are “negotiable,” or + * “starting.” The default is “starting”
    * * - * + * * * * * * - * + * * * * @@ -1962,7 +2030,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -1999,7 +2068,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -2037,13 +2107,14 @@ public interface Product extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -2085,13 +2156,14 @@ public interface Product extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -2139,12 +2211,14 @@ public interface Product extends GlobalInterface { * * * - * @@ -2195,12 +2269,14 @@ public interface Product extends GlobalInterface { * * * - * @@ -2245,13 +2321,15 @@ public interface Product extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”The type of pricing for the item. Acceptable values are “negotiable,” or + * “starting.” The default is “starting”
    product_type product_type
    Details
    product_type product_type
    Details
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    * * - * + * * * * * * - * + * * * * @@ -2285,13 +2363,15 @@ public interface Product extends GlobalInterface { *
    size size
    Details Dimensions of the item, expressed in either two or three dimensions. Dimensions of the item, expressed in either two or three + * dimensions.
    * * - * + * * * * * * - * + * * * * @@ -2324,7 +2404,8 @@ public interface Product extends GlobalInterface { *
    size size
    Details Dimensions of the item, expressed in either two or three dimensions. Dimensions of the item, expressed in either two or three + * dimensions.
    * * - * + * * * * @@ -2366,7 +2447,8 @@ public interface Product extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * @@ -2583,7 +2665,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * @@ -2624,7 +2707,8 @@ public interface Product extends GlobalInterface { * * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/Review.java b/src/main/java/org/rometools/feed/module/base/Review.java index b17d41a..f195f34 100644 --- a/src/main/java/org/rometools/feed/module/base/Review.java +++ b/src/main/java/org/rometools/feed/module/base/Review.java @@ -45,7 +45,8 @@ import java.util.Date; import org.rometools.feed.module.base.types.FloatUnit; /** - * This is an interface for the GoogleBase plug in that exposes methods used for critical reviews of other things. + * This is an interface for the GoogleBase plug in that exposes methods used for critical reviews of + * other things. * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ @@ -59,7 +60,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * @@ -96,7 +98,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * @@ -131,7 +134,8 @@ public interface Review extends GlobalInterface { *
    tax_percent tax_percent
    weight weight
    Details
    weight weight
    Details
    author author
    Details
    author author
    Details
    * * - * + * * * * @@ -141,7 +145,8 @@ public interface Review extends GlobalInterface { * * * * @@ -169,7 +174,8 @@ public interface Review extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -179,7 +185,8 @@ public interface Review extends GlobalInterface { * * * * @@ -206,7 +213,8 @@ public interface Review extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -243,7 +251,8 @@ public interface Review extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -282,7 +291,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * @@ -293,7 +303,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * @@ -319,7 +330,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * @@ -330,7 +342,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * @@ -355,14 +368,16 @@ public interface Review extends GlobalInterface { *
    delivery_radiusdelivery_radius
    name_of_item_being_reviewed name_of_item_being_reviewed
    Details
    Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed> <g:name_of_item_being__reviewed>Fleur de lys + * Restaurant</g:name_of_item_being_reviewed>
    name_of_item_being_reviewed name_of_item_being_reviewed
    Details
    Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed> <g:name_of_item_being__reviewed>Fleur de lys + * Restaurant</g:name_of_item_being_reviewed>
    * * - * + * * * * * * - * + * * * * @@ -397,14 +412,16 @@ public interface Review extends GlobalInterface { *
    publish_date publish_date
    Details Date the item was published in ISO 8601 format: - * YYYY-MM-DD Date the item was published in ISO 8601 + * format: YYYY-MM-DD
    * * - * + * * * * * * - * + * * * * @@ -438,12 +455,14 @@ public interface Review extends GlobalInterface { *
    publish_date publish_date
    Details Date the item was published in ISO 8601 format: - * YYYY-MM-DD Date the item was published in ISO 8601 + * format: YYYY-MM-DD
    * * - * + * * * * * - * + * * * * @@ -480,12 +499,14 @@ public interface Review extends GlobalInterface { *
    rating rating
    Details Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only. Rating of the product or service on a scale of 1-5, with 5 as the best. + * Numeric values only.
    * * - * + * * * * * - * + * * * * @@ -523,7 +544,8 @@ public interface Review extends GlobalInterface { *
    rating rating
    Details Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only. Rating of the product or service on a scale of 1-5, with 5 as the best. + * Numeric values only.
    * * - * + * * * *
    review_type review_type
    @@ -565,7 +587,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * * * - * + * * * * * * - * + * * * * @@ -729,7 +759,8 @@ public interface Review extends GlobalInterface { * * * - * + * * * * * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/ScholarlyArticle.java b/src/main/java/org/rometools/feed/module/base/ScholarlyArticle.java index 6c87274..0a7bf8b 100644 --- a/src/main/java/org/rometools/feed/module/base/ScholarlyArticle.java +++ b/src/main/java/org/rometools/feed/module/base/ScholarlyArticle.java @@ -42,7 +42,8 @@ package org.rometools.feed.module.base; import java.util.Date; /** - * This is an interface for the GoogleBase plug in that exposes methods used for Scholarly publication, research studies and reference materials. + * This is an interface for the GoogleBase plug in that exposes methods used for Scholarly + * publication, research studies and reference materials. * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ @@ -54,7 +55,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -89,7 +91,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -125,7 +128,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -166,7 +170,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -207,7 +212,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -219,7 +225,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -248,7 +255,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -260,7 +268,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -288,7 +297,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -326,7 +336,8 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * @@ -364,15 +375,17 @@ public interface ScholarlyArticle extends GlobalInterface { *
    review_type review_type
    @@ -602,18 +625,20 @@ public interface Review extends GlobalInterface { public String getReviewType(); /** - * The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site). + * The type of rating being provided: editorial (a review written by a member of your staff) or + * “user” ( a review written by a user of your site). * * * - * + * * * * * * - * + * * * * *
    reviewer_type reviewer_type
    Details The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of - * your site) The type of rating being provided: editorial (a review written by a + * member of your staff) or “user” ( a review written by a user of your site)
    @@ -636,24 +661,26 @@ public interface Review extends GlobalInterface { *
    * - * @param reviewerType The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of - * your site). + * @param reviewerType The type of rating being provided: editorial (a review written by a + * member of your staff) or “user” ( a review written by a user of your site). */ public void setReviewerType(String reviewerType); /** - * The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site). + * The type of rating being provided: editorial (a review written by a member of your staff) or + * “user” ( a review written by a user of your site). * * * - * + * * * * * * - * + * * * * *
    reviewer_type reviewer_type
    Details The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of - * your site) The type of rating being provided: editorial (a review written by a + * member of your staff) or “user” ( a review written by a user of your site)
    @@ -676,7 +703,8 @@ public interface Review extends GlobalInterface { *
    * - * @return The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site). + * @return The type of rating being provided: editorial (a review written by a member of your + * staff) or “user” ( a review written by a user of your site). */ public String getReviewerType(); @@ -687,7 +715,8 @@ public interface Review extends GlobalInterface { *
    url_of_item_being_reviewed url_of_item_being_reviewed
    @@ -699,7 +728,8 @@ public interface Review extends GlobalInterface { *
    Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed> <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g: + * url_of_item_being_reviewed>
    url_of_item_being_reviewed url_of_item_being_reviewed
    @@ -741,7 +772,8 @@ public interface Review extends GlobalInterface { *
    Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed> <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g: + * url_of_item_being_reviewed>
    author author
    Details
    author author
    Details
    pages pages
    pages pages
    publication_name publication_name
    Example <g:publication_name> Journal of Appropriate Technology</g:publication_name> <g:publication_name> Journal of Appropriate + * Technology</g:publication_name>
    publication_name publication_name
    Example <g:publication_name> Journal of Appropriate Technology</g:publication_name> <g:publication_name> Journal of Appropriate + * Technology</g:publication_name>
    publication_volume publication_volume
    Details
    publication_volume publication_volume
    Details
    * * - * + * * * * * - * + * * * * @@ -408,15 +421,17 @@ public interface ScholarlyArticle extends GlobalInterface { *
    publish_date publish_date
    * * Details Date the item was published in ISO 8601 format: - * YYYY-MM-DD Date the item was published in ISO 8601 + * format: YYYY-MM-DD
    * * - * + * * * * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/Service.java b/src/main/java/org/rometools/feed/module/base/Service.java index a540504..57e1bd4 100644 --- a/src/main/java/org/rometools/feed/module/base/Service.java +++ b/src/main/java/org/rometools/feed/module/base/Service.java @@ -58,14 +58,16 @@ public interface Service extends GlobalInterface { *
    publish_date publish_date
    * * Details Date the item was published in ISO 8601 format: - * YYYY-MM-DD Date the item was published in ISO 8601 + * format: YYYY-MM-DD
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -100,14 +102,16 @@ public interface Service extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -142,7 +146,8 @@ public interface Service extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * @@ -152,7 +157,8 @@ public interface Service extends GlobalInterface { * * * * @@ -180,7 +186,8 @@ public interface Service extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -190,7 +197,8 @@ public interface Service extends GlobalInterface { * * * * @@ -217,7 +225,8 @@ public interface Service extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -254,7 +263,8 @@ public interface Service extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -292,32 +302,37 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -338,32 +353,37 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -385,14 +405,17 @@ public interface Service extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -433,14 +456,17 @@ public interface Service extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -480,7 +506,8 @@ public interface Service extends GlobalInterface { *
    delivery_radiusdelivery_radius
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    * * - * + * * * * @@ -491,7 +518,8 @@ public interface Service extends GlobalInterface { * * * - * + * * * * @@ -519,7 +547,8 @@ public interface Service extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -530,7 +559,8 @@ public interface Service extends GlobalInterface { * * * - * + * * * * @@ -560,12 +590,14 @@ public interface Service extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -606,12 +638,14 @@ public interface Service extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -651,13 +685,15 @@ public interface Service extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    * * - * + * * * * * * - * + * * * * @@ -693,13 +729,15 @@ public interface Service extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�The type of pricing for the item. Acceptable values are �negotiable,� or + * �starting.� The default is �starting�
    * * - * + * * * * * * - * + * * * * @@ -735,13 +773,14 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -783,13 +822,14 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -832,12 +872,14 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -869,12 +911,14 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -911,12 +955,14 @@ public interface Service extends GlobalInterface { * * * - * @@ -967,12 +1013,14 @@ public interface Service extends GlobalInterface { * * * - * @@ -1016,7 +1064,8 @@ public interface Service extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�The type of pricing for the item. Acceptable values are �negotiable,� or + * �starting.� The default is �starting�
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    service_type service_type
    Details The type of service being offered. Web hosting, legal, gardening, etc. The type of service being offered. Web hosting, legal, gardening, + * etc.
    Example
    service_type service_type
    Details The type of service being offered. Web hosting, legal, gardening, etc. The type of service being offered. Web hosting, legal, gardening, + * etc.
    Example
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    * * - * + * * * * @@ -1058,7 +1107,8 @@ public interface Service extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/Travel.java b/src/main/java/org/rometools/feed/module/base/Travel.java index df9b52c..16d3460 100644 --- a/src/main/java/org/rometools/feed/module/base/Travel.java +++ b/src/main/java/org/rometools/feed/module/base/Travel.java @@ -59,14 +59,16 @@ public interface Travel extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -101,14 +103,16 @@ public interface Travel extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -143,7 +147,8 @@ public interface Travel extends GlobalInterface { *
    currencycurrency
    DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
    Example
    * * - * + * * * * @@ -153,7 +158,8 @@ public interface Travel extends GlobalInterface { * * * * @@ -181,7 +187,8 @@ public interface Travel extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -191,7 +198,8 @@ public interface Travel extends GlobalInterface { * * * * @@ -218,7 +226,8 @@ public interface Travel extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -255,7 +264,8 @@ public interface Travel extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -293,7 +303,8 @@ public interface Travel extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -305,12 +316,15 @@ public interface Travel extends GlobalInterface { * * * * * @@ -338,7 +352,8 @@ public interface Travel extends GlobalInterface { *
    from_locationfrom_location
    Example Acceptable:
    - * <g:from_location>San Francisco, CA</g:from_location>
    + * <g:from_location>San Francisco, + * CA</g:from_location>
    * - * <g:from_location>Paris, France</g:from_location>
    + * <g:from_location>Paris, + * France</g:from_location>
    * * Not acceptable:
    - * <g:from_location> San Francisco International + * <g:from_location> San Francisco + * International * Airport</g:from_location>
    * * - * + * * * * @@ -350,12 +365,15 @@ public interface Travel extends GlobalInterface { * * * * * @@ -384,14 +402,17 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * - * + * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, + * include multiple instances of the <payment_accepted> attribute for each acceptable + * method. * * * @@ -430,14 +451,17 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * - * + * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, + * include multiple instances of the <payment_accepted> attribute for each acceptable + * method. * * * @@ -475,7 +499,8 @@ public interface Travel extends GlobalInterface { *
    from_locationfrom_location
    Example Acceptable:
    - * <g:from_location>San Francisco, CA</g:from_location>
    + * <g:from_location>San Francisco, + * CA</g:from_location>
    * - * <g:from_location>Paris, France</g:from_location>
    + * <g:from_location>Paris, + * France</g:from_location>
    * * Not acceptable:
    - * <g:from_location> San Francisco International + * <g:from_location> San Francisco + * International * Airport</g:from_location>
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” + * Acceptable payment methods for item purchases. Acceptable values are + * “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” * - * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the <payment_accepted> - * attribute for each acceptable method.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” + * Acceptable payment methods for item purchases. Acceptable values are + * “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,” * - * “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the <payment_accepted> - * attribute for each acceptable method.
    * * - * + * * * * @@ -487,7 +512,8 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * @@ -516,7 +542,8 @@ public interface Travel extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -528,7 +555,8 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * @@ -559,12 +587,14 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -603,13 +633,15 @@ public interface Travel extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    * * - * + * * * * * * - * + * * * * @@ -644,13 +676,15 @@ public interface Travel extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”The type of pricing for the item. Acceptable values are “negotiable,” or + * “starting.” The default is “starting”
    * * - * + * * * * * * - * + * * * * @@ -686,13 +720,14 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -734,13 +769,14 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -781,7 +817,8 @@ public interface Travel extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”The type of pricing for the item. Acceptable values are “negotiable,” or + * “starting.” The default is “starting”
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    * * - * + * * * * @@ -823,7 +860,8 @@ public interface Travel extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * @@ -952,7 +990,8 @@ public interface Travel extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * @@ -967,11 +1006,14 @@ public interface Travel extends GlobalInterface { * Example * * * * @@ -999,7 +1041,8 @@ public interface Travel extends GlobalInterface { *
    to_location to_location
    Acceptable:
    - * <g:to_location>San Francisco, CA</g:to_location>
    - * <g:to_location>Paris, France</g:to_location>
    + * <g:to_location>San Francisco, + * CA</g:to_location>
    + * <g:to_location>Paris, + * France</g:to_location>
    * * Not acceptable:
    - * <g:to_location>San Francisco International + * <g:to_location>San Francisco + * International * Airport</g:to_location>
    * * - * + * * * * @@ -1014,11 +1057,14 @@ public interface Travel extends GlobalInterface { * Example * * * * @@ -1045,13 +1091,16 @@ public interface Travel extends GlobalInterface { *
    to_location to_location
    Acceptable:
    - * <g:to_location>San Francisco, CA</g:to_location>
    - * <g:to_location>Paris, France</g:to_location>
    + * <g:to_location>San Francisco, + * CA</g:to_location>
    + * <g:to_location>Paris, + * France</g:to_location>
    * * Not acceptable:
    - * <g:to_location>San Francisco International + * <g:to_location>San Francisco + * International * Airport</g:to_location>
    * * - * + * * * * * - * * - * + * * * * * - * + * * * * * * - * + * * * * @@ -668,7 +699,8 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * @@ -782,14 +814,17 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -830,14 +865,17 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * - * + * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one + * method, include multiple instances of the <payment_accepted> attribute for each + * acceptable method. * * * @@ -877,7 +915,8 @@ public interface Vehicle extends GlobalInterface { *
    travel_date_range travel_date_range
    Details Departure date and time of the trip in ISO 8601 - * format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two sub-attributes are included in travel_date_range attribute. + * Departure date and time of the trip in ISO 8601 + * format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two + * sub-attributes are included in travel_date_range attribute. *
      * *
    • start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
      • @@ -1094,13 +1143,16 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * * - * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -1189,32 +1246,37 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -1242,12 +1304,14 @@ public interface Travel extends GlobalInterface { * * * - * diff --git a/src/main/java/org/rometools/feed/module/base/Unknown.java b/src/main/java/org/rometools/feed/module/base/Unknown.java index d022747..70e4a74 100644 --- a/src/main/java/org/rometools/feed/module/base/Unknown.java +++ b/src/main/java/org/rometools/feed/module/base/Unknown.java @@ -44,7 +44,8 @@ import java.net.URL; import org.rometools.feed.module.base.types.IntUnit; /** - * This interface contains all the other schema elements that the document doesn't associate with a particular type. + * This interface contains all the other schema elements that the document doesn't associate with a + * particular type. * * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/base/ValidationException.java b/src/main/java/org/rometools/feed/module/base/ValidationException.java index 7dd4e9f..9c3dd54 100644 --- a/src/main/java/org/rometools/feed/module/base/ValidationException.java +++ b/src/main/java/org/rometools/feed/module/base/ValidationException.java @@ -21,7 +21,8 @@ package org.rometools.feed.module.base; /** - * This is an unchecked exception that is thrown when a data value violates the Google Schema limits. + * This is an unchecked exception that is thrown when a data value violates the Google Schema + * limits. * * @version $Revision: 1.1 $ * @author Robert "kebernet" Cooper diff --git a/src/main/java/org/rometools/feed/module/base/Vehicle.java b/src/main/java/org/rometools/feed/module/base/Vehicle.java index 12071be..95ca3f8 100644 --- a/src/main/java/org/rometools/feed/module/base/Vehicle.java +++ b/src/main/java/org/rometools/feed/module/base/Vehicle.java @@ -60,7 +60,8 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * @@ -100,7 +101,8 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * @@ -139,7 +141,8 @@ public interface Vehicle extends GlobalInterface { *
      travel_date_range travel_date_range
      Details Departure date and time of the trip in ISO 8601 - * format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two sub-attributes are included in travel_date_range attribute. + * Departure date and time of the trip in ISO 8601 + * format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two + * sub-attributes are included in travel_date_range attribute. *
        * *
      • start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
        • @@ -1143,32 +1195,37 @@ public interface Travel extends GlobalInterface { *
      location location
      Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
      Example Acceptable:
      - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
      * * Not acceptable:
      - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
      - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
      Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
      location location
      Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
      Example Acceptable:
      - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
      * * Not acceptable:
      - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
      - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
      Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
      Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
        * - *
      • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
        • - *
      • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
        • + *
      • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
        • + *
      • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
        • *
      • price = the price of shipping.
        • *
      *
      color color
      color color
      * * - * + * * * * @@ -177,7 +180,8 @@ public interface Vehicle extends GlobalInterface { *
      conditioncondition
      * * - * + * * * * @@ -215,14 +219,16 @@ public interface Vehicle extends GlobalInterface { *
      conditioncondition
      * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -257,14 +263,16 @@ public interface Vehicle extends GlobalInterface { *
      currencycurrency
      DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
      Example
      * * - * + * * * * * * * + * href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217 + * currency code format. * * * @@ -299,7 +307,8 @@ public interface Vehicle extends GlobalInterface { *
      currencycurrency
      DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
      Example
      * * - * + * * * * @@ -309,7 +318,8 @@ public interface Vehicle extends GlobalInterface { * * * * @@ -337,7 +347,8 @@ public interface Vehicle extends GlobalInterface { *
      delivery_notesdelivery_notes
      Details
      Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
      + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
      * *
      * * - * + * * * * @@ -347,7 +358,8 @@ public interface Vehicle extends GlobalInterface { * * * * @@ -374,7 +386,8 @@ public interface Vehicle extends GlobalInterface { *
      delivery_notesdelivery_notes
      Details
      Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
      + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
      * *
      * * - * + * * * * @@ -411,7 +424,8 @@ public interface Vehicle extends GlobalInterface { *
      delivery_radiusdelivery_radius
      * * - * + * * * * @@ -444,37 +458,43 @@ public interface Vehicle extends GlobalInterface { public FloatUnit getDeliveryRadius(); /** - * Location of a property. Should include street, city, state, postal code, and country, in that order. + * Location of a property. Should include street, city, state, postal code, and country, in that + * order. *
      delivery_radiusdelivery_radius
      * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -485,42 +505,49 @@ public interface Vehicle extends GlobalInterface { * *
      location location
      Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
      Example Acceptable:
      - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
      * * Not acceptable:
      - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
      - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
      Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
      * - * @param location Location of a property. Should include street, city, state, postal code, and country, in that order. + * @param location Location of a property. Should include street, city, state, postal code, and + * country, in that order. */ public void setLocation(String location); /** - * Location of a property. Should include street, city, state, postal code, and country, in that order. + * Location of a property. Should include street, city, state, postal code, and country, in that + * order. * * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -531,7 +558,8 @@ public interface Vehicle extends GlobalInterface { * *
      location location
      Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
      Example Acceptable:
      - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
      * * Not acceptable:
      - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
      - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
      Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
      * - * @return Location of a property. Should include street, city, state, postal code, and country, in that order. + * @return Location of a property. Should include street, city, state, postal code, and country, + * in that order. */ public String getLocation(); @@ -542,7 +570,8 @@ public interface Vehicle extends GlobalInterface { * *
    make make
    @@ -584,7 +613,8 @@ public interface Vehicle extends GlobalInterface { * *
    make make
    @@ -626,7 +656,8 @@ public interface Vehicle extends GlobalInterface { *
    mileagemileage + *
    mileagemileage + *
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    payment_accepted payment_accepted
    Details Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," + * Acceptable payment methods for item purchases. Acceptable values are + * "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard," * - * "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the - * <payment_accepted> attribute for each acceptable method.
    * * - * + * * * * @@ -888,7 +927,8 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * @@ -916,7 +956,8 @@ public interface Vehicle extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    * * - * + * * * * @@ -927,7 +968,8 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * @@ -957,12 +999,14 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -1003,12 +1047,14 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * - * + * * * * @@ -1048,13 +1094,15 @@ public interface Vehicle extends GlobalInterface { *
    payment_notes payment_notes
    Example <g:payment_notes>Cash only for local orders.</g:payment_notes> <g:payment_notes>Cash only for local + * orders.</g:payment_notes>
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    price price
    Details Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of - * <shipping>, the value included reflects the price of shipping. Prices can be a single price, 0 (free), or blank if not applicable. + * Numerice values only. When used as a sub-attribute of <shipping>, the value included + * reflects the price of shipping.
    * * - * + * * * * * * - * + * * * * @@ -1090,13 +1138,15 @@ public interface Vehicle extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�The type of pricing for the item. Acceptable values are �negotiable,� or + * �starting.� The default is �starting�
    * * - * + * * * * * * - * + * * * * @@ -1132,13 +1182,14 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -1180,13 +1231,14 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * * - * + * * * * @@ -1234,12 +1286,14 @@ public interface Vehicle extends GlobalInterface { * * * - * @@ -1290,12 +1344,14 @@ public interface Vehicle extends GlobalInterface { * * * - * @@ -1339,7 +1395,8 @@ public interface Vehicle extends GlobalInterface { *
    price_typeprice_type
    DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�The type of pricing for the item. Acceptable values are �negotiable,� or + * �starting.� The default is �starting�
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    quantity quantity
    Details The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not - * applicable. The number of units available for purchase. This attribute can be left + * blank if you have a large quantity or if it is not applicable.
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    Details Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included - * in the shipping attribute: + * Shipping options available for an item. Up to 10 shipping options can be + * included for each item. Three sub-attributes are included in the shipping attribute: *
      * - *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
      • - *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
      • + *
    • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', + * 'DHL', 'Mail', and 'Other'
      • + *
    • country = The country an item will ship to. Only acceptable values are ISO 3166 + * country codes.
      • *
    • price = the price of shipping.
      • *
    *
    * * - * + * * * * @@ -1381,7 +1438,8 @@ public interface Vehicle extends GlobalInterface { *
    tax_percent tax_percent
    * * - * + * * * * @@ -1596,7 +1654,8 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * @@ -1635,7 +1694,8 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * @@ -1675,7 +1735,8 @@ public interface Vehicle extends GlobalInterface { *
    tax_percent tax_percent
    vin vin
    vin vin
    * * - * + * * * * @@ -1723,7 +1784,8 @@ public interface Vehicle extends GlobalInterface { *
    year year
    * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/Wanted.java b/src/main/java/org/rometools/feed/module/base/Wanted.java index e53610e..8ef033f 100644 --- a/src/main/java/org/rometools/feed/module/base/Wanted.java +++ b/src/main/java/org/rometools/feed/module/base/Wanted.java @@ -54,7 +54,8 @@ public interface Wanted extends GlobalInterface { *
    year year
    * * - * + * * * * @@ -64,7 +65,8 @@ public interface Wanted extends GlobalInterface { * * * * @@ -92,7 +94,8 @@ public interface Wanted extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -102,7 +105,8 @@ public interface Wanted extends GlobalInterface { * * * * @@ -129,7 +133,8 @@ public interface Wanted extends GlobalInterface { *
    delivery_notesdelivery_notes
    Details
    Example - * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
    + * <g:delivery_notes>Items usually shipped within 24 + * hours.<g:/delivery_notes>
    * *
    * * - * + * * * * @@ -166,7 +171,8 @@ public interface Wanted extends GlobalInterface { *
    delivery_radiusdelivery_radius
    * * - * + * * * * @@ -204,32 +210,37 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * @@ -250,32 +261,37 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * * - * + * * * * * * * * * * * - * + * * * * diff --git a/src/main/java/org/rometools/feed/module/base/types/ShortDate.java b/src/main/java/org/rometools/feed/module/base/types/ShortDate.java index 117bb8e..6bb4220 100644 --- a/src/main/java/org/rometools/feed/module/base/types/ShortDate.java +++ b/src/main/java/org/rometools/feed/module/base/types/ShortDate.java @@ -42,8 +42,8 @@ package org.rometools.feed.module.base.types; import java.util.Date; /** - * This is a simple wrapper for java.util.Date that indicates it should be formatted without time of day for Google Base. It should be transparent to module - * developers. + * This is a simple wrapper for java.util.Date that indicates it should be formatted without time of + * day for Google Base. It should be transparent to module developers. * * Move along. Nothing to see here. * diff --git a/src/main/java/org/rometools/feed/module/content/io/ContentModuleParser.java b/src/main/java/org/rometools/feed/module/content/io/ContentModuleParser.java index 9c374a0..3df7c3a 100644 --- a/src/main/java/org/rometools/feed/module/content/io/ContentModuleParser.java +++ b/src/main/java/org/rometools/feed/module/content/io/ContentModuleParser.java @@ -121,7 +121,7 @@ public class ContentModuleParser implements com.sun.syndication.io.ModuleParser contentStrings.add(value.getText()); } - ci.setContentValueDOM((List) value.clone().getContent()); + ci.setContentValueDOM(value.clone().getContent()); } if (format != null) { diff --git a/src/main/java/org/rometools/feed/module/georss/GeoRSSUtils.java b/src/main/java/org/rometools/feed/module/georss/GeoRSSUtils.java index c4ed256..2b1e83f 100644 --- a/src/main/java/org/rometools/feed/module/georss/GeoRSSUtils.java +++ b/src/main/java/org/rometools/feed/module/georss/GeoRSSUtils.java @@ -29,7 +29,8 @@ import com.sun.syndication.feed.synd.SyndFeed; public class GeoRSSUtils { /** - * This convenience method checks whether there is any geoRss Element and will return it (georss simple or W3GGeo). + * This convenience method checks whether there is any geoRss Element and will return it (georss + * simple or W3GGeo). * * @param entry the element in the feed which might have a georss element * @return a georssmodule or null if none is present @@ -50,14 +51,17 @@ public class GeoRSSUtils { return null; /* - * if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if - * (geoRSSModule != null && w3cGeo != null) { // sanity check if (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new + * if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if + * (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if (geoRSSModule != + * null && w3cGeo != null) { // sanity check if + * (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new * Error("geometry of simple and w3c do not match"); } } return geoRSSModule; */ } /** - * This convenience method checks whether there is any geoRss Element and will return it (georss simple or W3GGeo). + * This convenience method checks whether there is any geoRss Element and will return it (georss + * simple or W3GGeo). * * @param feed the element in the feed which might have a georss element * @return a georssmodule or null if none is present @@ -79,8 +83,10 @@ public class GeoRSSUtils { return null; /* - * if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if - * (geoRSSModule != null && w3cGeo != null) { // sanity check if (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new + * if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if + * (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if (geoRSSModule != + * null && w3cGeo != null) { // sanity check if + * (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new * Error("geometry of simple and w3c do not match"); } } return geoRSSModule; */ } diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/Envelope.java b/src/main/java/org/rometools/feed/module/georss/geometries/Envelope.java index 5b8dff4..a62f2b0 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/Envelope.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/Envelope.java @@ -10,8 +10,9 @@ package org.rometools.feed.module.georss.geometries; /** - * Envelope, a bounding box spanned by an upper right and lower left corner point. Note that if the box spans the -180 180 degree meridian the numerical value - * of the minLongitude may be greater than the maxLongitude. + * Envelope, a bounding box spanned by an upper right and lower left corner point. Note that if the + * box spans the -180 180 degree meridian the numerical value of the minLongitude may be greater + * than the maxLongitude. * * @author runaas */ diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/LinearRing.java b/src/main/java/org/rometools/feed/module/georss/geometries/LinearRing.java index b474ed8..14845c1 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/LinearRing.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/LinearRing.java @@ -10,7 +10,8 @@ package org.rometools.feed.module.georss.geometries; /** - * Linear boundary object constructed by linear interpolation between points. Start and end point should be identical. + * Linear boundary object constructed by linear interpolation between points. Start and end point + * should be identical. * * @author runaas */ diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/PositionList.java b/src/main/java/org/rometools/feed/module/georss/geometries/PositionList.java index a62d27b..f24d861 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/PositionList.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/PositionList.java @@ -122,7 +122,8 @@ public class PositionList implements Cloneable, Serializable { } /** - * Add a position at a given index in the list. The rest of the list is shifted one place to the "right" + * Add a position at a given index in the list. The rest of the list is shifted one place to the + * "right" * * @param pos position index * @param latitude diff --git a/src/main/java/org/rometools/feed/module/itunes/types/Category.java b/src/main/java/org/rometools/feed/module/itunes/types/Category.java index 6d7029f..4be9d92 100644 --- a/src/main/java/org/rometools/feed/module/itunes/types/Category.java +++ b/src/main/java/org/rometools/feed/module/itunes/types/Category.java @@ -43,7 +43,8 @@ package org.rometools.feed.module.itunes.types; import java.io.Serializable; /** - * This Category information. Basically a name and an optional Subcategory. Categories are defined by Apple. See ITMS for a view. + * This Category information. Basically a name and an optional Subcategory. Categories are defined + * by Apple. See ITMS for a view. * * @version $Revision: 1.2 $ * @author Robert "kebernet" Cooper diff --git a/src/main/java/org/rometools/feed/module/itunes/types/Duration.java b/src/main/java/org/rometools/feed/module/itunes/types/Duration.java index 11d069a..a79727d 100644 --- a/src/main/java/org/rometools/feed/module/itunes/types/Duration.java +++ b/src/main/java/org/rometools/feed/module/itunes/types/Duration.java @@ -46,7 +46,8 @@ import java.util.StringTokenizer; import com.sun.syndication.io.impl.NumberParser; /** - * An encapsulation of the duration of a podcast. This will serialize (via .toString()) to HH:MM:SS format, and can parse [H]*H:[M]*M:[S]*S or [M]*M:[S]*S. + * An encapsulation of the duration of a podcast. This will serialize (via .toString()) to HH:MM:SS + * format, and can parse [H]*H:[M]*M:[S]*S or [M]*M:[S]*S. * * @version $Revision: 1.7 $ * @author Robert "kebernet" Cooper diff --git a/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModuleImpl.java b/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModuleImpl.java index df7ccdc..aa0c62b 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModuleImpl.java @@ -40,7 +40,8 @@ public class MediaEntryModuleImpl extends MediaModuleImpl implements MediaEntryM private static final long serialVersionUID = 1L; /* - * the variables in the MediaModule are set when they apply to all MediaContent instances in the set + * the variables in the MediaModule are set when they apply to all MediaContent instances in the + * set */ private MediaContent[] mediaContents = new MediaContent[0]; private MediaGroup[] mediaGroups = new MediaGroup[0]; diff --git a/src/main/java/org/rometools/feed/module/mediarss/MediaModule.java b/src/main/java/org/rometools/feed/module/mediarss/MediaModule.java index f407db8..ba5e9e3 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/MediaModule.java +++ b/src/main/java/org/rometools/feed/module/mediarss/MediaModule.java @@ -29,7 +29,8 @@ import com.sun.syndication.feed.module.Module; /** * This is the base module for MediaRSS. *

    - * It represents information that can be stored at the feed level, as well is a base for entry level information, as the same information can apply. + * It represents information that can be stored at the feed level, as well is a base for entry level + * information, as the same information can apply. *

    * * @author Nathanial X. Freitas diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Category.java b/src/main/java/org/rometools/feed/module/mediarss/types/Category.java index d5262bb..9a6a443 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Category.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Category.java @@ -31,28 +31,31 @@ import com.sun.syndication.feed.impl.ToStringBean; * * <media:category>

    *

    - * Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes. + * Allows a taxonomy to be set that gives an indication of the type of media content, and its + * particular contents. It has 2 optional attributes. *

    * * 
      * <media:category scheme="http://search.yahoo.com/mrss/category_
  *        schema">music/artist/album/song</media:category>
- *
+ * 
  *        <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet
  *        Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_
  *        -_Pet_Detective</media:category>
- *
+ * 
  *        <media:category scheme="urn:flickr:tags">ycantpark
  *        mobile</media:category>
  *
    * *

    - * scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme is + * scheme is the URI that identifies the categorization scheme. It is an optional + * attribute. If this attribute is not included, the default scheme is * 'http://search.yahoo.com/mrss/category_schema'. *

    * *

    - * label is the human readable label that can be displayed in end user applications. It is an optional attribute. + * label is the human readable label that can be displayed in end user applications. It is + * an optional attribute. *

    * * @author cooper @@ -90,20 +93,24 @@ public class Category implements Serializable { } /** - * label is the human readable label that can be displayed in end user applications. It is an optional attribute. + * label is the human readable label that can be displayed in end user applications. It is an + * optional attribute. * - * @return label is the human readable label that can be displayed in end user applications. It is an optional attribute. + * @return label is the human readable label that can be displayed in end user applications. It + * is an optional attribute. */ public String getLabel() { return label; } /** - * scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme is + * scheme is the URI that identifies the categorization scheme. It is an optional attribute. If + * this attribute is not included, the default scheme is * 'http://search.yahoo.com/mrss/category_schema'. * - * @return scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme - * is 'http://search.yahoo.com/mrss/category_schema'. + * @return scheme is the URI that identifies the categorization scheme. It is an optional + * attribute. If this attribute is not included, the default scheme is + * 'http://search.yahoo.com/mrss/category_schema'. */ public String getScheme() { return scheme; diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Credit.java b/src/main/java/org/rometools/feed/module/mediarss/types/Credit.java index 507a0a2..00bdb29 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Credit.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Credit.java @@ -32,9 +32,10 @@ import com.sun.syndication.feed.impl.ToStringBean; * <media:credit>

    * *

    - * Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific entities - * can have multiple roles, and several entities can have the same role. These should appear as distinct <media:credit> elements. It has 2 optional - * attributes. + * Notable entity and the contribution to the creation of the media object. Current entities can + * include people, companies, locations, etc. Specific entities can have multiple roles, and several + * entities can have the same role. These should appear as distinct <media:credit> elements. + * It has 2 optional attributes. *

    * * 
    @@ -45,8 +46,9 @@ import com.sun.syndication.feed.impl.ToStringBean;
  * 
    
  *
  * 
    
- * scheme is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is 'urn:ebu'.
- * See: European Broadcasting Union Role Codes.
+ * scheme is the URI that identifies the role scheme. It is an optional attribute. If this
+ * attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting Union Role
+ * Codes.
  * 
    
  *
  *
@@ -78,7 +80,9 @@ import com.sun.syndication.feed.impl.ToStringBean;
  *        vocalist
  *
    *

    - * Additional roles: European Broadcasting Union Role Codes + * Additional roles: European + * Broadcasting Union Role Codes * * @author cooper */ diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Expression.java b/src/main/java/org/rometools/feed/module/mediarss/types/Expression.java index 2b3d3af..b72690b 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Expression.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Expression.java @@ -20,8 +20,9 @@ package org.rometools.feed.module.mediarss.types; import java.io.Serializable; /** - * expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop). Default - * value is 'full'. It is an optional attribute. + * expression determines if the object is a sample or the full version of the object, or even if it + * is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an optional + * attribute. */ public class Expression implements Serializable { private static final long serialVersionUID = 1L; diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Hash.java b/src/main/java/org/rometools/feed/module/mediarss/types/Hash.java index e2a4d70..ea426bf 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Hash.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Hash.java @@ -32,7 +32,8 @@ import com.sun.syndication.feed.impl.ToStringBean; * <media:hash>

    * *

    - * This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional attribute. + * This is the hash of the binary media file. It can appear multiple times as long as each instance + * is a different algo. It has 1 optional attribute. *

    *

    *

    @@ -42,7 +43,8 @@ import com.sun.syndication.feed.impl.ToStringBean; * * *

    - * algo indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional attribute. + * algo indicates the algorithm used to create the hash. Possible values are 'md5' and + * 'sha-1'. Default value is 'md5'. It is an optional attribute. * * @author cooper */ diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/MediaContent.java b/src/main/java/org/rometools/feed/module/mediarss/types/MediaContent.java index b039f68..e8cbb5c 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/MediaContent.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/MediaContent.java @@ -29,9 +29,11 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * <media:content>

    *

    - * <media:content> is a sub-element of either <item> or <media:group>. Media objects that are not the same content should not be included - * in the same <media:group> element. The sequence of these items implies the order of presentation. While many of the attributes appear to be - * audio/video specific, this element can be used to publish any type of media. It contains 14 attributes, most of which are optional. + * <media:content> is a sub-element of either <item> or <media:group>. Media + * objects that are not the same content should not be included in the same <media:group> + * element. The sequence of these items implies the order of presentation. While many of the + * attributes appear to be audio/video specific, this element can be used to publish any type of + * media. It contains 14 attributes, most of which are optional. *

    * * 
    @@ -53,7 +55,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
  *
    * *

    - * url should specify the direct url to the media object. If not included, a <media:player> element must be specified. + * url should specify the direct url to the media object. If not included, a + * <media:player> element must be specified. *

    *

    * fileSize is the number of bytes of the media object. It is an optional attribute. @@ -63,31 +66,35 @@ import com.sun.syndication.feed.impl.ToStringBean; *

    * *

    - * medium is the type of object (image | audio | video | document | executable). While this attribute can at times seem redundant if type is - * supplied, it is included because it simplifies decision making on the reader side, as well as flushes out any ambiguities between MIME type and object type. - * It is an optional attribute. + * medium is the type of object (image | audio | video | document | executable). While this + * attribute can at times seem redundant if type is supplied, it is included because it + * simplifies decision making on the reader side, as well as flushes out any ambiguities between + * MIME type and object type. It is an optional attribute. *

    * * *

    - * isDefault determines if this is the default object that should be used for the <media:group>. There should only be one default object per - * <media:group>. It is an optional attribute. + * isDefault determines if this is the default object that should be used for the + * <media:group>. There should only be one default object per <media:group>. It is an + * optional attribute. *

    * *

    - * expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop). - * Default value is 'full'. It is an optional attribute. + * expression determines if the object is a sample or the full version of the object, or + * even if it is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an + * optional attribute. *

    * *

    * bitrate is the kilobits per second rate of media. It is an optional attribute. *

    *

    - * framerate is the number of frames per second for the media object. It is an optional attribute. + * framerate is the number of frames per second for the media object. It is an optional + * attribute. *

    *

    - * samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It is - * an optional attribute. + * samplingrate is the number of samples per second taken to create the media object. It is + * expressed in thousands of samples per second (kHz). It is an optional attribute. *

    *

    * channels is number of audio channels in the media object. It is an optional attribute. @@ -108,20 +115,23 @@ import com.sun.syndication.feed.impl.ToStringBean; *

    * *

    - * lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to - * the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute. + * lang is the primary language encapsulated in the media object. Language codes possible + * are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute + * detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute. *

    * * *

    - * These optional attributes, along with the optional elements below, contain the primary metadata entries needed to index and organize media content. - * Additional supported attributes for describing images, audio, and video may be added in future revisions of this document. + * These optional attributes, along with the optional elements below, contain the primary metadata + * entries needed to index and organize media content. Additional supported attributes for + * describing images, audio, and video may be added in future revisions of this document. *

    * * @author Nathanial X. Freitas * - * MediaContent corresponds to the element defined within the MediaRSS specification. There may be one or more instances - * within each instance of an within an RSS 2.0 document. + * MediaContent corresponds to the element defined within the MediaRSS + * specification. There may be one or more instances within each instance of + * an within an RSS 2.0 document. */ public class MediaContent implements Serializable { private static final long serialVersionUID = 1L; @@ -131,7 +141,8 @@ public class MediaContent implements Serializable { private Float samplingrate = null; /* - * private variable for storing instances of Thumbnail class each MediaContent can have zero to many thumbnails + * private variable for storing instances of Thumbnail class each MediaContent can have zero to + * many thumbnails */ private Integer audioChannels = null; @@ -178,7 +189,8 @@ public class MediaContent implements Serializable { /** * channels is number of audio channels in the media object. It is an optional attribute. * - * @param audioChannels channels is number of audio channels in the media object. It is an optional attribute. + * @param audioChannels channels is number of audio channels in the media object. It is an + * optional attribute. */ public void setAudioChannels(final Integer audioChannels) { this.audioChannels = audioChannels; @@ -187,7 +199,8 @@ public class MediaContent implements Serializable { /** * channels is number of audio channels in the media object. It is an optional attribute. * - * @return channels is number of audio channels in the media object. It is an optional attribute. + * @return channels is number of audio channels in the media object. It is an optional + * attribute. */ public Integer getAudioChannels() { return audioChannels; @@ -212,22 +225,24 @@ public class MediaContent implements Serializable { } /** - * isDefault determines if this is the default object that should be used for the . There should only be one default object per . - * It is an optional attribute. + * isDefault determines if this is the default object that should be used for the . + * There should only be one default object per . It is an optional attribute. * - * @param defaultContent isDefault determines if this is the default object that should be used for the . There should only be one default - * object per . It is an optional attribute. + * @param defaultContent isDefault determines if this is the default object that should be used + * for the . There should only be one default object per . + * It is an optional attribute. */ public void setDefaultContent(final boolean defaultContent) { this.defaultContent = defaultContent; } /** - * isDefault determines if this is the default object that should be used for the . There should only be one default object per . - * It is an optional attribute. + * isDefault determines if this is the default object that should be used for the . + * There should only be one default object per . It is an optional attribute. * - * @return isDefault determines if this is the default object that should be used for the . There should only be one default object per - * . It is an optional attribute. + * @return isDefault determines if this is the default object that should be used for the + * . There should only be one default object per . It is an + * optional attribute. */ public boolean isDefaultContent() { return defaultContent; @@ -236,7 +251,8 @@ public class MediaContent implements Serializable { /** * duration is the number of seconds the media object plays. It is an optional attribute. * - * @param duration duration is the number of seconds the media object plays. It is an optional attribute. + * @param duration duration is the number of seconds the media object plays. It is an optional + * attribute. */ public void setDuration(final Long duration) { this.duration = duration; @@ -245,29 +261,34 @@ public class MediaContent implements Serializable { /** * duration is the number of seconds the media object plays. It is an optional attribute. * - * @return duration is the number of seconds the media object plays. It is an optional attribute. + * @return duration is the number of seconds the media object plays. It is an optional + * attribute. */ public Long getDuration() { return duration; } /** - * expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop). - * Default value is 'full'. It is an optional attribute. + * expression determines if the object is a sample or the full version of the object, or even if + * it is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an + * optional attribute. * - * @param expression expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full - * | nonstop). Default value is 'full'. It is an optional attribute. + * @param expression expression determines if the object is a sample or the full version of the + * object, or even if it is a continuous stream (sample | full | nonstop). Default + * value is 'full'. It is an optional attribute. */ public void setExpression(final Expression expression) { this.expression = expression; } /** - * expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop). - * Default value is 'full'. It is an optional attribute. + * expression determines if the object is a sample or the full version of the object, or even if + * it is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an + * optional attribute. * - * @return expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | - * nonstop). Default value is 'full'. It is an optional attribute. + * @return expression determines if the object is a sample or the full version of the object, or + * even if it is a continuous stream (sample | full | nonstop). Default value is 'full'. + * It is an optional attribute. */ public Expression getExpression() { return expression; @@ -293,18 +314,22 @@ public class MediaContent implements Serializable { } /** - * framerate is the number of frames per second for the media object. It is an optional attribute. + * framerate is the number of frames per second for the media object. It is an optional + * attribute. * - * @param framerate framerate is the number of frames per second for the media object. It is an optional attribute. + * @param framerate framerate is the number of frames per second for the media object. It is an + * optional attribute. */ public void setFramerate(final Float framerate) { this.framerate = framerate; } /** - * framerate is the number of frames per second for the media object. It is an optional attribute. + * framerate is the number of frames per second for the media object. It is an optional + * attribute. * - * @return framerate is the number of frames per second for the media object. It is an optional attribute. + * @return framerate is the number of frames per second for the media object. It is an optional + * attribute. */ public Float getFramerate() { return framerate; @@ -329,22 +354,28 @@ public class MediaContent implements Serializable { } /** - * lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to the - * xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute. + * lang is the primary language encapsulated in the media object. Language codes possible are + * detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in + * the XML 1.0 Specification (Third Edition). It is an optional attribute. * - * @param language lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used - * similar to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute. + * @param language lang is the primary language encapsulated in the media object. Language codes + * possible are detailed in RFC 3066. This attribute is used similar to the xml:lang + * attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional + * attribute. */ public void setLanguage(final String language) { this.language = language; } /** - * lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to the - * xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute. + * lang is the primary language encapsulated in the media object. Language codes possible are + * detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in + * the XML 1.0 Specification (Third Edition). It is an optional attribute. * - * @return lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar - * to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute. + * @return lang is the primary language encapsulated in the media object. Language codes + * possible are detailed in RFC 3066. This attribute is used similar to the xml:lang + * attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional + * attribute. */ public String getLanguage() { return language; @@ -389,22 +420,26 @@ public class MediaContent implements Serializable { /** * <media:player>

    *

    - * Allows the media object to be accessed through a web browser media player console. This element is required only if a direct media url attribute - * is not specified in the <media:content> element. It has 1 required attribute, and 2 optional attributes. + * Allows the media object to be accessed through a web browser media player console. This + * element is required only if a direct media url attribute is not specified in the + * <media:content> element. It has 1 required attribute, and 2 optional attributes. *

    * * 
          * <media:player url="http://www.foo.com/player?id=1111" height="200" width="400" />
      *
    *

    - * url is the url of the player console that plays the media. It is a required attribute. + * url is the url of the player console that plays the media. It is a required + * attribute. *

    * *

    - * height is the height of the browser window that the url should be opened in. It is an optional attribute. + * height is the height of the browser window that the url should be opened + * in. It is an optional attribute. *

    *

    - * width is the width of the browser window that the url should be opened in. It is an optional attribute. + * width is the width of the browser window that the url should be opened in. + * It is an optional attribute. *

    * *

    @@ -418,22 +453,26 @@ public class MediaContent implements Serializable { /** * <media:player>

    *

    - * Allows the media object to be accessed through a web browser media player console. This element is required only if a direct media url attribute - * is not specified in the <media:content> element. It has 1 required attribute, and 2 optional attributes. + * Allows the media object to be accessed through a web browser media player console. This + * element is required only if a direct media url attribute is not specified in the + * <media:content> element. It has 1 required attribute, and 2 optional attributes. *

    * * 
          * <media:player url="http://www.foo.com/player?id=1111" height="200" width="400" />
      *
    *

    - * url is the url of the player console that plays the media. It is a required attribute. + * url is the url of the player console that plays the media. It is a required + * attribute. *

    * *

    - * height is the height of the browser window that the url should be opened in. It is an optional attribute. + * height is the height of the browser window that the url should be opened + * in. It is an optional attribute. *

    *

    - * width is the width of the browser window that the url should be opened in. It is an optional attribute. + * width is the width of the browser window that the url should be opened in. + * It is an optional attribute. *

    * * @return PlayerReference for the item. @@ -465,22 +504,23 @@ public class MediaContent implements Serializable { } /** - * samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It is an - * optional attribute. + * samplingrate is the number of samples per second taken to create the media object. It is + * expressed in thousands of samples per second (kHz). It is an optional attribute. * - * @param samplingrate samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second - * (kHz). It is an optional attribute. + * @param samplingrate samplingrate is the number of samples per second taken to create the + * media object. It is expressed in thousands of samples per second (kHz). It is an + * optional attribute. */ public void setSamplingrate(final Float samplingrate) { this.samplingrate = samplingrate; } /** - * samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It is an - * optional attribute. + * samplingrate is the number of samples per second taken to create the media object. It is + * expressed in thousands of samples per second (kHz). It is an optional attribute. * - * @return samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It - * is an optional attribute. + * @return samplingrate is the number of samples per second taken to create the media object. It + * is expressed in thousands of samples per second (kHz). It is an optional attribute. */ public Float getSamplingrate() { return samplingrate; diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/MediaGroup.java b/src/main/java/org/rometools/feed/module/mediarss/types/MediaGroup.java index 99a379f..b90b464 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/MediaGroup.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/MediaGroup.java @@ -31,9 +31,10 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * <media:group>

    *

    - * <media:group> is a sub-element of <item>. It allows grouping of <media:content> elements that are effectively the same content, yet - * different representations. For instance: the same song recorded in both the WAV and MP3 format. It's an optional element that must only be used for this - * purpose. + * <media:group> is a sub-element of <item>. It allows grouping of <media:content> + * elements that are effectively the same content, yet different representations. For instance: + * the same song recorded in both the WAV and MP3 format. It's an optional element that must only be + * used for this purpose. *

    * * @author cooper diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Metadata.java b/src/main/java/org/rometools/feed/module/mediarss/types/Metadata.java index 6214c34..d061ad5 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Metadata.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Metadata.java @@ -35,22 +35,25 @@ import com.sun.syndication.feed.impl.ToStringBean; * * Optional Elements *

    - * The following elements are optional and may appear as sub-elements of <channel>, <item>, <media:content> and/or <media:group>. + * The following elements are optional and may appear as sub-elements of <channel>, + * <item>, <media:content> and/or <media:group>. * * *

    *

    * - * When an element appears at a shallow level, such as <channel> or <item>, it means that the element should be applied to every media object within - * its scope. + * When an element appears at a shallow level, such as <channel> or <item>, it means + * that the element should be applied to every media object within its scope. *

    * * *

    - * Duplicated elements appearing at deeper levels of the document tree have higher priority over other levels. + * Duplicated elements appearing at deeper levels of the document tree have higher priority over + * other levels. * - * For example, <media:content> level elements are favored over <item> level elements. The priority level is listed from strongest to weakest: - * <media:content>, <media:group>, <item>, <channel>. + * For example, <media:content> level elements are favored over <item> level elements. + * The priority level is listed from strongest to weakest: <media:content>, + * <media:group>, <item>, <channel>. *

    * * @author cooper @@ -81,28 +84,31 @@ public class Metadata implements Cloneable, Serializable { /** * <media:category>

    *

    - * Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes. + * Allows a taxonomy to be set that gives an indication of the type of media content, and its + * particular contents. It has 2 optional attributes. *

    * * 
          * <media:category scheme="http://search.yahoo.com/mrss/category_
      *        schema">music/artist/album/song</media:category>
-     *
+     * 
      *        <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet
      *        Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_
      *        -_Pet_Detective</media:category>
-     *
+     * 
      *        <media:category scheme="urn:flickr:tags">ycantpark
      *        mobile</media:category>
      *
    * *

    - * scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme - * is 'http://search.yahoo.com/mrss/category_schema'. + * scheme is the URI that identifies the categorization scheme. It is an optional + * attribute. If this attribute is not included, the default scheme is + * 'http://search.yahoo.com/mrss/category_schema'. *

    * *

    - * label is the human readable label that can be displayed in end user applications. It is an optional attribute. + * label is the human readable label that can be displayed in end user applications. It + * is an optional attribute. *

    * * @param categories categories for the item @@ -114,28 +120,31 @@ public class Metadata implements Cloneable, Serializable { /** * <media:category>

    *

    - * Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes. + * Allows a taxonomy to be set that gives an indication of the type of media content, and its + * particular contents. It has 2 optional attributes. *

    * * 
          * <media:category scheme="http://search.yahoo.com/mrss/category_
      *        schema">music/artist/album/song</media:category>
-     *
+     * 
      *        <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet
      *        Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_
      *        -_Pet_Detective</media:category>
-     *
+     * 
      *        <media:category scheme="urn:flickr:tags">ycantpark
      *        mobile</media:category>
      *
    * *

    - * scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme - * is 'http://search.yahoo.com/mrss/category_schema'. + * scheme is the URI that identifies the categorization scheme. It is an optional + * attribute. If this attribute is not included, the default scheme is + * 'http://search.yahoo.com/mrss/category_schema'. *

    * *

    - * label is the human readable label that can be displayed in end user applications. It is an optional attribute. + * label is the human readable label that can be displayed in end user applications. It + * is an optional attribute. *

    * * @return categories for the item. @@ -154,8 +163,9 @@ public class Metadata implements Cloneable, Serializable { * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright> * *

    - * url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the - * Creative Commons module should be used instead. It is an optional attribute. + * url is the url for a terms of use page or additional copyright information. If the + * media is operating under a Creative Commons license, the Creative Commons module should be + * used instead. It is an optional attribute. *

    * * @param copyright copyright text @@ -174,8 +184,9 @@ public class Metadata implements Cloneable, Serializable { * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright> * *

    - * url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the - * Creative Commons module should be used instead. It is an optional attribute. + * url is the url for a terms of use page or additional copyright information. If the + * media is operating under a Creative Commons license, the Creative Commons module should be + * used instead. It is an optional attribute. *

    * * @return Copyright text @@ -194,8 +205,9 @@ public class Metadata implements Cloneable, Serializable { * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright> * *

    - * url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the - * Creative Commons module should be used instead. It is an optional attribute. + * url is the url for a terms of use page or additional copyright information. If the + * media is operating under a Creative Commons license, the Creative Commons module should be + * used instead. It is an optional attribute. *

    * * @param copyrightUrl link to more copyright information. @@ -214,8 +226,9 @@ public class Metadata implements Cloneable, Serializable { * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright> * *

    - * url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the - * Creative Commons module should be used instead. It is an optional attribute. + * url is the url for a terms of use page or additional copyright information. If the + * media is operating under a Creative Commons license, the Creative Commons module should be + * used instead. It is an optional attribute. *

    * * @return Link to more copyright information. @@ -228,9 +241,10 @@ public class Metadata implements Cloneable, Serializable { * <media:credit>

    * *

    - * Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific - * entities can have multiple roles, and several entities can have the same role. These should appear as distinct <media:credit> elements. It has 2 - * optional attributes. + * Notable entity and the contribution to the creation of the media object. Current entities can + * include people, companies, locations, etc. Specific entities can have multiple roles, and + * several entities can have the same role. These should appear as distinct <media:credit> + * elements. It has 2 optional attributes. *

    * * 
    @@ -241,8 +255,9 @@ public class Metadata implements Cloneable, Serializable {
      * 
    
      *
      * 
    
-     * scheme is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is
-     * 'urn:ebu'. See: European Broadcasting Union Role Codes.
+     * scheme is the URI that identifies the role scheme. It is an optional attribute. If
+     * this attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting
+     * Union Role Codes.
      * 
    
      *
      *
@@ -274,7 +289,9 @@ public class Metadata implements Cloneable, Serializable {
      *        vocalist
      *
    *

    - * Additional roles: European Broadcasting Union Role Codes + * Additional roles: European + * Broadcasting Union Role Codes * * @param credits credits for the item. */ @@ -286,9 +303,10 @@ public class Metadata implements Cloneable, Serializable { * <media:credit>

    * *

    - * Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific - * entities can have multiple roles, and several entities can have the same role. These should appear as distinct <media:credit> elements. It has 2 - * optional attributes. + * Notable entity and the contribution to the creation of the media object. Current entities can + * include people, companies, locations, etc. Specific entities can have multiple roles, and + * several entities can have the same role. These should appear as distinct <media:credit> + * elements. It has 2 optional attributes. *

    * * 
    @@ -299,8 +317,9 @@ public class Metadata implements Cloneable, Serializable {
      * 
    
      *
      * 
    
-     * scheme is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is
-     * 'urn:ebu'. See: European Broadcasting Union Role Codes.
+     * scheme is the URI that identifies the role scheme. It is an optional attribute. If
+     * this attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting
+     * Union Role Codes.
      * 
    
      *
      *
@@ -332,7 +351,9 @@ public class Metadata implements Cloneable, Serializable {
      *        vocalist
      *
    *

    - * Additional roles: European Broadcasting Union Role Codes + * Additional roles: European + * Broadcasting Union Role Codes * * @return credits for the time. */ @@ -343,15 +364,17 @@ public class Metadata implements Cloneable, Serializable { /** * <media:description>

    *

    - * Short description describing the media object typically a sentence in length. It has 1 optional attribute. + * Short description describing the media object typically a sentence in length. It has 1 + * optional attribute. *

    * * 
          * <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
      *
    *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be - * entity-encoded. It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or + * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional + * attribute. *

    * * @param description value of the description @@ -363,15 +386,17 @@ public class Metadata implements Cloneable, Serializable { /** * <media:description>

    *

    - * Short description describing the media object typically a sentence in length. It has 1 optional attribute. + * Short description describing the media object typically a sentence in length. It has 1 + * optional attribute. *

    * * 
          * <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
      *
    *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be - * entity-encoded. It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or + * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional + * attribute. *

    * * @return value of the description @@ -383,15 +408,17 @@ public class Metadata implements Cloneable, Serializable { /** * <media:description>

    *

    - * Short description describing the media object typically a sentence in length. It has 1 optional attribute. + * Short description describing the media object typically a sentence in length. It has 1 + * optional attribute. *

    * * 
          * <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
      *
    *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be - * entity-encoded. It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or + * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional + * attribute. *

    * * @param descriptionType type of the description. @@ -403,15 +430,17 @@ public class Metadata implements Cloneable, Serializable { /** * <media:description>

    *

    - * Short description describing the media object typically a sentence in length. It has 1 optional attribute. + * Short description describing the media object typically a sentence in length. It has 1 + * optional attribute. *

    * * 
          * <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
      *
    *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be - * entity-encoded. It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or + * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional + * attribute. *

    * * @return type of the description @@ -424,8 +453,8 @@ public class Metadata implements Cloneable, Serializable { * <media:hash>

    * *

    - * This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional - * attribute. + * This is the hash of the binary media file. It can appear multiple times as long as each + * instance is a different algo. It has 1 optional attribute. *

    *

    *

    @@ -435,8 +464,8 @@ public class Metadata implements Cloneable, Serializable { * * *

    - * algo indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional - * attribute. + * algo indicates the algorithm used to create the hash. Possible values are 'md5' and + * 'sha-1'. Default value is 'md5'. It is an optional attribute. * * @param hash sets the hash for the item. */ @@ -448,8 +477,8 @@ public class Metadata implements Cloneable, Serializable { * <media:hash>

    * *

    - * This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional - * attribute. + * This is the hash of the binary media file. It can appear multiple times as long as each + * instance is a different algo. It has 1 optional attribute. *

    *

    *

    @@ -459,8 +488,8 @@ public class Metadata implements Cloneable, Serializable { * * *

    - * algo indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional - * attribute. + * algo indicates the algorithm used to create the hash. Possible values are 'md5' and + * 'sha-1'. Default value is 'md5'. It is an optional attribute. * * @return returns a Hash object for the item. */ @@ -471,7 +500,8 @@ public class Metadata implements Cloneable, Serializable { /** * <media:keywords>

    *

    - * Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited. + * Highly relevant keywords describing the media object with typically a maximum of ten words. + * The keywords and phrases should be comma delimited. *

    * * 
    @@ -487,7 +517,8 @@ public class Metadata implements Cloneable, Serializable {
     /**
      * <media:keywords>
    
      * 
    
-     * Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited.
+     * Highly relevant keywords describing the media object with typically a maximum of ten words.
+     * The keywords and phrases should be comma delimited.
      * 
    
      *
      * 
    @@ -505,22 +536,22 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional
-     * attribute.
+     * This allows the permissible audience to be declared. If this element is not included, it
+     * assumes that no restrictions are necessary. It has one optional attribute.
      * 
    
      *
      * 
          * <media:rating scheme="urn:simple">adult</media:rating>
      *               <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating>
      *               <media:rating scheme="urn:mpaa">pg</media:rating>
-     *
+     * 
      *               <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
      * 
    
      *
      *
      * 
    
-     * scheme is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is
-     * urn:simple (adult | nonadult).
+     * scheme is the URI that identifies the rating scheme. It is an optional attribute. If
+     * this attribute is not included, the default scheme is urn:simple (adult | nonadult).
      * 
    
      *
      * 
    
@@ -536,22 +567,22 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional
-     * attribute.
+     * This allows the permissible audience to be declared. If this element is not included, it
+     * assumes that no restrictions are necessary. It has one optional attribute.
      * 
    
      *
      * 
          * <media:rating scheme="urn:simple">adult</media:rating>
      *               <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating>
      *               <media:rating scheme="urn:mpaa">pg</media:rating>
-     *
+     * 
      *               <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
      * 
    
      *
      *
      * 
    
-     * scheme is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is
-     * urn:simple (adult | nonadult).
+     * scheme is the URI that identifies the rating scheme. It is an optional attribute. If
+     * this attribute is not included, the default scheme is urn:simple (adult | nonadult).
      * 
    
      *
      * 
    
@@ -566,11 +597,14 @@ public class Metadata implements Cloneable, Serializable {
      * <media:restriction> 
    
      *
      * 
    
-     * Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country
-     * codes. This element is purely informational and no obligation can be assumed or implied. Only one <media:restriction> element of the same
-     * type can be applied to a media object - all others will be ignored. Entities in this element should be space separated. To allow the
-     * producer to explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1
-     * required attribute, and 1 optional attribute (with strict requirements for its exclusion).
+     * Allows restrictions to be placed on the aggregator rendering the media in the feed.
+     * Currently, restrictions are based on distributor (uri) and country codes. This element is
+     * purely informational and no obligation can be assumed or implied. Only one
+     * <media:restriction> element of the same type can be applied to a media object
+     * - all others will be ignored. Entities in this element should be space separated. To
+     * allow the producer to explicitly declare his/her intentions, two literals are reserved:
+     * 'all', 'none'. These literals can only be used once. This element has 1 required attribute,
+     * and 1 optional attribute (with strict requirements for its exclusion).
      * 
    
      *
      * 
    @@ -578,8 +612,9 @@ public class Metadata implements Cloneable, Serializable {
      * 
    
      *
      * 
    
-     * relationship indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should
-     * only be syndicated in Australia and the United States. It is a required attribute.
+     * relationship indicates the type of relationship that the restriction represents
+     * (allow | deny). In the example above, the media object should only be syndicated in Australia
+     * and the United States. It is a required attribute.
      * 
    
      *
      * @param restrictions restrictions for the item.
@@ -592,11 +627,14 @@ public class Metadata implements Cloneable, Serializable {
      * <media:restriction> 
    
      *
      * 
    
-     * Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country
-     * codes. This element is purely informational and no obligation can be assumed or implied. Only one <media:restriction> element of the same
-     * type can be applied to a media object - all others will be ignored. Entities in this element should be space separated. To allow the
-     * producer to explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1
-     * required attribute, and 1 optional attribute (with strict requirements for its exclusion).
+     * Allows restrictions to be placed on the aggregator rendering the media in the feed.
+     * Currently, restrictions are based on distributor (uri) and country codes. This element is
+     * purely informational and no obligation can be assumed or implied. Only one
+     * <media:restriction> element of the same type can be applied to a media object
+     * - all others will be ignored. Entities in this element should be space separated. To
+     * allow the producer to explicitly declare his/her intentions, two literals are reserved:
+     * 'all', 'none'. These literals can only be used once. This element has 1 required attribute,
+     * and 1 optional attribute (with strict requirements for its exclusion).
      * 
    
      *
      * 
    @@ -604,8 +642,9 @@ public class Metadata implements Cloneable, Serializable {
      * 
    
      *
      * 
    
-     * relationship indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should
-     * only be syndicated in Australia and the United States. It is a required attribute.
+     * relationship indicates the type of relationship that the restriction represents
+     * (allow | deny). In the example above, the media object should only be syndicated in Australia
+     * and the United States. It is a required attribute.
      * 
    
      *
      * @return restrictions for the item.
@@ -617,21 +656,24 @@ public class Metadata implements Cloneable, Serializable {
     /**
      * <media:text>
    
      * 
    
-     * Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time
-     * series of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on
-     * the start time. Elements can have overlapping start and end times. It has 4 optional attributes.
+     * Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content.
+     * Many of these elements are permitted to provide a time series of text. In such cases, it is
+     * encouraged, but not required, that the elements be grouped by language and appear in time
+     * sequence order based on the start time. Elements can have overlapping start
+     * and end times. It has 4 optional attributes.
      * 
    
      *
      * 
          * <media:text type="plain" lang="en" start="00:00:03.000"
      *        end="00:00:10.000"> Oh, say, can you see</media:text>
-     *
+     * 
      *        <media:text type="plain" lang="en" start="00:00:10.000"
      *        end="00:00:17.000">By the dawn's early light</media:text>
      * 
    
      * 
    
-     * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
-     * entity-encoded. It is an optional attribute.
+     * type specifies the type of text embedded. Possible values are either 'plain' or
+     * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
+     * attribute.
      * 
    
      *
      *
@@ -640,18 +682,22 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar
-     * to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
+     * lang is the primary language encapsulated in the media object. Language codes
+     * possible are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute
+     * detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
      * 
    
      *
      * 
    
-     * start specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed
-     * captioning. It uses the NTP time code format (see: the time attribute used in <media:thumbnail>). It is an optional attribute.
+     * start specifies the start time offset that the text starts being relevant to the
+     * media object. An example of this would be for closed captioning. It uses the NTP time code
+     * format (see: the time attribute used in <media:thumbnail>). It is an optional
+     * attribute.
      * 
    
      *
      * 
    
-     * end specifies the end time that the text is relevant. If this attribute is not provided, and a start time is used, it is expected that
-     * the end time is either the end of the clip or the start of the next <media:text> element.
+     * end specifies the end time that the text is relevant. If this attribute is not
+     * provided, and a start time is used, it is expected that the end time is either the
+     * end of the clip or the start of the next <media:text> element.
      *
      * @param text text objects for the item.
      */
@@ -662,21 +708,24 @@ public class Metadata implements Cloneable, Serializable {
     /**
      * <media:text>
    
      * 
    
-     * Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time
-     * series of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on
-     * the start time. Elements can have overlapping start and end times. It has 4 optional attributes.
+     * Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content.
+     * Many of these elements are permitted to provide a time series of text. In such cases, it is
+     * encouraged, but not required, that the elements be grouped by language and appear in time
+     * sequence order based on the start time. Elements can have overlapping start
+     * and end times. It has 4 optional attributes.
      * 
    
      *
      * 
          * <media:text type="plain" lang="en" start="00:00:03.000"
      *        end="00:00:10.000"> Oh, say, can you see</media:text>
-     *
+     * 
      *        <media:text type="plain" lang="en" start="00:00:10.000"
      *        end="00:00:17.000">By the dawn's early light</media:text>
      * 
    
      * 
    
-     * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
-     * entity-encoded. It is an optional attribute.
+     * type specifies the type of text embedded. Possible values are either 'plain' or
+     * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
+     * attribute.
      * 
    
      *
      *
@@ -685,18 +734,22 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar
-     * to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
+     * lang is the primary language encapsulated in the media object. Language codes
+     * possible are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute
+     * detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
      * 
    
      *
      * 
    
-     * start specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed
-     * captioning. It uses the NTP time code format (see: the time attribute used in <media:thumbnail>). It is an optional attribute.
+     * start specifies the start time offset that the text starts being relevant to the
+     * media object. An example of this would be for closed captioning. It uses the NTP time code
+     * format (see: the time attribute used in <media:thumbnail>). It is an optional
+     * attribute.
      * 
    
      *
      * 
    
-     * end specifies the end time that the text is relevant. If this attribute is not provided, and a start time is used, it is expected that
-     * the end time is either the end of the clip or the start of the next <media:text> element.
+     * end specifies the end time that the text is relevant. If this attribute is not
+     * provided, and a start time is used, it is expected that the end time is either the
+     * end of the clip or the start of the next <media:text> element.
      *
      * @return Text objects for the item.
      */
@@ -709,8 +762,9 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play,
-     * it is assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes.
+     * Allows particular images to be used as representative images for the media object. If
+     * multiple thumbnails are included, and time coding is not at play, it is assumed that the
+     * images are in order of importance. It has 1 required attribute and 3 optional attributes.
      * 
    
      *
      *
@@ -732,9 +786,11 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * time specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video.
-     * The format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326
-     * 3.6 Normal Play Time]. It is an optional attribute.
+     * time specifies the time offset in relation to the media object. Typically this is
+     * used when creating multiple keyframes within a single video. The format for this attribute
+     * should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326 3.6 Normal Play Time]. It is an
+     * optional attribute.
      * 
    
      *
      * @param thumbnail thumbnails for the image
@@ -748,8 +804,9 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play,
-     * it is assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes.
+     * Allows particular images to be used as representative images for the media object. If
+     * multiple thumbnails are included, and time coding is not at play, it is assumed that the
+     * images are in order of importance. It has 1 required attribute and 3 optional attributes.
      * 
    
      *
      *
@@ -771,9 +828,11 @@ public class Metadata implements Cloneable, Serializable {
      *
      *
      * 
    
-     * time specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video.
-     * The format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326
-     * 3.6 Normal Play Time]. It is an optional attribute.
+     * time specifies the time offset in relation to the media object. Typically this is
+     * used when creating multiple keyframes within a single video. The format for this attribute
+     * should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326 3.6 Normal Play Time]. It is an
+     * optional attribute.
      * 
    
      *
      * @return Thumbnails for the image
@@ -793,8 +852,9 @@ public class Metadata implements Cloneable, Serializable {
      * 
    
      *
      * 
    
-     * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
-     * entity-encoded. It is an optional attribute.
+     * type specifies the type of text embedded. Possible values are either 'plain' or
+     * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
+     * attribute.
      * 
    
      *
      * @param title Value of the title
@@ -814,8 +874,9 @@ public class Metadata implements Cloneable, Serializable {
      *
    * *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be - * entity-encoded. It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or + * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional + * attribute. *

    * * @return value of the title. @@ -835,8 +896,9 @@ public class Metadata implements Cloneable, Serializable { * * *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be - * entity-encoded. It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or + * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional + * attribute. *

    * * @param titleType type of the title. @@ -856,8 +918,9 @@ public class Metadata implements Cloneable, Serializable { * * *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be - * entity-encoded. It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or + * 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional + * attribute. *

    * * @return type of the title @@ -876,8 +939,9 @@ public class Metadata implements Cloneable, Serializable { * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright> * *

    - * url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the - * Creative Commons module should be used instead. It is an optional attribute. + * url is the url for a terms of use page or additional copyright information. If the + * media is operating under a Creative Commons license, the Creative Commons module should be + * used instead. It is an optional attribute. *

    * * @return Link to more copyright information. diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/PlayerReference.java b/src/main/java/org/rometools/feed/module/mediarss/types/PlayerReference.java index f209532..106b500 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/PlayerReference.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/PlayerReference.java @@ -32,8 +32,9 @@ import com.sun.syndication.feed.impl.ToStringBean; * * <media:player>

    *

    - * Allows the media object to be accessed through a web browser media player console. This element is required only if a direct media url attribute is - * not specified in the <media:content> element. It has 1 required attribute, and 2 optional attributes. + * Allows the media object to be accessed through a web browser media player console. This element + * is required only if a direct media url attribute is not specified in the + * <media:content> element. It has 1 required attribute, and 2 optional attributes. *

    * * 
    @@ -44,10 +45,12 @@ import com.sun.syndication.feed.impl.ToStringBean;
  * 
    
  *
  * 
    
- * height is the height of the browser window that the url should be opened in. It is an optional attribute.
+ * height is the height of the browser window that the url should be opened in. It
+ * is an optional attribute.
  * 
    
  * 
    
- * width is the width of the browser window that the url should be opened in. It is an optional attribute.
+ * width is the width of the browser window that the url should be opened in. It
+ * is an optional attribute.
  * 
    
  *
  * @author cooper
diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Rating.java b/src/main/java/org/rometools/feed/module/mediarss/types/Rating.java
index 9557a7a..ea7d78d 100644
--- a/src/main/java/org/rometools/feed/module/mediarss/types/Rating.java
+++ b/src/main/java/org/rometools/feed/module/mediarss/types/Rating.java
@@ -30,22 +30,22 @@ import com.sun.syndication.feed.impl.ToStringBean;
  *
  *
  * 
    
- * This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional
- * attribute.
+ * This allows the permissible audience to be declared. If this element is not included, it assumes
+ * that no restrictions are necessary. It has one optional attribute.
  * 
    
  *
  * 
      * <media:rating scheme="urn:simple">adult</media:rating>
  *               <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating>
  *               <media:rating scheme="urn:mpaa">pg</media:rating>
- *
+ * 
  *               <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
  * 
    
  *
  *
  * 
    
- * scheme is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is
- * urn:simple (adult | nonadult).
+ * scheme is the URI that identifies the rating scheme. It is an optional attribute. If
+ * this attribute is not included, the default scheme is urn:simple (adult | nonadult).
  * 
    
  *
  * For compatibility, a medai:adult tag will appear in the ratings as a urn:simple equiv.
diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Reference.java b/src/main/java/org/rometools/feed/module/mediarss/types/Reference.java
index 7302822..0ba820f 100644
--- a/src/main/java/org/rometools/feed/module/mediarss/types/Reference.java
+++ b/src/main/java/org/rometools/feed/module/mediarss/types/Reference.java
@@ -23,7 +23,8 @@
 package org.rometools.feed.module.mediarss.types;
 
 /**
- * This class is an idenfier for UrlReference and PlayerReference and is required for constructing a MediaContent object.
+ * This class is an idenfier for UrlReference and PlayerReference and is required for constructing a
+ * MediaContent object.
  *
  * @author cooper
  */
diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Restriction.java b/src/main/java/org/rometools/feed/module/mediarss/types/Restriction.java
index ec20405..882cca5 100644
--- a/src/main/java/org/rometools/feed/module/mediarss/types/Restriction.java
+++ b/src/main/java/org/rometools/feed/module/mediarss/types/Restriction.java
@@ -31,11 +31,14 @@ import com.sun.syndication.feed.impl.ToStringBean;
  * <media:restriction> 
    
  *
  * 
    
- * Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country codes.
- * This element is purely informational and no obligation can be assumed or implied. Only one <media:restriction> element of the same type can be
- * applied to a media object - all others will be ignored. Entities in this element should be space separated. To allow the producer to explicitly declare
- * his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1 required attribute, and 1 optional
- * attribute (with strict requirements for its exclusion).
+ * Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently,
+ * restrictions are based on distributor (uri) and country codes. This element is purely
+ * informational and no obligation can be assumed or implied. Only one <media:restriction>
+ * element of the same type can be applied to a media object - all others will be
+ * ignored. Entities in this element should be space separated. To allow the producer to
+ * explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals
+ * can only be used once. This element has 1 required attribute, and 1 optional attribute (with
+ * strict requirements for its exclusion).
  * 
    
  *
  * 
    @@ -43,13 +46,14 @@ import com.sun.syndication.feed.impl.ToStringBean;
  * 
    
  *
  * 
    
- * relationship indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should only
- * be syndicated in Australia and the United States. It is a required attribute.
+ * relationship indicates the type of relationship that the restriction represents (allow |
+ * deny). In the example above, the media object should only be syndicated in Australia and the
+ * United States. It is a required attribute.
  * 
    
  *
  * 
    
- * Note: If the "allow" element is empty and the type is relationship is "allow", it is assumed that the empty list means "allow nobody" and
- * the media should not be syndicated.
+ * Note: If the "allow" element is empty and the type is relationship is "allow",
+ * it is assumed that the empty list means "allow nobody" and the media should not be syndicated.
  * 
    
  * 
    
  * A more explicit method would be:
@@ -60,15 +64,18 @@ import com.sun.syndication.feed.impl.ToStringBean;
  *
    * *

    - * type specifies the type of restriction (country | uri) that the media can be syndicated. It is an optional attribute; however can only be excluded - * when using one of the literal values "all" or "none". + * type specifies the type of restriction (country | uri) that the media can be syndicated. + * It is an optional attribute; however can only be excluded when using one of the literal values + * "all" or "none". *

    * *

    - * "country" allows restrictions to be placed based on country code. [ISO 3166] + * "country" allows restrictions to be placed based on country code. [ISO 3166] *

    *

    - * "uri" allows restrictions based on URI. Examples: urn:apple, http://images.google.com, urn:yahoo, etc. + * "uri" allows restrictions based on URI. Examples: urn:apple, http://images.google.com, urn:yahoo, + * etc. * * @author cooper */ diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Text.java b/src/main/java/org/rometools/feed/module/mediarss/types/Text.java index f81451c..7dd92a9 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Text.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Text.java @@ -30,21 +30,23 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * <media:text>

    *

    - * Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time series - * of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on the - * start time. Elements can have overlapping start and end times. It has 4 optional attributes. + * Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. + * Many of these elements are permitted to provide a time series of text. In such cases, it is + * encouraged, but not required, that the elements be grouped by language and appear in time + * sequence order based on the start time. Elements can have overlapping start and + * end times. It has 4 optional attributes. *

    * * 
      * <media:text type="plain" lang="en" start="00:00:03.000"
  *        end="00:00:10.000"> Oh, say, can you see</media:text>
- *
+ * 
  *        <media:text type="plain" lang="en" start="00:00:10.000"
  *        end="00:00:17.000">By the dawn's early light</media:text>
  *
    *

    - * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. - * It is an optional attribute. + * type specifies the type of text embedded. Possible values are either 'plain' or 'html'. + * Default value is 'plain'. All html must be entity-encoded. It is an optional attribute. *

    * * @@ -53,18 +55,21 @@ import com.sun.syndication.feed.impl.ToStringBean; * * *

    - * lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to - * the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute. + * lang is the primary language encapsulated in the media object. Language codes possible + * are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in + * the XML 1.0 Specification (Third Edition). It is an optional attribute. *

    * *

    - * start specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed captioning. It - * uses the NTP time code format (see: the time attribute used in <media:thumbnail>). It is an optional attribute. + * start specifies the start time offset that the text starts being relevant to the media + * object. An example of this would be for closed captioning. It uses the NTP time code format (see: + * the time attribute used in <media:thumbnail>). It is an optional attribute. *

    * *

    - * end specifies the end time that the text is relevant. If this attribute is not provided, and a start time is used, it is expected that the - * end time is either the end of the clip or the start of the next <media:text> element. + * end specifies the end time that the text is relevant. If this attribute is not provided, + * and a start time is used, it is expected that the end time is either the end of the clip + * or the start of the next <media:text> element. *

    * * @author cooper diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Thumbnail.java b/src/main/java/org/rometools/feed/module/mediarss/types/Thumbnail.java index 00ce01c..2331039 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Thumbnail.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Thumbnail.java @@ -32,8 +32,9 @@ import com.sun.syndication.feed.impl.ToStringBean; * * *

    - * Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play, it is - * assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes. + * Allows particular images to be used as representative images for the media object. If multiple + * thumbnails are included, and time coding is not at play, it is assumed that the images are in + * order of importance. It has 1 required attribute and 3 optional attributes. *

    * * @@ -55,9 +56,11 @@ import com.sun.syndication.feed.impl.ToStringBean; * * *

    - * time specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video. The - * format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326 3.6 Normal - * Play Time]. It is an optional attribute. + * time specifies the time offset in relation to the media object. Typically this is used + * when creating multiple keyframes within a single video. The format for this attribute should be + * in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326 3.6 Normal Play Time]. It is an optional + * attribute. *

    */ public class Thumbnail implements Cloneable, Serializable { diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/Time.java b/src/main/java/org/rometools/feed/module/mediarss/types/Time.java index 8f555e0..5e2d6bd 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/Time.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/Time.java @@ -28,7 +28,8 @@ import java.text.NumberFormat; import com.sun.syndication.feed.impl.EqualsBean; /** - * Represents a RFC 2326 3.6 Normal Play Time timestamp. + * Represents a RFC 2326 3.6 Normal Play Time + * timestamp. * * @author cooper */ @@ -58,7 +59,8 @@ public class Time implements Serializable { /** * Creates a new instance of Time * - * @param value RFC 2326 3.6 Normal Play Time value + * @param value RFC 2326 3.6 Normal Play Time + * value */ public Time(final String value) { final String[] values = value.split(":"); diff --git a/src/main/java/org/rometools/feed/module/opensearch/OpenSearchResponse.java b/src/main/java/org/rometools/feed/module/opensearch/OpenSearchResponse.java index 93be7e4..1786dc0 100644 --- a/src/main/java/org/rometools/feed/module/opensearch/OpenSearchResponse.java +++ b/src/main/java/org/rometools/feed/module/opensearch/OpenSearchResponse.java @@ -31,8 +31,8 @@ public interface OpenSearchResponse { /** * # totalResults – the maximum number of results available for these search terms * - * * Restrictions: An integer greater than or equal to 0. * Default: The number of items that were returned in this set of results. * Requirements: May - * appear zero or one time. + * * Restrictions: An integer greater than or equal to 0. * Default: The number of items that + * were returned in this set of results. * Requirements: May appear zero or one time. * * @param totalResults A positive integer value. */ @@ -41,8 +41,8 @@ public interface OpenSearchResponse { /** * # totalResults – the maximum number of results available for these search terms * - * * Restrictions: An integer greater than or equal to 0. * Default: The number of items that were returned in this set of results. * Requirements: May - * appear zero or one time. + * * Restrictions: An integer greater than or equal to 0. * Default: The number of items that + * were returned in this set of results. * Requirements: May appear zero or one time. * * @return a positive integer value. */ @@ -51,7 +51,8 @@ public interface OpenSearchResponse { /** * # startIndex – the index of the first item returned in the result. * - * * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * Default: 1 * Requirements: May appear zero or one time. + * * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * + * Default: 1 * Requirements: May appear zero or one time. * * @param startIndex int value >= 1. */ @@ -60,7 +61,8 @@ public interface OpenSearchResponse { /** * # startIndex – the index of the first item returned in the result. * - * * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * Default: 1 * Requirements: May appear zero or one time. + * * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * + * Default: 1 * Requirements: May appear zero or one time. * * @return int value >= 1. */ @@ -69,8 +71,8 @@ public interface OpenSearchResponse { /** * # itemsPerPage – the maximum number of items that can appear in one page of results. * - * * Restrictions: An integer greater than or equal to 1. * Default: The number of items that were returned in this set of results. * Requirements: May - * appear zero or one time. + * * Restrictions: An integer greater than or equal to 1. * Default: The number of items that + * were returned in this set of results. * Requirements: May appear zero or one time. * * @param itemsPerPage int value >= 1. */ @@ -79,8 +81,8 @@ public interface OpenSearchResponse { /** * # itemsPerPage – the maximum number of items that can appear in one page of results. * - * * Restrictions: An integer greater than or equal to 1. * Default: The number of items that were returned in this set of results. * Requirements: May - * appear zero or one time. + * * Restrictions: An integer greater than or equal to 1. * Default: The number of items that + * were returned in this set of results. * Requirements: May appear zero or one time. * * @return int value >= 1 */ @@ -89,8 +91,9 @@ public interface OpenSearchResponse { /** * # link – a reference back to the OpenSearch Description file * - * * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and type attributes. * Restrictions: The rel attribute must - * equal search. * Note: New in version 1.1. * Requirements: May appear zero or one time. + * * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and + * type attributes. * Restrictions: The rel attribute must equal search. * Note: New in version + * 1.1. * Requirements: May appear zero or one time. * * @param link link to the open search spec. */ @@ -99,8 +102,9 @@ public interface OpenSearchResponse { /** * # link – a reference back to the OpenSearch Description file * - * * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and type attributes. * Restrictions: The rel attribute must - * equal search. * Note: New in version 1.1. * Requirements: May appear zero or one time. + * * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and + * type attributes. * Restrictions: The rel attribute must equal search. * Note: New in version + * 1.1. * Requirements: May appear zero or one time. * * @return link to the opensearch spec. */ @@ -108,8 +112,9 @@ public interface OpenSearchResponse { // list of OSResponseQuery interfaces /** - * Query – in an OpenSearch Response, can be used both to echo back the original query and to suggest new searches. Please see the OpenSearch Query specification for more information. + * Query – in an OpenSearch Response, can be used both to echo back the original + * query and to suggest new searches. Please see the OpenSearch Query + * specification for more information. *
      *
    • Note: New in version 1.1.
      • *
    • Requirements: May appear zero or more times. Note that the “Q” is capitalized.
      • @@ -119,8 +124,9 @@ public interface OpenSearchResponse { public void setQueries(List query); /** - * Query – in an OpenSearch Response, can be used both to echo back the original query and to suggest new searches. Please see the OpenSearch Query specification for more information. + * Query – in an OpenSearch Response, can be used both to echo back the original + * query and to suggest new searches. Please see the OpenSearch Query + * specification for more information. *
        *
      • Note: New in version 1.1.
        • *
      • Requirements: May appear zero or more times. Note that the “Q” is capitalized.
        • diff --git a/src/main/java/org/rometools/feed/module/opensearch/entity/OSQuery.java b/src/main/java/org/rometools/feed/module/opensearch/entity/OSQuery.java index 8022245..c8ff15c 100644 --- a/src/main/java/org/rometools/feed/module/opensearch/entity/OSQuery.java +++ b/src/main/java/org/rometools/feed/module/opensearch/entity/OSQuery.java @@ -20,7 +20,8 @@ import java.io.Serializable; import com.sun.syndication.feed.impl.ObjectBean; /** - * @author Michael W. Nassif (enrouteinc@gmail.com) Class representation of the Query object (Response portion so far) + * @author Michael W. Nassif (enrouteinc@gmail.com) Class representation of the Query object + * (Response portion so far) */ public class OSQuery implements Cloneable, Serializable { private static final long serialVersionUID = 1L; @@ -57,7 +58,8 @@ public class OSQuery implements Cloneable, Serializable { } /** - * Indicates whether some other object is "equal to" this one as defined by the Object equals() method. + * Indicates whether some other object is "equal to" this one as defined by the Object equals() + * method. *

        * * @param other he reference object with which to compare. diff --git a/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleGenerator.java b/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleGenerator.java index cabc7e5..082ab4c 100644 --- a/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleGenerator.java +++ b/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleGenerator.java @@ -54,8 +54,8 @@ public class OpenSearchModuleGenerator implements ModuleGenerator { /** * Returns a set with all the URIs (JDOM Namespace elements) this module generator uses. *

        - * It is used by the the feed generators to add their namespace definition in the root element of the generated document (forward-missing of Java 5.0 - * Generics). + * It is used by the the feed generators to add their namespace definition in the root element + * of the generated document (forward-missing of Java 5.0 Generics). *

        * * @return a set with all the URIs (JDOM Namespace elements) this module generator uses. diff --git a/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleParser.java b/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleParser.java index 1786a02..775e18c 100644 --- a/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleParser.java +++ b/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleParser.java @@ -34,7 +34,8 @@ import com.sun.syndication.feed.module.Module; import com.sun.syndication.io.ModuleParser; /** - * @author Michael W. Nassif (enrouteinc@gmail.com) OpenSearch implementation of the ModuleParser class + * @author Michael W. Nassif (enrouteinc@gmail.com) OpenSearch implementation of the ModuleParser + * class */ public class OpenSearchModuleParser implements ModuleParser { diff --git a/src/main/java/org/rometools/feed/module/photocast/PhotocastModule.java b/src/main/java/org/rometools/feed/module/photocast/PhotocastModule.java index a62dbae..df3e9ef 100644 --- a/src/main/java/org/rometools/feed/module/photocast/PhotocastModule.java +++ b/src/main/java/org/rometools/feed/module/photocast/PhotocastModule.java @@ -47,7 +47,8 @@ import org.rometools.feed.module.photocast.types.Metadata; import com.sun.syndication.feed.module.Module; /** - * This is a ROME module that provides support for the "http://www.apple.com/ilife/wallpapers" namespace. + * This is a ROME module that provides support for the "http://www.apple.com/ilife/wallpapers" + * namespace. * * See the package information for example usage. * diff --git a/src/main/java/org/rometools/feed/module/photocast/types/Metadata.java b/src/main/java/org/rometools/feed/module/photocast/types/Metadata.java index de93459..373aac5 100644 --- a/src/main/java/org/rometools/feed/module/photocast/types/Metadata.java +++ b/src/main/java/org/rometools/feed/module/photocast/types/Metadata.java @@ -45,7 +45,8 @@ import com.sun.syndication.feed.impl.EqualsBean; import com.sun.syndication.feed.impl.ToStringBean; /** - * This is an immutable class representing the apple-wallpapers:metadata tag in the photocast module. + * This is an immutable class representing the apple-wallpapers:metadata tag in the photocast + * module. * * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/photocast/types/PhotoDate.java b/src/main/java/org/rometools/feed/module/photocast/types/PhotoDate.java index ebebb70..dcfdf78 100644 --- a/src/main/java/org/rometools/feed/module/photocast/types/PhotoDate.java +++ b/src/main/java/org/rometools/feed/module/photocast/types/PhotoDate.java @@ -45,8 +45,9 @@ import java.math.BigDecimal; import java.util.Date; /** - * This is a specialized Date class for working with the apple PhotoDate format. It provides a constructor taking a dobule value representing the fractional - * number of days since 00:00:00 01/01/00. + * This is a specialized Date class for working with the apple PhotoDate format. It provides a + * constructor taking a dobule value representing the fractional number of days since 00:00:00 + * 01/01/00. * * @author Robert "kebernet" Cooper */ @@ -74,7 +75,8 @@ public class PhotoDate extends Date { } /** - * Creates a new instance of PhotoDate with the fractional number of days since 00:00:00 01/01/00. + * Creates a new instance of PhotoDate with the fractional number of days since 00:00:00 + * 01/01/00. * * @param photoDateValue fractional number of days since 00:00:00 01/01/00 */ diff --git a/src/main/java/org/rometools/feed/module/sle/SimpleListExtension.java b/src/main/java/org/rometools/feed/module/sle/SimpleListExtension.java index 259ec1b..21d3fee 100644 --- a/src/main/java/org/rometools/feed/module/sle/SimpleListExtension.java +++ b/src/main/java/org/rometools/feed/module/sle/SimpleListExtension.java @@ -23,7 +23,8 @@ import org.rometools.feed.module.sle.types.Sort; import com.sun.syndication.feed.module.Module; /** - * This is the primary module interface for the MS Simple List Extensions. + * This is the primary module interface for the MS + * Simple List Extensions. * * @author Robert "kebernet" Cooper */ @@ -34,49 +35,54 @@ public interface SimpleListExtension extends Module { public static final String URI = "http://www.microsoft.com/schemas/rss/core/2005"; /** - * The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should - * provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of - * discrete values (e.g. book genres are perfect for groups). + * The cf:group element is intended to inform the client that the property to which it refers is + * one that is “groupable” – that is, that the client should provide a user interface that + * allows the user to group or filter on the values of that property. Groupable properties + * should contain a small set of discrete values (e.g. book genres are perfect for groups). * * @param groupFields Array of types.Group objects. */ public void setGroupFields(Group[] groupFields); /** - * The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should - * provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of - * discrete values (e.g. book genres are perfect for groups). + * The cf:group element is intended to inform the client that the property to which it refers is + * one that is “groupable” – that is, that the client should provide a user interface that + * allows the user to group or filter on the values of that property. Groupable properties + * should contain a small set of discrete values (e.g. book genres are perfect for groups). * * @return Array of types.Group objects. */ public Group[] getGroupFields(); /** - * The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should - * provide a user interface that allows the user to sort on that property. + * The cf:sort element is intended to inform the client that the property to which it refers is + * one that is “sortable” – that is, that the client should provide a user interface that allows + * the user to sort on that property. * * @param sortFields Array of types.Sort objects */ public void setSortFields(Sort[] sortFields); /** - * The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should - * provide a user interface that allows the user to sort on that property. + * The cf:sort element is intended to inform the client that the property to which it refers is + * one that is “sortable” – that is, that the client should provide a user interface that allows + * the user to sort on that property. * * @return Array of types.Sort objects */ public Sort[] getSortFields(); /** - * This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list. - * (defaults to "list" ) + * This XML element allows the publisher of a feed document to indicate to the consumers of the + * feed that the feed is intended to be consumed as a list. (defaults to "list" ) * * @param value treatAs value */ public void setTreatAs(String value); /** - * This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list. + * This XML element allows the publisher of a feed document to indicate to the consumers of the + * feed that the feed is intended to be consumed as a list. * * @return treatAs value. */ diff --git a/src/main/java/org/rometools/feed/module/sle/SleEntry.java b/src/main/java/org/rometools/feed/module/sle/SleEntry.java index beed519..b17e274 100644 --- a/src/main/java/org/rometools/feed/module/sle/SleEntry.java +++ b/src/main/java/org/rometools/feed/module/sle/SleEntry.java @@ -25,8 +25,9 @@ import org.rometools.feed.module.sle.types.Sort; import com.sun.syndication.feed.module.Module; /** - * This is a parse only module that holds the values of enternal fields declared in the SLE module. These will not be persisted on an output() - * call, nor will changing a value here change a value in another module or a foreign markup tag. + * This is a parse only module that holds the values of enternal fields declared in the SLE + * module. These will not be persisted on an output() call, nor will changing a value + * here change a value in another module or a foreign markup tag. * * @author Robert "kebernet" Cooper */ @@ -63,8 +64,9 @@ public interface SleEntry extends Module { * Returns an array of EntryValues for the fields declared in the heading. * * NB:
        - * Right now the parser will take any default=true field and change it to an integer value representing the default order in the field. You should not rely - * on these values data display to a user! + * Right now the parser will take any default=true field and change it to an integer value + * representing the default order in the field. You should not rely on these values data display + * to a user! * * @return Array of EntryValue implementations from this entry. */ diff --git a/src/main/java/org/rometools/feed/module/sle/types/Group.java b/src/main/java/org/rometools/feed/module/sle/types/Group.java index 42793ba..35ce45f 100644 --- a/src/main/java/org/rometools/feed/module/sle/types/Group.java +++ b/src/main/java/org/rometools/feed/module/sle/types/Group.java @@ -24,11 +24,13 @@ import org.jdom2.Namespace; import com.sun.syndication.feed.impl.ObjectBean; /** - * The cf:group element is intended to inform the client that the property to which it + * The cf:group element is intended to inform the client that the property to + * which it * * refers is one that is “groupable” – that is, that the client should provide a user interface that * - * allows the user to group or filter on the values of that property. Groupable properties should contain + * allows the user to group or filter on the values of that property. Groupable properties + * should contain * * a small set of discrete values (e.g. book genres are perfect for groups).

        * @@ -37,16 +39,20 @@ import com.sun.syndication.feed.impl.ObjectBean; *

        * *
          - *
        • ns - this attribute is the full namespace used in the property element. If the attribute value is an empty string, it is assumed that - * the property does not live in a namespace. If the ns attribute is omitted, the default value is the empty string. In the example above, the ns attribute - * would contain "http://www.example.com/book". It would not contain the namespace prefix.
          • - *
        • element - this attribute is the name of the property (without any namespace). In the example above, the element attribute would contain - * "firstedition" If this attribute is omitted, it is assumed that the label attribute is included and that this cf:group element refers to the - * default sort order.
          • + *
        • ns - this attribute is the full namespace used in the property element. If the + * attribute value is an empty string, it is assumed that the property does not live in a + * namespace. If the ns attribute is omitted, the default value is the empty string. In the example + * above, the ns attribute would contain "http://www.example.com/book". It would not contain + * the namespace prefix.
          • + *
        • element - this attribute is the name of the property (without any namespace). In the + * example above, the element attribute would contain "firstedition" If this attribute is omitted, + * it is assumed that the label attribute is included and that this cf:group element + * refers to the default sort order.
          • * - *
        • label - this attribute contains a human-readable name for the property to which this cf:group element refers. If it is omitted, the - * client should use the value of the "element" attribute as the human-readable name. The "label" attribute is required if the "element" attribute is - * omitted.  
          • + *
        • label - this attribute contains a human-readable name for the property to which this + * cf:group element refers. If it is omitted, the client should use the value of the + * "element" attribute as the human-readable name. The "label" attribute is required if the + * "element" attribute is omitted.  
          • *
        * * @author Robert "kebernet" Cooper diff --git a/src/main/java/org/rometools/feed/module/sle/types/Sort.java b/src/main/java/org/rometools/feed/module/sle/types/Sort.java index e46ce96..5a809d7 100644 --- a/src/main/java/org/rometools/feed/module/sle/types/Sort.java +++ b/src/main/java/org/rometools/feed/module/sle/types/Sort.java @@ -25,15 +25,18 @@ import com.sun.syndication.feed.impl.ObjectBean; /** *

        - * The cf:sort element is intended to inform the client that the property to which it refers + * The cf:sort element is intended to inform the client that the property to which it + * refers * - * is one that is “sortable” – that is, that the client should provide a user interface that allows the + * is one that is “sortable” – that is, that the client should provide a user interface that allows + * the * * user to sort on that property. *

        * *

        - * The cf:sort element can also be used to provide a label for the default sort that appears + * The cf:sort element can also be used to provide a label for the default sort that + * appears * * in the list (in this case, only the label attribute should be included). *

        @@ -43,20 +46,28 @@ import com.sun.syndication.feed.impl.ObjectBean; *

        * *
          - *
        • ns - this attribute is the full namespace used in the property element. If the attribute value is an empty string, it is assumed that - * the property does not live in a namespace. If the ns attribute is omitted, the default value is the empty string. In the example above, the ns attribute - * would contain "http://www.example.com/book". It would not contain the namespace prefix.
          • - *
        • element - this attribute is the name of the property (without any namespace). In the example above, the element attribute would contain - * "firstedition" If this attribute is omitted, it is assumed that the label attribute is included and that this cf:sort element refers to the - * default sort order.
          • + *
        • ns - this attribute is the full namespace used in the property element. If the + * attribute value is an empty string, it is assumed that the property does not live in a + * namespace. If the ns attribute is omitted, the default value is the empty string. In the example + * above, the ns attribute would contain "http://www.example.com/book". It would not contain + * the namespace prefix.
          • + *
        • element - this attribute is the name of the property (without any namespace). In the + * example above, the element attribute would contain "firstedition" If this attribute is omitted, + * it is assumed that the label attribute is included and that this cf:sort element + * refers to the default sort order.
          • * - *
        • label - this attribute contains a human-readable name for the property to which this cf:sort element refers. If it is omitted, the - * client should use the value of the "element" attribute as the human-readable name. The "label" attribute is required if the "element" attribute is omitted.
          • - *
        • data-type - this attribute informs the client about the data-type of the property to which this cf:sort element refers.. It contains - * one of the following values: date, number, text. If it is omitted, the default value is text.
          • - *
        • default - this attribute indicates whether the property to which this cf:sort element refers is the default sort order in the list. - * The allowed values are "true" and "false". If omitted, the default value is "false". The items in the list must be already be sorted by the element – - * this is, the client should not expect to have to resort by this field if it displaying content directly from the list. The client should respect only the + *
        • label - this attribute contains a human-readable name for the property to which this + * cf:sort element refers. If it is omitted, the client should use the value of the + * "element" attribute as the human-readable name. The "label" attribute is required if the + * "element" attribute is omitted.
          • + *
        • data-type - this attribute informs the client about the data-type of the property to + * which this cf:sort element refers.. It contains one of the following values: date, + * number, text. If it is omitted, the default value is text.
          • + *
        • default - this attribute indicates whether the property to which this + * cf:sort element refers is the default sort order in the list. The allowed values are + * "true" and "false". If omitted, the default value is "false". The items in the list must + * be already be sorted by the element – this is, the client should not expect to have to resort by + * this field if it displaying content directly from the list. The client should respect only the * first instance of default="true" that it encounters.
          • * *
        diff --git a/src/main/java/org/rometools/feed/module/sse/SSE091Generator.java b/src/main/java/org/rometools/feed/module/sse/SSE091Generator.java index ac81ba4..5307b40 100644 --- a/src/main/java/org/rometools/feed/module/sse/SSE091Generator.java +++ b/src/main/java/org/rometools/feed/module/sse/SSE091Generator.java @@ -48,8 +48,8 @@ public class SSE091Generator implements DelegatingModuleGenerator { /** * Returns a set with all the URIs (JDOM Namespace elements) this module generator uses. *

        - * It is used by the the feed generators to add their namespace definition in the root element of the generated document (forward-missing of Java 5.0 - * Generics). + * It is used by the the feed generators to add their namespace definition in the root element + * of the generated document (forward-missing of Java 5.0 Generics). *

        * * @return a set with all the URIs (JDOM Namespace elements) this module generator uses. diff --git a/src/main/java/org/rometools/feed/module/sse/modules/SSEModule.java b/src/main/java/org/rometools/feed/module/sse/modules/SSEModule.java index f8ff8b0..3b1b787 100644 --- a/src/main/java/org/rometools/feed/module/sse/modules/SSEModule.java +++ b/src/main/java/org/rometools/feed/module/sse/modules/SSEModule.java @@ -10,7 +10,8 @@ import com.sun.syndication.feed.CopyFrom; import com.sun.syndication.feed.module.Module; /** - * The base module for SSE data synchronization. Defines a namespace, uri, and basic copying operations. + * The base module for SSE data synchronization. Defines a namespace, uri, and basic copying + * operations. */ public abstract class SSEModule implements Module { private static final long serialVersionUID = 1L; diff --git a/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParser.java b/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParser.java index 890e358..60013ae 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParser.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParser.java @@ -140,7 +140,7 @@ public class WeatherModuleParser implements ModuleParser { final SimpleDateFormat dateFormat = new SimpleDateFormat("EEE, d MMM yyyy h:mm a zzz", locale); final Condition c = new Condition(condition.getAttributeValue("text"), ConditionCode.fromCode(Integer.parseInt(condition .getAttributeValue("code"))), Integer.parseInt(condition.getAttributeValue("temp")), dateFormat.parse(condition - .getAttributeValue("date").replaceAll("pm", "PM").replaceAll("am", "AM"))); + .getAttributeValue("date").replaceAll("pm", "PM").replaceAll("am", "AM"))); module.setCondition(c); } catch (final NumberFormatException nfe) { LOG.warn("NumberFormatException processing tag.", nfe); diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/Astronomy.java b/src/main/java/org/rometools/feed/module/yahooweather/types/Astronomy.java index 906881b..fd565ea 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/Astronomy.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/Astronomy.java @@ -46,8 +46,10 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * Forecast information about current astronomical conditions. Attributes: *

          - *
        • sunrise: today's sunrise time. The time is a string in a local time format of "h:mm am/pm", for example "7:02 am" (string)
          • - *
        • sunset today's sunset time. The time is a string in a local time format of "h:mm am/pm", for example "4:51 pm" (string)
          • + *
        • sunrise: today's sunrise time. The time is a string in a local time format of "h:mm am/pm", + * for example "7:02 am" (string)
          • + *
        • sunset today's sunset time. The time is a string in a local time format of "h:mm am/pm", for + * example "4:51 pm" (string)
          • *
        * * @version $Id: Astronomy.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/Atmosphere.java b/src/main/java/org/rometools/feed/module/yahooweather/types/Atmosphere.java index b10a7d3..818ca02 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/Atmosphere.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/Atmosphere.java @@ -46,11 +46,14 @@ import com.sun.syndication.feed.impl.ToStringBean; * Forecast information about current atmospheric pressure, humidity, and visibility. Attributes: *
          *
        • humidity: humidity, in percent (integer)
          • - *
        • visibility, in the units specified by the distance attribute of the yweather:units element (mi or km). Note that the visibility is specified as the - * actual value * 100. For example, a visibility of 16.5 miles will be specified as 1650. A visibility of 14 kilometers will appear as 1400. (integer) [ - * A double here, and adjusted accordingly]
          • - *
        • pressure: barometric pressure, in the units specified by the pressure attribute of the yweather:units element (in or mb). (float).
          • - *
        • rising: state of the barometric pressure: steady (0), rising (1), or falling (2). (integer: 0, 1, 2)
          • + *
        • visibility, in the units specified by the distance attribute of the yweather:units element + * (mi or km). Note that the visibility is specified as the actual value * 100. For example, a + * visibility of 16.5 miles will be specified as 1650. A visibility of 14 kilometers will appear as + * 1400. (integer) [ A double here, and adjusted accordingly]
          • + *
        • pressure: barometric pressure, in the units specified by the pressure attribute of the + * yweather:units element (in or mb). (float).
          • + *
        • rising: state of the barometric pressure: steady (0), rising (1), or falling (2). (integer: + * 0, 1, 2)
          • *
        * * @version $Id: Atmosphere.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/Condition.java b/src/main/java/org/rometools/feed/module/yahooweather/types/Condition.java index 6512fc6..9d82148 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/Condition.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/Condition.java @@ -47,11 +47,15 @@ import com.sun.syndication.feed.impl.ToStringBean; * The current weather conditions. Attributes: *
          *
        • text: a textual description of conditions, for example, "Partly Cloudy" (string)
          • - *
        • code: the condition code for this forecast. You could use this code to choose a text description or image for the forecast. The possible values for this - * element are described in Condition Codes (integer)
          • - *
        • temp: the current temperature, in the units specified by the yweather:units element (integer)
          • - *
        • date: the current date and time for which this forecast applies. [I believe this should be the time this condition information was captured] The - * date is in RFC822 Section 5 format, for example "Wed, 30 Nov 2005 1:56 pm PST" (string)
          • + *
        • code: the condition code for this forecast. You could use this code to choose a text + * description or image for the forecast. The possible values for this element are described in Condition Codes (integer)
          • + *
        • temp: the current temperature, in the units specified by the yweather:units element (integer) + *
          • + *
        • date: the current date and time for which this forecast applies. [ + * I believe this should be the time this condition information was captured] The date is + * in RFC822 Section 5 format, for example + * "Wed, 30 Nov 2005 1:56 pm PST" (string)
          • *
        * * @version $Id: Condition.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/Forecast.java b/src/main/java/org/rometools/feed/module/yahooweather/types/Forecast.java index 30b085d..beb72df 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/Forecast.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/Forecast.java @@ -44,16 +44,22 @@ import com.sun.syndication.feed.impl.EqualsBean; import com.sun.syndication.feed.impl.ToStringBean; /** - * The weather forecast for a specific day. The item element contains multiple forecast elements for today and tomorrow. Attributes: + * The weather forecast for a specific day. The item element contains multiple forecast elements for + * today and tomorrow. Attributes: *
          - *
        • day: day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)
          • - *
        • date: the date to which this forecast applies. The date is in "dd Mmm yyyy" format, for example "30 Nov 2005" (string)
          • - *
        • low: the forecasted low temperature for this day, in the units specified by the yweather:units element (integer)
          • - *
        • high: the forecasted high temperature for this day, in the units specified by the yweather:units element (integer)
          • + *
        • day: day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri + * Sat Sun (string)
          • + *
        • date: the date to which this forecast applies. The date is in "dd Mmm yyyy" format, for + * example "30 Nov 2005" (string)
          • + *
        • low: the forecasted low temperature for this day, in the units specified by the + * yweather:units element (integer)
          • + *
        • high: the forecasted high temperature for this day, in the units specified by the + * yweather:units element (integer)
          • *
        • text: a textual description of conditions, for example, "Partly Cloudy" (string)
          • * - *
        • code: the condition code for this forecast. You could use this code to choose a text description or image for the forecast. The possible values for this - * element are described in Condition Codes (integer)
          • + *
        • code: the condition code for this forecast. You could use this code to choose a text + * description or image for the forecast. The possible values for this element are described in + * Condition Codes (integer)
          • *
        * * @see ConditionCode @@ -84,7 +90,8 @@ public class Forecast implements Serializable, Cloneable { /** * Constructs a new Forecast object. * - * @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string) + * @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed + * Thu Fri Sat Sun (string) * @param date the date to which this forecast applies * @param low the forecasted low temperature for this day * @param high the forecasted high temperature for this day @@ -104,7 +111,8 @@ public class Forecast implements Serializable, Cloneable { /** * Day of week * - * @return day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string) + * @return day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu + * Fri Sat Sun (string) */ public String getDay() { return day; @@ -113,7 +121,8 @@ public class Forecast implements Serializable, Cloneable { /** * Day of week * - * @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string) + * @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed + * Thu Fri Sat Sun (string) */ public void setDay(final String day) { this.day = day; diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/Units.java b/src/main/java/org/rometools/feed/module/yahooweather/types/Units.java index 4b9bf1c..3d9d566 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/Units.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/Units.java @@ -47,13 +47,15 @@ import com.sun.syndication.feed.impl.ToStringBean; *
          *
        • temperature: degree units, f for Fahrenheit or c for Celsius (character)
          • *
        • distance: units for distance, mi for miles or km for kilometers (string)
          • - *
        • pressure: units of barometric pressure, in for pounds per square inch or mb for millibars (string) [I am pretty sure this is wrong. + *
        • pressure: units of barometric pressure, in for pounds per square inch or mb for millibars + * (string) [I am pretty sure this is wrong. * I believe this number of be inches of Mercury, not PSI.]
          • *
        • speed: units of speed, mph for miles per hour or kph for kilometers per hour (string)
          • *
        - * Note that the default RSS feed uses Fahrenheit degree units and English units for all other attributes (miles, pounds per square inch, miles per hour). If - * Celsius has been specified as the degree units for the feed (using the u request parameter), all the units are in metric format (Celsius, kilometers, - * millibars, kilometers per hour). + * Note that the default RSS feed uses Fahrenheit degree units and English units for all other + * attributes (miles, pounds per square inch, miles per hour). If Celsius has been specified as the + * degree units for the feed (using the u request parameter), all the units are in metric format + * (Celsius, kilometers, millibars, kilometers per hour). * * @version $Id: Units.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ * @author Robert "kebernet" Cooper diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/Wind.java b/src/main/java/org/rometools/feed/module/yahooweather/types/Wind.java index e4b7cd2..a5127ea 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/Wind.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/Wind.java @@ -47,12 +47,14 @@ import com.sun.syndication.feed.impl.ToStringBean; *
          *
        • temperature: degree units, f for Fahrenheit or c for Celsius (character)
          • *
        • distance: units for distance, mi for miles or km for kilometers (string)
          • - *
        • pressure: units of barometric pressure, in for pounds per square inch or mb for millibars (string)
          • + *
        • pressure: units of barometric pressure, in for pounds per square inch or mb for millibars + * (string)
          • *
        • speed: units of speed, mph for miles per hour or kph for kilometers per hour (string)
          • *
        - * Note that the default RSS feed uses Fahrenheit degree units and English units for all other attributes (miles, pounds per square inch, miles per hour). If - * Celsius has been specified as the degree units for the feed (using the u request parameter), all the units are in metric format (Celsius, kilometers, - * millibars, kilometers per hour). + * Note that the default RSS feed uses Fahrenheit degree units and English units for all other + * attributes (miles, pounds per square inch, miles per hour). If Celsius has been specified as the + * degree units for the feed (using the u request parameter), all the units are in metric format + * (Celsius, kilometers, millibars, kilometers per hour). * * @version $Id: Wind.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ * @author Robert "kebernet" Cooper diff --git a/src/test/java/org/rometools/feed/module/mediarss/MediaModuleTest.java b/src/test/java/org/rometools/feed/module/mediarss/MediaModuleTest.java index 3927c6e..a09dc47 100644 --- a/src/test/java/org/rometools/feed/module/mediarss/MediaModuleTest.java +++ b/src/test/java/org/rometools/feed/module/mediarss/MediaModuleTest.java @@ -102,7 +102,7 @@ public class MediaModuleTest extends AbstractTestCase { final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-07.xml"); final SyndEntry entry = feed.getEntries().get(0); - final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaEntryModule.URI); + final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaModule.URI); final Thumbnail[] thumbnails = module.getMetadata().getThumbnail(); assertThat(thumbnails, is(notNullValue())); @@ -120,7 +120,7 @@ public class MediaModuleTest extends AbstractTestCase { final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-08.xml"); final SyndEntry entry = feed.getEntries().get(0); - final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaEntryModule.URI); + final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaModule.URI); final Thumbnail[] thumbnails = module.getMetadata().getThumbnail(); assertThat(thumbnails, is(notNullValue())); @@ -138,7 +138,7 @@ public class MediaModuleTest extends AbstractTestCase { final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-12.xml"); final SyndEntry entry = feed.getEntries().get(0); - final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaEntryModule.URI); + final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaModule.URI); final Rating[] ratings = module.getMetadata().getRatings(); assertThat(ratings, is(notNullValue())); @@ -154,7 +154,7 @@ public class MediaModuleTest extends AbstractTestCase { public void testParseMediaContentContainingURLWithSpaces() throws Exception { final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-20.xml"); final SyndEntry entry = feed.getEntries().get(0); - final MediaEntryModule m = (MediaEntryModule) entry.getModule(MediaEntryModule.URI); + final MediaEntryModule m = (MediaEntryModule) entry.getModule(MediaModule.URI); assertNotNull("missing media entry module", m); final MediaContent[] mcs = m.getMediaContents(); assertNotNull("missing media:content", mcs); diff --git a/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherGeneratorTest.java b/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherGeneratorTest.java index 036c3a0..a30a248 100644 --- a/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherGeneratorTest.java @@ -24,7 +24,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author Robert "kebernet" Cooper */ public class WeatherGeneratorTest extends AbstractTestCase { @@ -47,7 +47,7 @@ public class WeatherGeneratorTest extends AbstractTestCase { /** * Test of generate method, of class com.totsp.xml.syndication.base.io.SlashGenerator. - * + * * @throws Exception on error */ public void testGenerate() throws Exception {
    delivery_radiusdelivery_radius
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
    location location
    Details Location of a property. Should include street, city, state, postal code, and country, in that order. Location of a property. Should include street, city, state, postal code, + * and country, in that order.
    Example Acceptable:
    - * <g:location>123 Main St, Anytown, CA, 12345, + * <g:location>123 Main St, Anytown, + * CA, 12345, * USA</g:location>
    * * Not acceptable:
    - * <g:location>123 Main St,, CA, 12345, + * <g:location>123 Main St,, CA, + * 12345, * USA</g:location>
    - * <g:location> Anytown, CA, 12345, + * <g:location> Anytown, CA, + * 12345, * USA</g:location>
    Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted - * Ads. Reference Items, Events, Housing, Jobs, News and Articles, People + * profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.