From 6e2a56066b3a5807098f8a84301d00b57cefefed Mon Sep 17 00:00:00 2001 From: Patrick Gotthard Date: Sat, 12 Apr 2014 15:14:43 +0200 Subject: [PATCH] Formatted and cleaned up code --- .../activitystreams/ActivityStreamModule.java | 8 +- .../ActivityStreamModuleImpl.java | 10 +- .../activitystreams/types/ActivityObject.java | 13 +- .../module/activitystreams/types/Article.java | 7 +- .../module/activitystreams/types/Audio.java | 14 +- .../activitystreams/types/Bookmark.java | 17 +- .../module/activitystreams/types/Comment.java | 13 +- .../module/activitystreams/types/Event.java | 13 +- .../module/activitystreams/types/File.java | 13 +- .../module/activitystreams/types/Folder.java | 13 +- .../module/activitystreams/types/Group.java | 8 +- .../activitystreams/types/HasLocation.java | 14 +- .../module/activitystreams/types/List.java | 13 +- .../module/activitystreams/types/Mood.java | 12 +- .../module/activitystreams/types/Note.java | 13 +- .../module/activitystreams/types/Person.java | 17 +- .../module/activitystreams/types/Photo.java | 13 +- .../activitystreams/types/PhotoAlbum.java | 13 +- .../module/activitystreams/types/Place.java | 13 +- .../activitystreams/types/Playlist.java | 15 +- .../module/activitystreams/types/Product.java | 13 +- .../module/activitystreams/types/Review.java | 13 +- .../module/activitystreams/types/Service.java | 13 +- .../module/activitystreams/types/Song.java | 10 +- .../module/activitystreams/types/Status.java | 13 +- .../module/activitystreams/types/Verb.java | 36 +- .../module/activitystreams/types/Video.java | 8 +- .../feed/module/atomthread/ThreadModule.java | 8 +- .../rometools/feed/module/base/Article.java | 144 +-- .../rometools/feed/module/base/Course.java | 232 ++-- .../rometools/feed/module/base/CustomTag.java | 40 +- .../feed/module/base/CustomTagImpl.java | 14 +- .../feed/module/base/CustomTagsImpl.java | 4 + .../org/rometools/feed/module/base/Event.java | 576 ++++----- .../feed/module/base/GlobalInterface.java | 186 +-- .../feed/module/base/GoogleBase.java | 6 +- .../feed/module/base/GoogleBaseImpl.java | 9 +- .../rometools/feed/module/base/Housing.java | 648 +++++----- .../org/rometools/feed/module/base/Job.java | 310 ++--- .../rometools/feed/module/base/Person.java | 302 ++--- .../rometools/feed/module/base/Product.java | 1120 ++++++++--------- .../rometools/feed/module/base/Review.java | 294 ++--- .../feed/module/base/ScholarlyArticle.java | 178 +-- .../rometools/feed/module/base/Service.java | 498 ++++---- .../rometools/feed/module/base/Travel.java | 534 ++++---- .../rometools/feed/module/base/Unknown.java | 2 +- .../feed/module/base/ValidationException.java | 7 +- .../rometools/feed/module/base/Vehicle.java | 774 ++++++------ .../rometools/feed/module/base/Wanted.java | 82 +- .../feed/module/base/io/CustomTagParser.java | 2 +- .../module/base/io/GoogleBaseGenerator.java | 2 +- .../feed/module/base/io/GoogleBaseParser.java | 2 +- .../feed/module/base/types/CloneableType.java | 2 +- .../base/types/CurrencyEnumeration.java | 4 +- .../feed/module/base/types/DateTimeRange.java | 12 +- .../feed/module/base/types/FloatUnit.java | 16 +- .../module/base/types/GenderEnumeration.java | 2 +- .../feed/module/base/types/IntUnit.java | 2 +- .../base/types/PaymentTypeEnumeration.java | 2 +- .../base/types/PriceTypeEnumeration.java | 12 +- .../feed/module/base/types/ShippingType.java | 22 +- .../feed/module/base/types/ShortDate.java | 15 +- .../feed/module/base/types/Size.java | 18 +- .../feed/module/base/types/YearType.java | 10 +- .../feed/module/cc/CreativeCommons.java | 10 +- .../feed/module/cc/CreativeCommonsImpl.java | 12 +- .../feed/module/cc/io/CCModuleGenerator.java | 8 +- .../feed/module/cc/io/ModuleParserRSS1.java | 8 +- .../feed/module/cc/io/ModuleParserRSS2.java | 10 +- .../feed/module/cc/types/License.java | 8 +- .../feed/module/content/ContentItem.java | 2 +- .../feed/module/content/ContentModule.java | 12 +- .../module/content/ContentModuleImpl.java | 4 + .../feed/module/feedburner/FeedBurner.java | 10 +- .../module/feedburner/FeedBurnerImpl.java | 4 +- .../io/FeedBurnerModuleGenerator.java | 4 +- .../feedburner/io/FeedBurnerModuleParser.java | 4 +- .../feed/module/georss/GMLGenerator.java | 7 +- .../feed/module/georss/GMLModuleImpl.java | 10 +- .../feed/module/georss/GMLParser.java | 6 +- .../feed/module/georss/GeoRSSModule.java | 20 +- .../feed/module/georss/GeoRSSPoint.java | 2 +- .../feed/module/georss/GeoRSSUtils.java | 16 +- .../feed/module/georss/SimpleGenerator.java | 7 +- .../feed/module/georss/SimpleModuleImpl.java | 10 +- .../feed/module/georss/SimpleParser.java | 6 +- .../feed/module/georss/W3CGeoGenerator.java | 7 +- .../feed/module/georss/W3CGeoModuleImpl.java | 10 +- .../feed/module/georss/W3CGeoParser.java | 6 +- .../georss/geometries/AbstractCurve.java | 7 +- .../AbstractGeometricPrimitive.java | 7 +- .../georss/geometries/AbstractGeometry.java | 9 +- .../georss/geometries/AbstractRing.java | 7 +- .../georss/geometries/AbstractSurface.java | 7 +- .../module/georss/geometries/Envelope.java | 8 +- .../module/georss/geometries/LineString.java | 10 +- .../module/georss/geometries/LinearRing.java | 10 +- .../feed/module/georss/geometries/Point.java | 10 +- .../module/georss/geometries/Polygon.java | 14 +- .../module/georss/geometries/Position.java | 12 +- .../georss/geometries/PositionList.java | 14 +- .../module/itunes/AbstractITunesObject.java | 43 +- .../feed/module/itunes/EntryInformation.java | 8 +- .../module/itunes/EntryInformationImpl.java | 14 +- .../feed/module/itunes/FeedInformation.java | 22 +- .../module/itunes/FeedInformationImpl.java | 30 +- .../rometools/feed/module/itunes/ITunes.java | 30 +- .../module/itunes/io/ITunesGenerator.java | 4 +- .../feed/module/itunes/io/ITunesParser.java | 2 +- .../itunes/io/ITunesParserOldNamespace.java | 2 +- .../feed/module/itunes/types/Category.java | 18 +- .../feed/module/itunes/types/Duration.java | 42 +- .../feed/module/itunes/types/Subcategory.java | 16 +- .../module/mediarss/MediaEntryModule.java | 6 +- .../module/mediarss/MediaEntryModuleImpl.java | 10 +- .../feed/module/mediarss/MediaModule.java | 6 +- .../feed/module/mediarss/MediaModuleImpl.java | 14 +- .../io/AlternateMediaModuleParser.java | 2 +- .../module/mediarss/io/MediaModuleParser.java | 4 +- .../module/mediarss/io/RSS20YahooParser.java | 10 +- .../mediarss/types/AbstractSchemeValue.java | 2 +- .../feed/module/mediarss/types/Category.java | 24 +- .../feed/module/mediarss/types/Credit.java | 24 +- .../feed/module/mediarss/types/Hash.java | 16 +- .../module/mediarss/types/MediaContent.java | 116 +- .../module/mediarss/types/MediaGroup.java | 20 +- .../feed/module/mediarss/types/Metadata.java | 288 ++--- .../mediarss/types/PlayerReference.java | 18 +- .../feed/module/mediarss/types/Rating.java | 24 +- .../feed/module/mediarss/types/Reference.java | 2 +- .../module/mediarss/types/Restriction.java | 18 +- .../feed/module/mediarss/types/Text.java | 36 +- .../feed/module/mediarss/types/Thumbnail.java | 38 +- .../feed/module/mediarss/types/Time.java | 6 +- .../module/mediarss/types/UrlReference.java | 8 +- .../module/opensearch/OpenSearchModule.java | 2 +- .../module/opensearch/OpenSearchResponse.java | 40 +- .../module/opensearch/entity/OSQuery.java | 18 +- .../impl/OpenSearchModuleGenerator.java | 2 +- .../opensearch/impl/OpenSearchModuleImpl.java | 2 - .../impl/OpenSearchModuleParser.java | 10 +- .../module/photocast/PhotocastModule.java | 24 +- .../module/photocast/PhotocastModuleImpl.java | 6 +- .../feed/module/photocast/io/Generator.java | 2 +- .../feed/module/photocast/io/Parser.java | 2 +- .../feed/module/photocast/types/Metadata.java | 10 +- .../module/photocast/types/PhotoDate.java | 12 +- .../portablecontacts/ContactModule.java | 8 +- .../portablecontacts/types/Address.java | 8 +- .../rometools/feed/module/slash/Slash.java | 2 +- .../feed/module/slash/SlashImpl.java | 7 +- .../module/slash/io/SlashModuleGenerator.java | 2 +- .../module/slash/io/SlashModuleParser.java | 2 +- .../feed/module/sle/SimpleListExtension.java | 14 +- .../module/sle/SimpleListExtensionImpl.java | 12 +- .../rometools/feed/module/sle/SleEntry.java | 12 +- .../feed/module/sle/SleEntryImpl.java | 12 +- .../rometools/feed/module/sle/SleUtility.java | 15 +- .../feed/module/sle/io/ItemParser.java | 10 +- .../feed/module/sle/io/ModuleGenerator.java | 8 +- .../feed/module/sle/io/ModuleParser.java | 10 +- .../feed/module/sle/types/DateValue.java | 14 +- .../feed/module/sle/types/EntryValue.java | 10 +- .../feed/module/sle/types/Group.java | 22 +- .../feed/module/sle/types/NumberValue.java | 2 +- .../rometools/feed/module/sle/types/Sort.java | 30 +- .../feed/module/sle/types/StringValue.java | 2 +- .../feed/module/sse/SSE091Generator.java | 12 +- .../feed/module/sse/SSE091Parser.java | 20 +- .../feed/module/sse/modules/History.java | 18 +- .../feed/module/sse/modules/Related.java | 26 +- .../feed/module/sse/modules/Sharing.java | 26 +- .../feed/module/sse/modules/Sync.java | 24 +- .../feed/module/sse/modules/Update.java | 12 +- .../yahooweather/YWeatherEntryModule.java | 10 +- .../yahooweather/YWeatherFeedModule.java | 22 +- .../module/yahooweather/YWeatherModule.java | 2 +- .../yahooweather/YWeatherModuleImpl.java | 2 +- .../io/WeatherModuleGenerator.java | 2 +- .../yahooweather/io/WeatherModuleParser.java | 4 +- .../module/yahooweather/types/Astronomy.java | 16 +- .../module/yahooweather/types/Atmosphere.java | 48 +- .../module/yahooweather/types/Condition.java | 24 +- .../yahooweather/types/ConditionCode.java | 70 +- .../module/yahooweather/types/Forecast.java | 34 +- .../module/yahooweather/types/Location.java | 20 +- .../feed/module/yahooweather/types/Units.java | 24 +- .../feed/module/yahooweather/types/Wind.java | 20 +- .../feed/module/AbstractTestCase.java | 6 +- .../feed/module/ITunesGeneratorTest.java | 2 +- .../feed/module/MediaModuleTest.java | 56 +- .../activitystreams/types/VerbTest.java | 8 +- .../base/io/CustomTagGeneratorTest.java | 2 +- .../module/base/io/CustomTagParserTest.java | 2 +- .../base/io/GoogleBaseGeneratorTest.java | 2 +- .../module/base/io/GoogleBaseParserTest.java | 2 +- .../feed/module/base/types/FloatUnitTest.java | 2 +- .../feed/module/base/types/IntUnitTest.java | 2 +- .../module/cc/io/CCModuleGeneratorTest.java | 2 +- .../feed/module/cc/io/ModuleParserTest.java | 2 +- .../feed/module/cc/types/LicenseTest.java | 26 +- .../feed/module/content/ContentItemTest.java | 4 +- .../content/ContentModuleGeneratorTest.java | 2 +- .../module/content/ContentModuleImplTest.java | 2 +- .../content/ContentModuleParserTest.java | 2 +- .../rometools/feed/module/georss/RssTest.java | 2 +- .../module/itunes/ITunesGeneratorTest.java | 2 +- .../feed/module/itunes/ITunesParserTest.java | 2 +- .../module/itunes/types/DurationTest.java | 2 +- .../feed/module/mediarss/GoogleTest.java | 2 +- .../feed/module/mediarss/MediaModuleTest.java | 2 +- .../feed/module/mediarss/types/TimeTest.java | 2 +- .../opensearch/OpenSearchModuleTest.java | 2 +- .../module/photocast/io/GeneratorTest.java | 2 +- .../feed/module/sle/GroupAndSortTest.java | 2 +- .../module/sle/io/ModuleGeneratorTest.java | 2 +- .../feed/module/sle/io/ModuleParserTest.java | 2 +- .../feed/module/sse/SSEParserTest.java | 2 +- .../yahooweather/io/WeahterGeneratorTest.java | 2 +- .../io/WeatherModuleParserTest.java | 2 +- 220 files changed, 4416 insertions(+), 4196 deletions(-) diff --git a/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModule.java b/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModule.java index 266e9e9..43f4da5 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModule.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModule.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -22,7 +22,7 @@ import org.rometools.feed.module.activitystreams.types.Mood; import org.rometools.feed.module.activitystreams.types.Verb; /** - * + * * @author robert.cooper */ public interface ActivityStreamModule { diff --git a/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModuleImpl.java b/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModuleImpl.java index 9db238e..aafc5cb 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/ActivityStreamModuleImpl.java @@ -21,7 +21,7 @@ import org.rometools.feed.module.activitystreams.types.Mood; import org.rometools.feed.module.activitystreams.types.Verb; /** - * + * * @author robert.cooper */ public class ActivityStreamModuleImpl implements ActivityStreamModule { @@ -30,7 +30,7 @@ public class ActivityStreamModuleImpl implements ActivityStreamModule { /** * Set the value of object - * + * * @param newobject new value of object */ @Override @@ -40,7 +40,7 @@ public class ActivityStreamModuleImpl implements ActivityStreamModule { /** * Get the value of object - * + * * @return the value of object */ @Override @@ -50,7 +50,7 @@ public class ActivityStreamModuleImpl implements ActivityStreamModule { /** * Set the value of verb - * + * * @param newverb new value of verb */ @Override @@ -60,7 +60,7 @@ public class ActivityStreamModuleImpl implements ActivityStreamModule { /** * Get the value of verb - * + * * @return the value of verb */ @Override diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/ActivityObject.java b/src/main/java/org/rometools/feed/module/activitystreams/types/ActivityObject.java index bca8705..f602e91 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/ActivityObject.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/ActivityObject.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -23,11 +23,16 @@ import org.rometools.feed.module.portablecontacts.ContactModule; import com.sun.syndication.feed.atom.Entry; /** - * + * * @author robert.cooper */ public abstract class ActivityObject extends Entry implements HasLocation { + /** + * + */ + private static final long serialVersionUID = 1L; + public abstract String getTypeIRI(); @Override 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 8c73c69..78b671e 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 @@ -40,10 +40,15 @@ package org.rometools.feed.module.activitystreams.types; * HTML that represents the content. * * - * + * * @author robert.cooper */ public class Article extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/article"; 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 eaab594..db8b2b2 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 @@ -37,16 +37,20 @@ package org.rometools.feed.module.activitystreams.types; *
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 */ public class Audio extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; private String embedCode; private String streamLink; /** * Set the value of embedCode - * + * * @param newembedCode new value of embedCode */ public void setEmbedCode(final String newembedCode) { @@ -55,7 +59,7 @@ public class Audio extends ActivityObject { /** * Get the value of embedCode - * + * * @return the value of embedCode */ public String getEmbedCode() { @@ -64,7 +68,7 @@ public class Audio extends ActivityObject { /** * Set the value of streamLink - * + * * @param newstreamLink new value of streamLink */ public void setStreamLink(final String newstreamLink) { @@ -73,7 +77,7 @@ public class Audio extends ActivityObject { /** * Get the value of streamLink - * + * * @return the value of streamLink */ public String getStreamLink() { 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 b584958..4827c47 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -61,11 +61,16 @@ import com.sun.syndication.feed.atom.Link; * ignore thumbnails that are of an inappropriate size for their user interface. * * - * + * * @author robert.cooper */ public class Bookmark extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/bookmark"; @@ -73,7 +78,7 @@ public class Bookmark extends ActivityObject { /** * Get the value of thumbnail - * + * * @return the value of thumbnail */ public Link getThumbnail() { @@ -82,7 +87,7 @@ public class Bookmark extends ActivityObject { /** * Set the value of thumbnail - * + * * @param newthumbnail new value of thumbnail */ public void setThumbnail(final Link newthumbnail) { 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 453dcc1..ffba3ab 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -44,11 +44,16 @@ package org.rometools.feed.module.activitystreams.types; * any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text. * * - * + * * @author robert.cooper */ public class Comment extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/comment"; 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 25875de..30ef9f8 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -39,11 +39,16 @@ package org.rometools.feed.module.activitystreams.types; * timestamp. [TODO: Reference W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.] * * - * + * * @author robert.cooper */ public class Event extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/event"; 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 7a16564..43ded46 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -43,11 +43,16 @@ package org.rometools.feed.module.activitystreams.types; * containing the MIME type. * * - * + * * @author robert.cooper */ public class File extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/file"; 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 4e86fbe..fc1980b 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -37,11 +37,16 @@ package org.rometools.feed.module.activitystreams.types; * the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size for their user interface. * * - * + * * @author robert.cooper */ public class Folder extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/folder"; 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 47d98ea..b1972ba 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -26,7 +26,7 @@ package org.rometools.feed.module.activitystreams.types; *

*

* A group has no additional components. - * + * * @author robert.cooper */ public class Group { 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 be3aca0..688a36e 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -38,7 +38,7 @@ import org.rometools.feed.module.portablecontacts.ContactModule; * *

*
- * + * * 
  * <entry>
  *   <id>tag:world:activity:1212121212121</id>
@@ -72,7 +72,7 @@ import org.rometools.feed.module.portablecontacts.ContactModule;
  *   <activity:verb>http://activitystrea.ms/schema/1.0/like</activity:verb>
  * </entry>
  *
- * + * *
*

* @@ -82,9 +82,9 @@ import org.rometools.feed.module.portablecontacts.ContactModule; * *
*

- * + * *

- * + * * @author robert.cooper */ public interface HasLocation { diff --git a/src/main/java/org/rometools/feed/module/activitystreams/types/List.java b/src/main/java/org/rometools/feed/module/activitystreams/types/List.java index 1521254..0bc1dd3 100644 --- a/src/main/java/org/rometools/feed/module/activitystreams/types/List.java +++ b/src/main/java/org/rometools/feed/module/activitystreams/types/List.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -27,11 +27,16 @@ package org.rometools.feed.module.activitystreams.types; *

* A list has no additional components. *

- * + * * @author robert.cooper */ public class List extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/list"; 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 c649638..9773f0d 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 @@ -17,7 +17,7 @@ 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. @@ -32,7 +32,7 @@ package org.rometools.feed.module.activitystreams.types; * 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 */ public class Mood { @@ -41,7 +41,7 @@ public class Mood { /** * Set the value of iconUrl - * + * * @param newiconUrl new value of iconUrl */ public void setIconUrl(final String newiconUrl) { @@ -50,7 +50,7 @@ public class Mood { /** * Get the value of iconUrl - * + * * @return the value of iconUrl */ public String getIconUrl() { @@ -59,7 +59,7 @@ public class Mood { /** * Set the value of text - * + * * @param newtext new value of text */ public void setText(final String newtext) { @@ -68,7 +68,7 @@ public class Mood { /** * Get the value of text - * + * * @return the value of text */ public String getText() { 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 adc01ad..a242a1c 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,11 +42,16 @@ package org.rometools.feed.module.activitystreams.types; * any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text. * * - * + * * @author robert.cooper */ public class Note extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/note"; 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 8d67e88..48cb650 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -41,11 +41,16 @@ import com.sun.syndication.feed.atom.Link; *
A link to an "avatar" or "userpic" image for the user. Represented by the Representative Image component of the base Object Construct.
* * - * + * * @author robert.cooper */ public class Person extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/person"; @@ -53,7 +58,7 @@ public class Person extends ActivityObject { /** * Get the value of avatar - * + * * @return the value of avatar */ public Link getAvatar() { @@ -66,7 +71,7 @@ public class Person extends ActivityObject { /** * Set the value of avatar - * + * * @param newavatar new value of avatar */ public void setAvatar(final Link newavatar) { 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 9ac783b..d73ecad 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -39,11 +39,16 @@ package org.rometools.feed.module.activitystreams.types; * property named fullImage whose value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]. * * - * + * * @author robert.cooper */ public class Photo extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/photo"; 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 ce777c2..e3f8d90 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -36,11 +36,16 @@ package org.rometools.feed.module.activitystreams.types; * the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size for their user interface. * * - * + * * @author robert.cooper */ public class PhotoAlbum extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/photo-album"; 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 cc5a7fd..70078af 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -39,11 +39,16 @@ package org.rometools.feed.module.activitystreams.types; * decimal representation of the longitude in degrees. * * - * + * * @author robert.cooper */ public class Place extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/place"; 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 bace92e..ec40303 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -18,7 +18,7 @@ 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. *

@@ -28,11 +28,16 @@ package org.rometools.feed.module.activitystreams.types; *

* A playlist has no additional components. *

- * + * * @author robert.cooper */ public class Playlist extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/playlist"; 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 045a012..0de1c8b 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -39,11 +39,16 @@ package org.rometools.feed.module.activitystreams.types; * fullImage whose value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]. * * - * + * * @author robert.cooper */ public class Product extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/product"; 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 009f1d7..ffe6dcc 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -46,11 +46,16 @@ package org.rometools.feed.module.activitystreams.types; * rating whose value is a JSON number giving the rating. * * - * + * * @author robert.cooper */ public class Review extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/review"; 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 922b613..c9748bd 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -38,11 +38,16 @@ package org.rometools.feed.module.activitystreams.types; * one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size. * * - * + * * @author robert.cooper */ public class Service extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/service"; 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 15bf7de..0f3495a 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 @@ -32,15 +32,19 @@ package org.rometools.feed.module.activitystreams.types; *

* A song has no additional components. *

- * + * * @author robert.cooper */ public class Song extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; private Audio audio; /** * Set the value of audio - * + * * @param newaudio new value of audio */ public void setAudio(final Audio newaudio) { @@ -49,7 +53,7 @@ public class Song extends ActivityObject { /** * Get the value of audio - * + * * @return the value of audio */ public Audio getAudio() { 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 f51c6a9..e7f8c0e 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -35,11 +35,16 @@ package org.rometools.feed.module.activitystreams.types; *

* A status has the same components as a note. *

- * + * * @author robert.cooper */ public class Status extends ActivityObject { + /** + * + */ + private static final long serialVersionUID = 1L; + @Override public String getTypeIRI() { return "http://activitystrea.ms/schema/1.0/status"; 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 a540ade..0794d79 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 @@ -17,7 +17,7 @@ package org.rometools.feed.module.activitystreams.types; /** - * + * * @author robert.cooper */ public enum Verb { @@ -31,49 +31,49 @@ public enum Verb { /** * 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. */ START_FOLLOWING("http://activitystrea.ms/schema/1.0/follow"), /** * The "mark as liked" verb indicates that the actor indicated that it likes the object. - * + * * The verb URI for the "mark as liked" Verb is http://activitystrea.ms/schema/1.0/like. */ 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. - * + * * 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. - * + * * 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 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. - * + * * http://activitystrea.ms/schema/1.0/post */ POST("http://activitystrea.ms/schema/1.0/post"), @@ -81,38 +81,38 @@ public enum Verb { * 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 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 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. */ 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. - * + * * The "update" Verb is identified by the URI http://activitystrea.ms/schema/1.0/update. */ UPDATE("http://activitystrea.ms/schema/1.0/update"), /** - * + * *

* 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 @@ -172,7 +172,7 @@ public enum Verb { } /** - * + * * @param iri * @return */ 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 72a2714..ef0e959 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 @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -39,7 +39,7 @@ package org.rometools.feed.module.activitystreams.types; * called embedCode whose value is a JSON string containing the fragment of HTML. * * - * + * * @author robert.cooper */ public class Video { diff --git a/src/main/java/org/rometools/feed/module/atomthread/ThreadModule.java b/src/main/java/org/rometools/feed/module/atomthread/ThreadModule.java index 61d4be4..58ba127 100644 --- a/src/main/java/org/rometools/feed/module/atomthread/ThreadModule.java +++ b/src/main/java/org/rometools/feed/module/atomthread/ThreadModule.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -18,7 +18,7 @@ package org.rometools.feed.module.atomthread; /** - * + * * @author robert.cooper */ public interface ThreadModule { 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 3c5cc58..45045ec 100644 --- a/src/main/java/org/rometools/feed/module/base/Article.java +++ b/src/main/java/org/rometools/feed/module/base/Article.java @@ -43,7 +43,7 @@ import java.util.Date; /** * 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 $ */ @@ -51,34 +51,34 @@ public interface Article extends GlobalInterface { /** * Array of Author Names. Limit 10. * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @param authors Array of Author Names. Limit 10. */ public void setAuthors(String[] authors); @@ -86,283 +86,283 @@ public interface Article extends GlobalInterface { /** * Array of Author Names. Limit 10. * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @return Array of author names. */ public String[] getAuthors(); /** * Source for this article. - * - * + * + * * * * - * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
news_source
Details The source of news content.
Example <g:news_source>Journal</g:news_source>
Attribute of News and Articles
- * + * * Content type string
- * + * * @param newsSource Source for this article */ public void setNewsSource(String newsSource); /** * Source for this article. - * + * * * * - * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
news_source
Details The source of news content.
Example <g:news_source>Journal</g:news_source>
Attribute of News and Articles
- * + * * Content type string
- * + * * @return source for this article. */ public String getNewsSource(); /** * Number of pages in the article. - * + * * - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * * * *
pages
Details - * + * * The number of pages in the publication.
Example <g:pages>18</g:pages>
Attribute of Reference Items, News and Articles
- * + * * Content type integer
- * + * * @param pages Number of pages in the article */ public void setPages(Integer pages); /** * Number of pages in the article. - * + * * - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * * * *
pages
Details - * + * * The number of pages in the publication.
Example <g:pages>18</g:pages>
Attribute of Reference Items, News and Articles
- * + * * Content type integer
- * + * * @return Number of pages in the article */ public Integer getPages(); /** * Date article was published. - * + * * * * * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * * * * * * *
publish_date
- * + * * Details Date the item was published in ISO 8601 format: * YYYY-MM-DD
- * + * * Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of Reference Items
- * + * * Content type - * + * * date
- * + * * @param publishDate Date article was published */ public void setPublishDate(Date publishDate); /** * Date article was published. - * + * * * * * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * * * * * * *
publish_date
- * + * * Details Date the item was published in ISO 8601 format: * YYYY-MM-DD
- * + * * Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of Reference Items
- * + * * Content type - * + * * date
- * + * * @return Date article was published */ public Date getPublishDate(); 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 0273655..b042944 100644 --- a/src/main/java/org/rometools/feed/module/base/Course.java +++ b/src/main/java/org/rometools/feed/module/base/Course.java @@ -42,20 +42,20 @@ 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. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ public interface Course extends GlobalInterface { /** * The timeframe a course is running. - * - * + * + * * - * + * * * - * + * * * * @@ -63,7 +63,7 @@ public interface Course extends GlobalInterface { * * * * * - * + * * * * * * - * + * * * * *
course_date_range
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
    • *
  • end = End date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • *
@@ -72,41 +72,41 @@ public interface Course extends GlobalInterface { *
Example <g:course_date_range>
- * + * * <g:start>2005-12-20T09:30:01</g:start>
* <g:end>2005-12-29T10:30:59</g:end>
* </g:course_date_range>
- * + * * Attribute of Course schedules
- * + * * Content type dateTimeRange
- * + * * @param courseDateRange The timeframe a course is running */ public void setCourseDateRange(DateTimeRange courseDateRange); /** * The timeframe a course is running. - * - * + * + * * - * + * * * - * + * * * * @@ -114,7 +114,7 @@ public interface Course extends GlobalInterface { * * * * * - * + * * * * * * - * + * * * * *
course_date_range
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
    • *
  • end = End date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • *
@@ -123,36 +123,36 @@ public interface Course extends GlobalInterface { *
Example <g:course_date_range>
- * + * * <g:start>2005-12-20T09:30:01</g:start>
* <g:end>2005-12-29T10:30:59</g:end>
* </g:course_date_range>
- * + * * Attribute of Course schedules
- * + * * Content type dateTimeRange
- * + * * @return The timeframe a course is running */ public DateTimeRange getCourseDateRange(); /** * ID code associated with a course. - * - * + * + * * * * @@ -160,38 +160,38 @@ public interface Course extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * - * + * * * *
DetailsID code associated with a course
Example<g:course_number>HIST-90A</g:course_number>
Attribute ofCourse schedules
Content typestring
- * + * * @param courseNumber ID code associated with a course */ public void setCourseNumber(String courseNumber); /** * ID code associated with a course. - * - * - * + * + * + * * * * @@ -199,271 +199,271 @@ public interface Course extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * - * + * * * *
DetailsID code associated with a course
Example<g:course_number>HIST-90A</g:course_number>
Attribute ofCourse schedules
Content typestring
- * + * * @return ID code associated with a course */ public String getCourseNumber(); /** * Time a class is in session. - * - * + * + * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * *
course_times
DetailsTime a class is in session.
Example<g:course_times>MWF 08:30 - 09:45</g:course_times>
Attribute ofCourse schedules
Content typestring
- * + * * @param courseTimes Time a class is in session */ public void setCourseTimes(String courseTimes); /** * Time a class is in session. - * - * - * + * + * + * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * *
course_times
DetailsTime a class is in session.
Example<g:course_times>MWF 08:30 - 09:45</g:course_times>
Attribute ofCourse schedules
Content typestring
- * + * * @return Time a class is in session */ public String getCourseTimes(); /** * Salary for this position. - * - * - * + * + * + * * * * * * - * + * * - * + * * * * * - * + * * * * * * - * + * * * * * - * + * * * * *
salary
Details Salary for this position. Non-numeric values such as "$" symbols are not acceptable.
- * + * * Example <g:salary>55000</g:salary>
- * + * * Attribute of Jobs
Content type - * + * * float
- * + * * @param salary Salary for this position */ public void setSalary(Float salary); /** * Salary for this position. - * - * + * + * * * * * * - * + * * - * + * * * * * - * + * * * * * * - * + * * * * * - * + * * * * *
salary
Details Salary for this position. Non-numeric values such as "$" symbols are not acceptable.
- * + * * Example <g:salary>55000</g:salary>
- * + * * Attribute of Jobs
Content type - * + * * float
- * + * * @return Salary for this position */ public Float getSalary(); /** * Topics of study for a course. - * - * + * + * * * * * * * - * + * * * * * * - * + * * * * * * * * * * - * + * * * *
subject
- * + * * Details Topic of study for a course.
Example <g:subject>Trigonometry</g:subject>
Attribute of - * + * * Course schedules
Content type string
- * + * * @param subject Topics of study for a course */ public void setSubjects(String[] subject); /** * Topics of study for a course. - * - * + * + * * * * * * * - * + * * * * * * - * + * * * * * * * * * * - * + * * * *
subject
- * + * * Details Topic of study for a course.
Example <g:subject>Trigonometry</g:subject>
Attribute of - * + * * Course schedules
Content type string
- * + * * @return Topics of study for a course */ public String[] getSubjects(); @@ -474,35 +474,35 @@ public interface Course extends GlobalInterface { * * * university - * + * * * * Details * Name of the school a class is offered at. * - * + * * - * + * * Example * <g:university>Stanford</g:university> * * - * + * * - * + * * Attribute of * Course schedules * * * Content type - * + * * - * + * * string * * * - * + * * @param university Name of the school at which a class is offered. */ public void setUniversity(String university); @@ -513,35 +513,35 @@ public interface Course extends GlobalInterface { * * * university - * + * * * * Details * Name of the school a class is offered at. * - * + * * - * + * * Example * <g:university>Stanford</g:university> * * - * + * * - * + * * Attribute of * Course schedules * * * Content type - * + * * - * + * * string * * * - * + * * @return Name of the school at which a class is offered. */ public String getUniversity(); 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 dad4798..b3c8d74 100644 --- a/src/main/java/org/rometools/feed/module/base/CustomTag.java +++ b/src/main/java/org/rometools/feed/module/base/CustomTag.java @@ -22,7 +22,7 @@ package org.rometools.feed.module.base; /** * This class represents a custom tag name and value. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ @@ -30,7 +30,7 @@ public interface CustomTag { /** * Returns the tag name used. - * + * * @return Returns the tag name used. */ public String getName(); @@ -42,7 +42,7 @@ public interface CustomTag { * * * Type (JavaType) - * + * * Description * Examples * @@ -50,7 +50,7 @@ public interface CustomTag { * string (String) * Any string * Blue - * + * * * * int (Integer) @@ -58,71 +58,71 @@ public interface CustomTag { * 1000 * * - * + * * float (Float) * Numbers with decimal digits * 3.5 * * * intUnit (IntUnit) - * + * * Whole number value and a string - * + * * 10 km * * * floatUnit (FloatUnit) * Numbers with decimal digits and a string - * + * * 1.5 km * - * + * * * date (ShortDate) * Date of an event, in format YYYY-MM-DD * 2005-12-12 * - * + * * * dateTime (java.util.Date) - * + * * Date and time for an event, in format YYYY-MM-DDThh:mm:ss * 2005-12-12T12:00:00 * * * 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-DD - * + * * <start>1975-09-25</start>
* <end>1975-09-25</end> - * + * * * * * url (java.net.URL) * HTTP URL - * + * * http://www.google.com * - * + * * * boolean (Boolean) * Value may be either true or false. * true * - * + * * * location (CustomTagImpl.Location) - * + * * Location * 921 W. Dana Street, Mtn View, CA-94103 * - * + * * * - * + * * @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 c8b8478..008a7c2 100644 --- a/src/main/java/org/rometools/feed/module/base/CustomTagImpl.java +++ b/src/main/java/org/rometools/feed/module/base/CustomTagImpl.java @@ -148,23 +148,23 @@ 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:

- * + * * 
      * x.clone() != x
      *
- * + * *
will be true, and that the expression:
- * + * * 
      * x.clone().getClass() == x.getClass()
      *
- * + * *
will be true, but these are not absolute requirements. While it is typically the case that:
- * + * * 
      * x.clone().equals(x)
      *
- * + * *
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) @@ -184,7 +184,7 @@ public class CustomTagImpl implements CustomTag { *

* 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. diff --git a/src/main/java/org/rometools/feed/module/base/CustomTagsImpl.java b/src/main/java/org/rometools/feed/module/base/CustomTagsImpl.java index 589e383..0c5f77b 100644 --- a/src/main/java/org/rometools/feed/module/base/CustomTagsImpl.java +++ b/src/main/java/org/rometools/feed/module/base/CustomTagsImpl.java @@ -31,6 +31,10 @@ import com.sun.syndication.feed.CopyFrom; */ public class CustomTagsImpl implements CustomTags { + /** + * + */ + private static final long serialVersionUID = 1L; private List values; /** Creates a new instance of CustomTagsImpl */ 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 c781c7d..a21c737 100644 --- a/src/main/java/org/rometools/feed/module/base/Event.java +++ b/src/main/java/org/rometools/feed/module/base/Event.java @@ -48,98 +48,98 @@ import org.rometools.feed.module.base.types.ShippingType; /** * This is an interface for the GoogleBase plug in that exposes methods used for Event entry types. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public interface Event extends GlobalInterface { /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -147,16 +147,16 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -165,19 +165,19 @@ public interface Event extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public void setDeliveryNotes(String deliveryNotes); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -185,16 +185,16 @@ public interface Event extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -203,12 +203,12 @@ public interface Event extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); @@ -219,7 +219,7 @@ public interface Event extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -227,14 +227,14 @@ public interface Event extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -242,10 +242,10 @@ public interface Event extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public void setDeliveryRadius(FloatUnit deliveryRadius); @@ -256,7 +256,7 @@ public interface Event extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -264,14 +264,14 @@ public interface Event extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -279,10 +279,10 @@ public interface Event extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); @@ -292,48 +292,48 @@ public interface Event extends GlobalInterface { * * * - * + * * - * + * * * * * * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * *
event_date_range
Details - * + * * 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: *
    - * + * *
  • from = Date and time an event will begin in format YYYY-MM-DDThh:mm:ss
    • *
  • to = (Optional). Date and time an event will end, in format YYYY-MM-DDThh:mm:ss
    • *
*
Example <g:event_dateTime>
- * + * * <g:from>2005-12-20T14:00:00</g:from>
* <g:to>2005-12-20T19:00:00</g:to>
- * + * * </g:eventdateTime>
Attribute of Events
Content type dateTimeRange
- * + * * @param eventDateRange The time during which this event takes place. */ public void setEventDateRange(DateTimeRange eventDateRange); @@ -343,48 +343,48 @@ public interface Event extends GlobalInterface { * * * - * + * * - * + * * * * * * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * *
event_date_range
Details - * + * * 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: *
    - * + * *
  • from = Date and time an event will begin in format YYYY-MM-DDThh:mm:ss
    • *
  • to = (Optional). Date and time an event will end, in format YYYY-MM-DDThh:mm:ss
    • *
*
Example <g:event_dateTime>
- * + * * <g:from>2005-12-20T14:00:00</g:from>
* <g:to>2005-12-20T19:00:00</g:to>
- * + * * </g:eventdateTime>
Attribute of Events
Content type dateTimeRange
- * + * * @return The time during which this event takes place. */ public DateTimeRange getEventDateRange(); @@ -394,43 +394,43 @@ public interface Event extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location where the event will be held. */ public void setLocation(String location); @@ -440,52 +440,52 @@ public interface Event extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location where the event will be held. */ public String getLocation(); /** * Payment Methods acceptable for the event. - * + * * - * + * * * * @@ -493,47 +493,47 @@ public interface Event extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @param paymentAccepted Payment Methods acceptable for the event. */ public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); /** * Payment Methods acceptable for the event. - * + * * - * + * * * * @@ -541,751 +541,751 @@ public interface Event extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @return Payment Methods acceptable for the event. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * Additional information about payment. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * - * - * + * + * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * - * - * + * + * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * + * * @param paymentNotes Additional information about payment. */ public void setPaymentNotes(String paymentNotes); /** * Additional information about payment. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * - * + * + * * @return Additional information about payment. */ public String getPaymentNotes(); /** * Price of the event. - * - * + * + * * * * - * + * * * * * * - * + * * * * - * + * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
- * + * * <g:price>5,95</g:price>
* <g:price>5.00 – 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @param price Price of the event. */ public void setPrice(FloatUnit price); /** * Price of the event. - * - * + * + * * * * - * + * * * * * * - * + * * * * - * + * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
- * + * * <g:price>5,95</g:price>
* <g:price>5.00 – 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @return Price of the event. */ public FloatUnit getPrice(); /** * Price qualifier for the even cost. - * - * + * + * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are "negotiable," or "starting." The default is "starting"
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @param priceType Price qualifier for the even cost. */ public void setPriceType(PriceTypeEnumeration priceType); /** * Price qualifier for the even cost. - * - * + * + * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are "negotiable," or "starting." The default is "starting"
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @return Price qualifier for the even cost. */ public PriceTypeEnumeration getPriceType(); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @param quantity Quantity available. */ public void setQuantity(Integer quantity); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @return Quantity available. */ public Integer getQuantity(); /** * Shipping information related to the event. - * - * + * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @param shipping Shipping information related to the event. */ public void setShipping(ShippingType[] shipping); /** * Shipping information related to the event. - * - * + * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @return Shipping information related to the event. */ public ShippingType[] getShipping(); /** * Tax rate associated with the event. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @param taxPercent Tax rate associated with the event. */ public void setTaxPercent(Float taxPercent); /** * Tax rate associated with the event. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @return Tax rate associated with the event. */ public Float getTaxPercent(); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @param taxRegion Region where tax applies. */ public void setTaxRegion(String taxRegion); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @return Region where tax applies. */ public String getTaxRegion(); 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 7c233f9..6ff89a2 100644 --- a/src/main/java/org/rometools/feed/module/base/GlobalInterface.java +++ b/src/main/java/org/rometools/feed/module/base/GlobalInterface.java @@ -45,14 +45,14 @@ import java.util.Date; /** * This is an interface representing the universals. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ public interface GlobalInterface extends Serializable { /** * Expiration Date for this item.
- * + * * * * @@ -60,14 +60,14 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * * * * * @@ -76,19 +76,19 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * *
Details Date that the item expires in ISO 8601 format: * YYYY-MM-DD
Example <g:expiration_date>2005-20-12</g:expiration_date> - * + * *
Content type date
- * + * * @param expirationDate the date this entry will expire */ public void setExpirationDate(Date expirationDate); /** * Expiration Date for this item.
- * + * * * * @@ -96,14 +96,14 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * * * * * @@ -112,88 +112,88 @@ public interface GlobalInterface extends Serializable { * * * - * + * * * * *
Details Date that the item expires in ISO 8601 format: * YYYY-MM-DD
Example <g:expiration_date>2005-20-12</g:expiration_date> - * + * *
Content type date
- * + * * @return the date this entry will expire */ public Date getExpirationDate(); /** * Date and time that the item expires. - * + * * * * * - * + * * * * * * - * + * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
expiration_date_time
Details 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>
Attribute of Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
Content type dateTime
- * + * * @param expirationDateTime Date and time that the item expires. */ public void setExpirationDateTime(Date expirationDateTime); /** * Date and time that the item expires. - * + * * * * * - * + * * * * * * - * + * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
expiration_date_time
Details 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>
Attribute of Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
Content type dateTime
- * + * * @return Date and time that the item expires. */ public Date getExpirationDateTime(); @@ -207,7 +207,7 @@ public interface GlobalInterface extends Serializable { * * * 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. @@ -215,23 +215,23 @@ public interface GlobalInterface extends Serializable { * * Example * - * + * * <g:id>01flx</g:id> * * * Attribute of * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted * Ads. - * + * * - * + * * * Content type * string * * * - * + * * @param id unique identifier for this entry */ public void setId(String id); @@ -245,7 +245,7 @@ public interface GlobalInterface extends Serializable { * * * 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. @@ -253,178 +253,178 @@ public interface GlobalInterface extends Serializable { * * Example * - * + * * <g:id>01flx</g:id> * * * Attribute of * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted * Ads. - * + * * - * + * * * Content type * string * * * - * + * * @return unique identifier for this entry */ public String getId(); /** * Images for this item.
- * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
image_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.
Example Acceptable:
* <image_link>http://example.com/images/1006.jpg</image_link>
- * + * * <image_link>http://example.com/i/6.jpg,http://example.com/i/9.jpg</image_link>
- * + * * Not acceptable:
* <image_link>/images/1006.jpg</image_link>
* <image_link>example.com/images/1006.jpg</image_link>
Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted * Ads.
Content type url
- * + * * @param imageLinks URLs to images. Limit 10. */ public void setImageLinks(URL[] imageLinks); /** * Images for this item.
- * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
image_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.
Example Acceptable:
* <image_link>http://example.com/images/1006.jpg</image_link>
- * + * * <image_link>http://example.com/i/6.jpg,http://example.com/i/9.jpg</image_link>
- * + * * Not acceptable:
* <image_link>/images/1006.jpg</image_link>
* <image_link>example.com/images/1006.jpg</image_link>
Attribute of Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted * Ads.
Content type url
- * + * * @return URLs to images */ public URL[] getImageLinks(); /** * Labels for this item.
- * + * * * * - * + * * * * * * * - * + * * * * * * * - * + * * @@ -433,74 +433,74 @@ public interface GlobalInterface extends Serializable { * * - * + * * * *
* label
- * + * * Details * 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.
* Example - * + * * Acceptable:
* For an automobile in a Vehicles information type:
* - * + * * <g:label>Leather</g:label>
* <g:label>Power locks</g:label>
- * + * * <g:label>sunroof</g:label>
- * + * * <g:label>ABS</g:label>
*
* For a concert in an Events information type:
- * + * * <g:label>VIP</g:label>
- * + * * <g:label>front row</g:label>
* <g:label>backstage</g:label>
- * + * * - * + * * <g:label>KROCK 101.5</g:label>
* <g:label>parking passes</g:label>
*
* Not acceptable:
- * + * * <g:label> leater, power locks, sunroof, ABS </g:label>
* Attribute of * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted * Ads. * Content type - * + * * string
- * + * * @param labels labels for this entry. Limit 10. */ public void setLabels(String[] labels); /** * Labels for this item.
- * + * * * * - * + * * * * * * * - * + * * * * * * * - * + * * @@ -509,13 +509,13 @@ public interface GlobalInterface extends Serializable { * * - * + * * * *
* label
- * + * * Details * 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.
* Example - * + * * Acceptable:
* For an automobile in a Vehicles information type:
* - * + * * <g:label>Leather</g:label>
* <g:label>Power locks</g:label>
- * + * * <g:label>sunroof</g:label>
- * + * * <g:label>ABS</g:label>
*
* For a concert in an Events information type:
- * + * * <g:label>VIP</g:label>
- * + * * <g:label>front row</g:label>
* <g:label>backstage</g:label>
- * + * * - * + * * <g:label>KROCK 101.5</g:label>
* <g:label>parking passes</g:label>
*
* Not acceptable:
- * + * * <g:label> leater, power locks, sunroof, ABS </g:label>
* Attribute of * Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted * Ads. * Content type - * + * * string
- * + * * @return labels for this entry */ public String[] getLabels(); 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 49bda6f..8a1fa8e 100644 --- a/src/main/java/org/rometools/feed/module/base/GoogleBase.java +++ b/src/main/java/org/rometools/feed/module/base/GoogleBase.java @@ -43,17 +43,17 @@ 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. *

- * + * * @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/GoogleBaseImpl.java b/src/main/java/org/rometools/feed/module/base/GoogleBaseImpl.java index fa51137..12cd7f9 100644 --- a/src/main/java/org/rometools/feed/module/base/GoogleBaseImpl.java +++ b/src/main/java/org/rometools/feed/module/base/GoogleBaseImpl.java @@ -60,11 +60,16 @@ import com.sun.syndication.feed.impl.EqualsBean; /** * This is the implementation class for the GoogleBase module interface. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ public class GoogleBaseImpl implements GoogleBase { + /** + * + */ + private static final long serialVersionUID = 1L; + /** boolean:listing_type */ private Boolean listingType; @@ -343,7 +348,7 @@ public class GoogleBaseImpl implements GoogleBase { /** * DOCUMENT ME! - * + * * @param actors */ @Override 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 fb84963..6882234 100644 --- a/src/main/java/org/rometools/feed/module/base/Housing.java +++ b/src/main/java/org/rometools/feed/module/base/Housing.java @@ -48,7 +48,7 @@ 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. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -59,32 +59,32 @@ public interface Housing extends GlobalInterface { * * * agent - * + * * * * Details * Individual who is negotiating and arranging the real estate sale. - * + * * * * Example - * + * * <g:agent>Sue Smith</g:agent> * * - * + * * Attribute of * Housing * - * + * * * Content type * string - * + * * * * - * + * * @param agents An array of agent name Strings, not to exceed 10 in lenght. */ public void setAgents(String[] agents); @@ -95,106 +95,106 @@ public interface Housing extends GlobalInterface { * * * agent - * + * * * * Details * Individual who is negotiating and arranging the real estate sale. - * + * * * * Example - * + * * <g:agent>Sue Smith</g:agent> * * - * + * * Attribute of * Housing * - * + * * * Content type * string - * + * * * * - * + * * @return An array of agent name Strings, not to exceed 10 in lenght. */ public String[] getAgents(); /** * The area of the real estate. - * + * * - * + * * * * * * - * + * * * * - * + * * * * - * + * * * * - * + * * * * * - * + * * * * *
area
DetailsThe size of an area of real estate.
Example<g:area>1000</g:area>
Attribute ofHousing
Content typeintUnit
- * + * * @param area The area of the real estate */ public void setArea(IntUnit area); /** * The area of the real estate. - * + * * - * + * * * * * * - * + * * * * - * + * * * * - * + * * * * - * + * * * * * - * + * * * * *
area
DetailsThe size of an area of real estate.
Example<g:area>1000</g:area>
Attribute ofHousing
Content typeintUnit
- * + * * @return The area of the real estate */ public IntUnit getArea(); @@ -202,44 +202,44 @@ public interface Housing extends GlobalInterface { /** * The number of bathrooms. * - * + * * * * * * * * * * * - * + * * - * + * * * * * * - * + * * * - * + * * * * *
bathrooms
- * + * * Details - * + * * Number of bathrooms. Numeric values only.
Example Acceptable:
- * + * * <g:bathrooms>2</g:bathrooms>
* Not acceptable:
* <g:bathrooms>2 bathrooms</g:bathrooms>
- * + * * Attribute of Housing
Content type float
- * + * * @param bathrooms The number of bathrooms. */ public void setBathrooms(Float bathrooms); @@ -247,44 +247,44 @@ public interface Housing extends GlobalInterface { /** * The number of bathrooms. * - * + * * * * * * * * * * * - * + * * - * + * * * * * * - * + * * * - * + * * * * *
bathrooms
- * + * * Details - * + * * Number of bathrooms. Numeric values only.
Example Acceptable:
- * + * * <g:bathrooms>2</g:bathrooms>
* Not acceptable:
* <g:bathrooms>2 bathrooms</g:bathrooms>
- * + * * Attribute of Housing
Content type float
- * + * * @return number of bathrooms */ public Float getBathrooms(); @@ -295,168 +295,168 @@ public interface Housing extends GlobalInterface { * * * bedrooms - * + * * * * Details - * + * * Number of bedrooms. Numeric values only. * * * Example - * + * * Acceptable:
* <g:bedrooms>3</g:bedrooms>
* Not acceptable:
- * + * * <g:bedrooms>3 bedrooms</g:bedrooms> * * - * + * * Attribute of * Housing - * + * * * * Content type * integer - * + * * * * - * + * * @param bedrooms Number of bedrooms. */ public void setBedrooms(Integer bedrooms); /** * Number of bedrooms. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
bedrooms
Details Number of bedrooms. Numeric values only.
Example Acceptable:
* <g:bedrooms>3</g:bedrooms>
* Not acceptable:
- * + * * <g:bedrooms>3 bedrooms</g:bedrooms>
Attribute of Housing
Content type integer
- * + * * @return Number of bedrooms */ public Integer getBedrooms(); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * Homeowners association dues on the property. - * + * * * * @@ -464,36 +464,36 @@ public interface Housing extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
Details Monthly dues paid to a homeowners association.
Example<g:hoa_dues>100</g:hoa_dues>
Attribute of Housing
Content type float
- * + * * @param hoaDues Homeowners association dues on the property. */ public void setHoaDues(Float hoaDues); /** * Homeowners association dues on the property. - * + * * * * @@ -501,123 +501,123 @@ public interface Housing extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
Details Monthly dues paid to a homeowners association.
Example<g:hoa_dues>100</g:hoa_dues>
Attribute of Housing
Content type float
- * + * * @return Homeowners association dues on the property. */ public Float getHoaDues(); /** * Indicates whether this property is for sale or not. - * - * - * + * + * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * - * + * * * - * + * * * * * - * + * * *
listing_type
Details Information about whether or not a property is for sale or not. Acceptable values are "True" or "False".
Example Acceptable:
- * + * * <g:for_sale>true</g:for_sale>
* <g:for_sale>false</g:for_sale>
* Not acceptable:
- * + * * <g:for_sale>Sale</g:for_sale>
- * + * * <g:for_sale>Rent</g:for_sale>
Attribute of Housing
Content type Boolean
- * + * * @param forSale Indicates whether this property is for sale or not. */ public void setListingType(Boolean forSale); /** * Indicates whether this property is for sale or not. - * - * - * + * + * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * - * + * * * - * + * * * * * - * + * * *
listing_type
Details Information about whether or not a property is for sale or not. Acceptable values are "True" or "False".
Example Acceptable:
- * + * * <g:for_sale>true</g:for_sale>
* <g:for_sale>false</g:for_sale>
* Not acceptable:
- * + * * <g:for_sale>Sale</g:for_sale>
- * + * * <g:for_sale>Rent</g:for_sale>
Attribute of Housing
Content type Boolean
- * + * * @return Indicates whether this property is for sale or not. */ public Boolean getListingType(); @@ -627,43 +627,43 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of the property. */ public void setLocation(String location); @@ -673,52 +673,52 @@ public interface Housing extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of the property. */ public String getLocation(); /** * Payment Methods acceptable for the property. - * + * * - * + * * * * @@ -726,47 +726,47 @@ public interface Housing extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @param paymentAccepted Payment Methods acceptable for the property. */ public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); /** * Payment Methods acceptable for the property. - * + * * - * + * * * * @@ -774,292 +774,292 @@ public interface Housing extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @return Payment Methods acceptable for the property. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * Additional payment information. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * + * * @param paymentNotes Additional payment information. */ public void setPaymentNotes(String paymentNotes); /** * Additional payment information. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * + * * @return Additional payment information. */ public String getPaymentNotes(); /** * Price for the property.
- * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 � 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @param price Price for the property. */ public void setPrice(FloatUnit price); /** * Price for the property.
- * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 � 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @return Price for the property. */ public FloatUnit getPrice(); /** * Price type information. - * - * + * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @param priceType Price type information. */ public void setPriceType(PriceTypeEnumeration priceType); /** * Price type information. - * - * + * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @return Price type information. */ public PriceTypeEnumeration getPriceType(); @@ -1067,40 +1067,40 @@ public interface Housing extends GlobalInterface { /** * Types of property represented here. Limit 10. * - * + * * * * * * * * * * * - * + * * - * + * * * * * * * - * + * * * - * + * * * *
property_type
- * + * * Details - * + * * Type of property: house, apartment, condominium, etc.
Example <g:property_type>house</g:property_type>
Attribute of - * + * * Housing
Content type string
- * + * * @param propertyTypes Types of property represented here. Limit 10. */ public void setPropertyTypes(String[] propertyTypes); @@ -1108,122 +1108,122 @@ public interface Housing extends GlobalInterface { /** * Types of property represented here. * - * + * * * * * * * * * * * - * + * * - * + * * * * * * * - * + * * * - * + * * * *
property_type
- * + * * Details - * + * * Type of property: house, apartment, condominium, etc.
Example <g:property_type>house</g:property_type>
Attribute of - * + * * Housing
Content type string
- * + * * @return Types of property represented here. Limit 10. */ public String[] getPropertyTypes(); /** * School district a property is in. - * + * * * * - * + * * * - * + * * * * - * + * * * - * + * * * - * + * * * - * + * * * * * - * + * * * * * *
school_district
Details The school district the property is in.
Example <g:school_district>Union School * District</g:school_district>
Attribute of Housing
- * + * * Content type string
- * + * * @param schoolDistrict School district a property is in. */ public void setSchoolDistrict(String schoolDistrict); /** * School district a property is in. - * + * * * * - * + * * * - * + * * * * - * + * * * - * + * * * - * + * * * - * + * * * * * - * + * * * * * *
school_district
Details The school district the property is in.
Example <g:school_district>Union School * District</g:school_district>
Attribute of Housing
- * + * * Content type string
- * + * * @return School district a property is in. */ public String getSchoolDistrict(); @@ -1235,36 +1235,36 @@ public interface Housing extends GlobalInterface { * * tax_percent * - * + * * * - * + * * Details * Tax rate as a percentage. * * - * + * * Example - * + * * <g:tax_percent>8.2<g:/tax_percent> * * * - * + * * Attribute of * - * + * * Products, Events * * * Content type - * + * * percentType - * + * * * * - * + * * @param taxPercent Percentage tax rate. */ public void setTaxPercent(Float taxPercent); @@ -1276,210 +1276,210 @@ public interface Housing extends GlobalInterface { * * tax_percent * - * + * * * - * + * * Details * Tax rate as a percentage. * * - * + * * Example - * + * * <g:tax_percent>8.2<g:/tax_percent> * * * - * + * * Attribute of * - * + * * Products, Events * * * Content type - * + * * percentType - * + * * * * - * + * * @return Percentage tax rate. */ public Float getTaxPercent(); /** * Geographical region a tax rate applies to. - * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @param taxRegion Geographical region a tax rate applies to. */ public void setTaxRegion(String taxRegion); /** * Geographical region a tax rate applies to. - * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @return Geographical region a tax rate applies to. */ public String getTaxRegion(); /** * The four digit model year or year built. - * + * * * * * * * - * + * * - * + * * * * * * * - * + * * * * - * + * * * * * * - * + * * *
year
Details The four digit model year or year built. Format YYYY
- * + * * Example Acceptable:
- * + * * <g:year>2005</g:year>
* Not acceptable:
* <g:year>79</g:year>
- * + * * <g:year>26</g:year>
Attribute of Housing, Vehicles
- * + * * Content type year
- * + * * @param year The four digit model year or year built. */ public void setYear(YearType year); /** * The four digit model year or year built. - * + * * * * * * * - * + * * - * + * * * * * * * - * + * * * * - * + * * * * * * - * + * * *
year
Details The four digit model year or year built. Format YYYY
- * + * * Example Acceptable:
- * + * * <g:year>2005</g:year>
* Not acceptable:
* <g:year>79</g:year>
- * + * * <g:year>26</g:year>
Attribute of Housing, Vehicles
- * + * * Content type year
- * + * * @return The four digit model year or year built. */ public YearType getYear(); 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 2f206fb..91a0656 100644 --- a/src/main/java/org/rometools/feed/module/base/Job.java +++ b/src/main/java/org/rometools/feed/module/base/Job.java @@ -44,7 +44,7 @@ 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. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -58,13 +58,13 @@ public interface Job extends GlobalInterface { * * * Details - * + * * Level of education required for an employment position. * * * Example * <g:education>PhD</g:education> - * + * * * * Attribute of @@ -72,12 +72,12 @@ public interface Job extends GlobalInterface { * * * Content type - * + * * string * * * - * + * * @param education Level of education required for an employment position. */ public void setEducation(String education); @@ -91,13 +91,13 @@ public interface Job extends GlobalInterface { * * * Details - * + * * Level of education required for an employment position. * * * Example * <g:education>PhD</g:education> - * + * * * * Attribute of @@ -105,12 +105,12 @@ public interface Job extends GlobalInterface { * * * Content type - * + * * string * * * - * + * * @return Level of education required for an employment position. */ public String getEducation(); @@ -121,7 +121,7 @@ public interface Job extends GlobalInterface { * * * employer - * + * * * * Details @@ -129,13 +129,13 @@ public interface Job extends GlobalInterface { * * * Example - * + * * <g:employer>Google, Inc</g:employer> * * * Attribute of * Jobs - * + * * * * Content type @@ -143,7 +143,7 @@ public interface Job extends GlobalInterface { * * * - * + * * @param employer Company providing employment. */ public void setEmployer(String employer); @@ -154,7 +154,7 @@ public interface Job extends GlobalInterface { * * * employer - * + * * * * Details @@ -162,13 +162,13 @@ public interface Job extends GlobalInterface { * * * Example - * + * * <g:employer>Google, Inc</g:employer> * * * Attribute of * Jobs - * + * * * * Content type @@ -176,163 +176,163 @@ public interface Job extends GlobalInterface { * * * - * + * * @return Company providing employment. */ public String getEmployer(); /** * Legal residency requirements for an employment position. - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * *
immigration_status
Details Legal residency requirements for an employment position.
Example<g:immigration_status>Permanent resident</g:immigration_status>
Attribute of Jobs
Content type string
- * + * * @param immigrationStatus Legal residency requirements for an employment position. */ public void setImmigrationStatus(String immigrationStatus); /** * Legal residency requirements for an employment position. - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * *
immigration_status
Details Legal residency requirements for an employment position.
Example<g:immigration_status>Permanent resident</g:immigration_status>
Attribute of Jobs
Content type string
- * + * * @return Legal residency requirements for an employment position. */ public String getImmigrationStatus(); /** * The functions of an employment position. - * + * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * - * + * * * * * * * - * + * * * * *
job_function
Details The function of an employment position.
Example <g:job_function>Product Manager</g:job_function>
- * + * * Attribute of Jobs
- * + * * Content type string
- * + * * @param function The functions of an employment position. */ public void setJobFunctions(String[] function); /** * The functions of an employment position. - * + * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * - * + * * * * * * * - * + * * * * *
job_function
Details The function of an employment position.
Example <g:job_function>Product Manager</g:job_function>
- * + * * Attribute of Jobs
- * + * * Content type string
- * + * * @return The functions of an employment position. */ public String[] getJobFunctions(); @@ -342,35 +342,35 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * * *
- * + * * job_industry
Details The industry of an employment position.
Example <g:job_industry>Government</g:job_industry>
Attribute of Jobs
- * + * * Content type string
- * + * * @param jobIndustries The industry of an employment position. */ public void setJobIndustries(String[] jobIndustries); @@ -380,35 +380,35 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * * - * + * * * * * * - * + * * * * * * - * + * * * * * *
- * + * * job_industry
Details The industry of an employment position.
Example <g:job_industry>Government</g:job_industry>
Attribute of Jobs
- * + * * Content type string
- * + * * @return The industry of an employment position. */ public String[] getJobIndustries(); @@ -418,35 +418,35 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
job_type
Details Type of employment position. Example: Full-time, part-time, contractor, etc.
Example <g:job_type>contractor</g:job_type>
Attribute of Jobs
- * + * * Content type string
- * + * * @param jobTypes Type of employment position. Example: Full-time, part-time, contractor, etc. */ public void setJobTypes(String[] jobTypes); @@ -456,35 +456,35 @@ public interface Job extends GlobalInterface { * * * - * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
job_type
Details Type of employment position. Example: Full-time, part-time, contractor, etc.
Example <g:job_type>contractor</g:job_type>
Attribute of Jobs
- * + * * Content type string
- * + * * @return Type of employment position. Example: Full-time, part-time, contractor, etc. */ public String[] getJobTypes(); @@ -494,43 +494,43 @@ public interface Job extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of the position. */ public void setLocation(String location); @@ -540,43 +540,43 @@ public interface Job extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of the position. */ public String getLocation(); @@ -588,36 +588,36 @@ public interface Job extends GlobalInterface { * * salary * - * + * * - * + * * Details * Salary for this position. Non-numeric values such as "$" symbols are not acceptable. * * - * + * * - * + * * Example * <g:salary>55000</g:salary> * * * - * + * * Attribute of - * + * * Jobs * * * Content type - * + * * - * + * * float * * * - * + * * @param salary Salary for this position. Non-numeric values such as "$" symbols are not acceptable. */ public void setSalary(Float salary); @@ -629,36 +629,36 @@ public interface Job extends GlobalInterface { * * salary * - * + * * - * + * * Details * Salary for this position. Non-numeric values such as "$" symbols are not acceptable. * * - * + * * - * + * * Example * <g:salary>55000</g:salary> * * * - * + * * Attribute of - * + * * Jobs * * * Content type - * + * * - * + * * float * * * - * + * * @return Salary for this position. Non-numeric values such as "$" symbols are not acceptable. */ public Float getSalary(); @@ -669,37 +669,37 @@ public interface Job extends GlobalInterface { * * * salary_type - * + * * - * + * * * Details * The type of salary included. Accepted values are �starting� or �negotiable;� The default is �starting at.� - * + * * * * - * + * * Example * <g:salary_type>negotiable</g:salary_type> * - * + * * * Attribute of - * + * * Jobs * * * - * + * * Content type * - * + * * "starting" or "negotiable" * * * - * + * * @param salaryType The type of salary included. */ public void setSalaryType(PriceTypeEnumeration salaryType); @@ -710,121 +710,121 @@ public interface Job extends GlobalInterface { * * * salary_type - * + * * - * + * * * Details * The type of salary included. Accepted values are �starting� or �negotiable;� The default is �starting at.� - * + * * * * - * + * * Example * <g:salary_type>negotiable</g:salary_type> * - * + * * * Attribute of - * + * * Jobs * * * - * + * * Content type * - * + * * "starting" or "negotiable" * * * - * + * * @return The type of salary included. */ public PriceTypeEnumeration getSalaryType(); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); 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 ae97f94..0a123c8 100644 --- a/src/main/java/org/rometools/feed/module/base/Person.java +++ b/src/main/java/org/rometools/feed/module/base/Person.java @@ -43,7 +43,7 @@ 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. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ @@ -58,29 +58,29 @@ public interface Person extends GlobalInterface { * * Details * Minimum age requirement for the event or the age of the individual in a People profiles bulk upload entry. - * + * * * * Example * Acceptable:
* < g:age>18</g:age>
* Not acceptable:
- * + * * < g:age>18 and over</g:age> * * * Attribute of * Events, People profiles - * + * * - * + * * * Content type * integer * * * - * + * * @param age Age of the individual. */ public void setAge(Integer age); @@ -95,29 +95,29 @@ public interface Person extends GlobalInterface { * * Details * Minimum age requirement for the event or the age of the individual in a People profiles bulk upload entry. - * + * * * * Example * Acceptable:
* < g:age>18</g:age>
* Not acceptable:
- * + * * < g:age>18 and over</g:age> * * * Attribute of * Events, People profiles - * + * * - * + * * * Content type * integer * * * - * + * * @return Age of the individual. */ public Integer getAge(); @@ -131,13 +131,13 @@ public interface Person extends GlobalInterface { * * * Details - * + * * Level of education required for an employment position. * * * Example * <g:education>PhD</g:education> - * + * * * * Attribute of @@ -145,12 +145,12 @@ public interface Person extends GlobalInterface { * * * Content type - * + * * string * * * - * + * * @param education Education of the individual. */ public void setEducation(String education); @@ -164,13 +164,13 @@ public interface Person extends GlobalInterface { * * * Details - * + * * Level of education required for an employment position. * * * Example * <g:education>PhD</g:education> - * + * * * * Attribute of @@ -178,24 +178,24 @@ public interface Person extends GlobalInterface { * * * Content type - * + * * string * * * - * + * * @return Education of the individual. */ public String getEducation(); /** * Individuals employer. - * + * * * * * - * + * * * * @@ -203,13 +203,13 @@ public interface Person extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -217,19 +217,19 @@ public interface Person extends GlobalInterface { * * *
employer
Details
Example<g:employer>Google, Inc</g:employer>
Attribute of Jobs
Content type
- * + * * @param employer Individuals employer. */ public void setEmployer(String employer); /** * Individuals employer. - * + * * * * * - * + * * * * @@ -237,13 +237,13 @@ public interface Person extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -251,14 +251,14 @@ public interface Person extends GlobalInterface { * * *
employer
Details
Example<g:employer>Google, Inc</g:employer>
Attribute of Jobs
Content type
- * + * * @return Individuals employer. */ public String getEmployer(); /** * Ethnicity of the individual in the People profiles bulk upload entry. - * + * * * * @@ -266,36 +266,36 @@ public interface Person extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
Details Ethnicity of the individual in the People profiles bulk upload entry.
Example<g:ethnicity>Latino</g:ethnicity>
Attribute of People profiles
Content type string
- * + * * @param ethnicities Ethnicity of the individual in the People profiles bulk upload entry. */ public void setEthnicities(String[] ethnicities); /** * Ethnicity of the individual in the People profiles bulk upload entry. - * + * * * * @@ -303,56 +303,56 @@ public interface Person extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
Details Ethnicity of the individual in the People profiles bulk upload entry.
Example<g:ethnicity>Latino</g:ethnicity>
Attribute of People profiles
Content type string
- * + * * @return Ethnicity of the individual in the People profiles bulk upload entry. */ public String[] getEthnicities(); /** * Gender of an individual in a People profiles bulk upload. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * * - * + * * * * @@ -360,34 +360,34 @@ public interface Person extends GlobalInterface { * * *
gender
Details Gender of an individual in a People profiles bulk upload item. Acceptable values are �Male�, �M�, �Female�, or �F�.
Example <gender>Female</gender>
Attribute of People profiles
Content type
- * + * * @param gender Gender of an individual in a People profiles bulk upload. */ public void setGender(GenderEnumeration gender); /** * Gender of an individual in a People profiles bulk upload. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * * - * + * * * * @@ -395,81 +395,81 @@ public interface Person extends GlobalInterface { * * *
gender
Details Gender of an individual in a People profiles bulk upload item. Acceptable values are �Male�, �M�, �Female�, or �F�.
Example <gender>Female</gender>
Attribute of People profiles
Content type
- * + * * @return Gender of an individual in a People profiles bulk upload. */ public GenderEnumeration getGender(); /** * Interest of a person being profiled. - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
interested_in
Details Interest of a person being profiled.
Example <g:interested_in>Long walks on the beach.</g:interested_in>
Attribute ofPeople profiles
Content type string
- * + * * @param interestedIn Interest of a person being profiled. */ public void setInterestedIn(String[] interestedIn); /** * Interest of a person being profiled. - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
interested_in
Details Interest of a person being profiled.
Example <g:interested_in>Long walks on the beach.</g:interested_in>
Attribute ofPeople profiles
Content type string
- * + * * @return Interest of a person being profiled. */ public String[] getInterestedIn(); @@ -479,43 +479,43 @@ public interface Person extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of a person. */ public void setLocation(String location); @@ -525,224 +525,224 @@ public interface Person extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of a person. */ public String getLocation(); /** * Marital status of an individual. - * + * * - * + * * * * * * * * - * + * * * * - * + * * * - * + * * * - * + * * * * * * * * *
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.�
Example <g:marital_status>single</g:marital_status>
- * + * *
Attribute of People profiles
- * + * * Content type - * + * * string
- * + * * @param maritalStatus Marital status of an individual. */ public void setMaritalStatus(String maritalStatus); /** * Marital status of an individual. - * + * * - * + * * * * * * * * - * + * * * * - * + * * * - * + * * * - * + * * * * * * * * *
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.�
Example <g:marital_status>single</g:marital_status>
- * + * *
Attribute of People profiles
- * + * * Content type - * + * * string
- * + * * @return Marital status of an individual. */ public String getMaritalStatus(); /** * Occupation of an individual. - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * * * * - * + * * * *
occupation
- * + * * Details Industry the individual in a People profiles bulk upload is employed in.
Example <g:occupation>Sales</g:occupation>
Attribute of - * + * * People profiles
- * + * * Content type string
- * + * * @param occupation Occupation of an individual. */ public void setOccupation(String occupation); /** * Occupation of an individual. - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * * * * - * + * * * *
occupation
- * + * * Details Industry the individual in a People profiles bulk upload is employed in.
Example <g:occupation>Sales</g:occupation>
Attribute of - * + * * People profiles
- * + * * Content type string
- * + * * @return Occupation of an individual. */ public String getOccupation(); /** * Individual's sexual orientation. - * + * * * * @@ -750,39 +750,39 @@ public interface Person extends GlobalInterface { * * * - * + * * * * * - * + * * - * + * * * * * * * - * + * * * - * + * * * *
- * + * * Details Sexual orientation of an individual in a People profiles information type..
Example <g:sexual_orientation>straight</g:sexual_orientation>
Attribute of - * + * * Personal
Content type string
- * + * * @param sexualOrientation Individual's sexual orientation. */ public void setSexualOrientation(String sexualOrientation); /** * Individual's sexual orientation. - * + * * * * @@ -790,32 +790,32 @@ public interface Person extends GlobalInterface { * * * - * + * * * * * - * + * * - * + * * * * * * * - * + * * * - * + * * * *
- * + * * Details Sexual orientation of an individual in a People profiles information type..
Example <g:sexual_orientation>straight</g:sexual_orientation>
Attribute of - * + * * Personal
Content type string
- * + * * @return Individual's sexual orientation. */ public String getSexualOrientation(); 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 4ef0550..f7eca30 100644 --- a/src/main/java/org/rometools/feed/module/base/Product.java +++ b/src/main/java/org/rometools/feed/module/base/Product.java @@ -48,7 +48,7 @@ import org.rometools.feed.module.base.types.Size; /** * This is an interface for the GoogleBase plug in that exposes methods used for Products. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -56,27 +56,27 @@ public interface Product extends GlobalInterface { /** * Actor featured in the video. * - * + * * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * @@ -84,7 +84,7 @@ public interface Product extends GlobalInterface { * * *
actor
DetailsActor featured in the video.
Example<g:actor>Charlie Chaplin</g:actor>
Attribute ofProducts
Content type
- * + * * @param actors Actor featured in the video. */ public void setActors(String[] actors); @@ -92,27 +92,27 @@ public interface Product extends GlobalInterface { /** * Actor featured in the video. * - * + * * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * @@ -120,81 +120,81 @@ public interface Product extends GlobalInterface { * * *
actor
DetailsActor featured in the video.
Example<g:actor>Charlie Chaplin</g:actor>
Attribute ofProducts
Content type
- * + * * @return Actor featured in the video. */ public String[] getActors(); /** * The type of apparel being offered.
- * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * * - * + * * * * *
apparel_type
Details The type of apparel being offered. Skirt, pants, sleepwear, etc.
Example<g:apparel_type>sweater</g:apparel_type>
Attribute ofProducts
Content typestring
- * + * * @param apparelType The type of apparel being offered. */ public void setApparelType(String apparelType); /** * The type of apparel being offered.
- * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * * - * + * * * * *
apparel_type
Details The type of apparel being offered. Skirt, pants, sleepwear, etc.
Example<g:apparel_type>sweater</g:apparel_type>
Attribute ofProducts
Content typestring
- * + * * @return The type of apparel being offered. */ public String getApparelType(); @@ -205,34 +205,34 @@ public interface Product extends GlobalInterface { * * * artist - * + * * * * Details - * + * * Artist that created the work. * - * + * * * Example * <g:artist>Vincent van Gogh</g:artist> - * + * * * - * + * * Attribute of * Products * * - * + * * - * + * * Content type * string * * * - * + * * @param artists Artist that created the work. */ public void setArtists(String[] artists); @@ -243,106 +243,106 @@ public interface Product extends GlobalInterface { * * * artist - * + * * * * Details - * + * * Artist that created the work. * - * + * * * Example * <g:artist>Vincent van Gogh</g:artist> - * + * * * - * + * * Attribute of * Products * * - * + * * - * + * * Content type * string * * * - * + * * @return Artist that created the work. */ public String[] getArtists(); /** * Author of the item. - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @param authors Author of the item. */ public void setAuthors(String[] authors); /** * Author of the item. - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @return Author of the item. */ public String[] getAuthors(); @@ -356,27 +356,27 @@ public interface Product extends GlobalInterface { * * * Details - * + * * The brand name of an item. * * * Example * <g:brand>Acme</g:brand> - * + * * * * Attribute of * Products * * - * + * * Content type - * + * * string * * * - * + * * @param brand The brand name of an item. */ public void setBrand(String brand); @@ -390,274 +390,274 @@ public interface Product extends GlobalInterface { * * * Details - * + * * The brand name of an item. * * * Example * <g:brand>Acme</g:brand> - * + * * * * Attribute of * Products * * - * + * * Content type - * + * * string * * * - * + * * @return The brand name of an item. */ public String getBrand(); /** * Color of an item. - * + * * - * + * * * * - * + * * * * - * + * * * * - * + * * * - * + * * * * * * - * + * * * - * + * * * * *
color
Details Color of an item.
Example <g:color>Black</g:color>
- * + * * Attribute of Products, Vehicles
Content type string
- * + * * @param color Color of an item. */ public void setColors(String[] color); /** * Color of an item. - * + * * - * + * * * * - * + * * * * - * + * * * * - * + * * * - * + * * * * * * - * + * * * - * + * * * * *
color
Details Color of an item.
Example <g:color>Black</g:color>
- * + * * Attribute of Products, Vehicles
Content type string
- * + * * @return Color of an item. */ public String[] getColors(); /** * Condition of the item. For example: new, used, or refurbished. - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
condition
DetailsCondition of the item. For example: new, used, or refurbished.
Example * <g:condition>refurbished</g:condition>
Attribute ofProducts, Vehicles
Content typestring
- * + * * @param condition Condition of the item. For example: new, used, or refurbished. */ public void setCondition(String condition); /** * Condition of the item. For example: new, used, or refurbished. - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
condition
DetailsCondition of the item. For example: new, used, or refurbished.
Example * <g:condition>refurbished</g:condition>
Attribute ofProducts, Vehicles
Content typestring
- * + * * @return Condition of the item. For example: new, used, or refurbished. */ public String getCondition(); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -665,16 +665,16 @@ public interface Product extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -683,12 +683,12 @@ public interface Product extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public void setDeliveryNotes(String deliveryNotes); @@ -702,16 +702,16 @@ public interface Product extends GlobalInterface { * * * Details - * + * * Additional instructions to explain the item�s delivery process. * * * Example * * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * * - * + * * * * Attribute of @@ -720,12 +720,12 @@ public interface Product extends GlobalInterface { * * * Content type - * + * * string * * * - * + * * @return Additional instructions to explain the item�s delivery process. */ public String getDeliveryNotes(); @@ -736,7 +736,7 @@ public interface Product extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -744,14 +744,14 @@ public interface Product extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -759,10 +759,10 @@ public interface Product extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public void setDeliveryRadius(FloatUnit deliveryRadius); @@ -773,7 +773,7 @@ public interface Product extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -781,14 +781,14 @@ public interface Product extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -796,10 +796,10 @@ public interface Product extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); @@ -813,30 +813,30 @@ public interface Product extends GlobalInterface { * * * Details - * + * * Format of the content. - * + * * * * Example * <g:format>DVD</g:format>
- * + * * <g:format>CD</g:format> - * + * * * * Attribute of * Products - * + * * * * Content type - * + * * string * * * - * + * * @param format Format of the content. */ public void setFormat(String[] format); @@ -850,30 +850,30 @@ public interface Product extends GlobalInterface { * * * Details - * + * * Format of the content. - * + * * * * Example * <g:format>DVD</g:format>
- * + * * <g:format>CD</g:format> - * + * * * * Attribute of * Products - * + * * * * Content type - * + * * string * * * - * + * * @return Format of the content. */ public String[] getFormat(); @@ -887,28 +887,28 @@ public interface Product extends GlobalInterface { * * * Details - * + * * A unique 10 or 13 digit number assigned to every printed book. * - * + * * * Example * <g:isbn>0451524233</g:isbn> * - * + * * * Attribute of * Products - * + * * * * Content type * string - * + * * * * - * + * * @param isbn A unique 10 or 13 digit number assigned to every printed book. */ public void setIsbn(String isbn); @@ -922,28 +922,28 @@ public interface Product extends GlobalInterface { * * * Details - * + * * A unique 10 or 13 digit number assigned to every printed book. * - * + * * * Example * <g:isbn>0451524233</g:isbn> * - * + * * * Attribute of * Products - * + * * * * Content type * string - * + * * * * - * + * * @return A unique 10 or 13 digit number assigned to every printed book. */ public String getIsbn(); @@ -953,43 +953,43 @@ public interface Product extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of a property. Should include street, city, state, postal code, and country, in that order. */ public void setLocation(String location); @@ -999,43 +999,43 @@ public interface Product extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of a property. Should include street, city, state, postal code, and country, in that order. */ public String getLocation(); @@ -1043,46 +1043,46 @@ public interface Product extends GlobalInterface { /** * Company that manufactures the item. * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * - * + * * * * * - * + * * * * * *
* manufacturer
* Details - * + * * Company that manufactures the item.
* Example * <g:manufacturer>Acme, Inc</g:manufacturer>
* Attribute of * Products
- * + * * Content type * string
- * + * * @param manufacturer Company that manufactures the item. */ public void setManufacturer(String manufacturer); @@ -1090,55 +1090,55 @@ public interface Product extends GlobalInterface { /** * Company that manufactures the item. * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * - * + * * * * * - * + * * * * * *
* manufacturer
* Details - * + * * Company that manufactures the item.
* Example * <g:manufacturer>Acme, Inc</g:manufacturer>
* Attribute of * Products
- * + * * Content type * string
- * + * * @return Company that manufactures the item. */ public String getManufacturer(); /** * Unique product ID code assigned by its manufacturer. - * + * * - * + * * * * @@ -1146,36 +1146,36 @@ public interface Product extends GlobalInterface { * * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
manufacturer_id
Details - * + * * Unique product ID code assigned by its manufacturer.
Example <g:manufacturer_id>030779A</g:manufacturer_id>
Attribute of Products
Content type string
- * + * * @param manufacturerId Unique product ID code assigned by its manufacturer. */ public void setManufacturerId(String manufacturerId); /** * Unique product ID code assigned by its manufacturer. - * + * * - * + * * * * @@ -1183,27 +1183,27 @@ public interface Product extends GlobalInterface { * * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
manufacturer_id
Details - * + * * Unique product ID code assigned by its manufacturer.
Example <g:manufacturer_id>030779A</g:manufacturer_id>
Attribute of Products
Content type string
- * + * * @return Unique product ID code assigned by its manufacturer. */ public String getManufacturerId(); @@ -1214,36 +1214,36 @@ public interface Product extends GlobalInterface { * * * - * + * * megapixels - * + * * * * Details * Resolution of a digital imaging device. - * + * * - * + * * * Example * <g:megapixels>5.2 MP</g:megapixels> * - * + * * - * + * * Attribute of * Products * * * - * + * * Content type - * + * * floatUnit * * * - * + * * @param megapixels Resolution of a digital imaging device. */ public void setMegapixels(FloatUnit megapixels); @@ -1254,36 +1254,36 @@ public interface Product extends GlobalInterface { * * * - * + * * megapixels - * + * * * * Details * Resolution of a digital imaging device. - * + * * - * + * * * Example * <g:megapixels>5.2 MP</g:megapixels> * - * + * * - * + * * Attribute of * Products * * * - * + * * Content type - * + * * floatUnit * * * - * + * * @return Resolution of a digital imaging device. */ public FloatUnit getMegapixels(); @@ -1294,35 +1294,35 @@ public interface Product extends GlobalInterface { * * * memory - * + * * * * Details * The amount of memory included in an item. * - * + * * - * + * * Example * <g:memory>128 MB</g:memory> * * - * + * * - * + * * Attribute of * Products * * * - * + * * Content type - * + * * floatUnit * * * - * + * * @param memory The amount of memory included in an item. */ public void setMemory(FloatUnit memory); @@ -1333,120 +1333,120 @@ public interface Product extends GlobalInterface { * * * memory - * + * * * * Details * The amount of memory included in an item. * - * + * * - * + * * Example * <g:memory>128 MB</g:memory> * * - * + * * - * + * * Attribute of * Products * * * - * + * * Content type - * + * * floatUnit * * * - * + * * @return The amount of memory included in an item. */ public FloatUnit getMemory(); /** * Model number of the product. - * + * * - * + * * * - * + * * * * * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
model_number
Details - * + * * Model number of the product.
Example <g:model_number>1924863</g:model_number>
Attribute of Products
Content type string
- * + * * @param modelNumber Model number of the product. */ public void setModelNumber(String modelNumber); /** * Model number of the product. - * + * * - * + * * * - * + * * * * * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
model_number
Details - * + * * Model number of the product.
Example <g:model_number>1924863</g:model_number>
Attribute of Products
Content type string
- * + * * @return Model number of the product. */ public String getModelNumber(); /** * Acceptable payment methods for item purchases. - * + * * - * + * * * * @@ -1454,45 +1454,45 @@ public interface Product extends GlobalInterface { * * * - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type - * + * * paymentMethodEnumeration
- * + * * @param paymentAccepted Acceptable payment methods for item purchases. */ public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); /** * Acceptable payment methods for item purchases. - * + * * - * + * * * * @@ -1500,458 +1500,458 @@ public interface Product extends GlobalInterface { * * * - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type - * + * * paymentMethodEnumeration
- * + * * @return Acceptable payment methods for item purchases. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * Additional instructions to explain a payment policy. - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * - * + * * * * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
- * + * * Content type string
- * + * * @param paymentNotes Additional instructions to explain a payment policy. */ public void setPaymentNotes(String paymentNotes); /** * Additional instructions to explain a payment policy. - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * - * + * * * * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
- * + * * Content type string
- * + * * @return Additional instructions to explain a payment policy. */ public String getPaymentNotes(); /** * Whether or not an item is available for pick up. - * + * * - * + * * * * * * - * + * * - * + * * * * * - * + * * * - * + * * - * + * * * * * * * * * *
pickup
Details Information about whether or not an item is available for pick up. Acceptable values are "True and "False".
Example - * + * * Acceptable:
* <g:pickup>True</g:pickup>
* Not acceptable:
* <g:pickup>Not on Tuesdays</g:pickup>
Attribute of Products
- * + * * Content type boolean
- * + * * @param pickup Whether or not an item is available for pick up. */ public void setPickup(Boolean pickup); /** * Whether or not an item is available for pick up. - * + * * - * + * * * * * * - * + * * - * + * * * * * - * + * * * - * + * * - * + * * * * * * * * * *
pickup
Details Information about whether or not an item is available for pick up. Acceptable values are "True and "False".
Example - * + * * Acceptable:
* <g:pickup>True</g:pickup>
* Not acceptable:
* <g:pickup>Not on Tuesdays</g:pickup>
Attribute of Products
- * + * * Content type boolean
- * + * * @return Whether or not an item is available for pick up. */ public Boolean getPickup(); /** * Price of the item. - * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 – 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @param price Price of the item. */ public void setPrice(FloatUnit price); /** * Price of the item. - * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 – 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @return Price of the item. */ public FloatUnit getPrice(); /** * The type of pricing for the item. - * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @param priceType The type of pricing for the item. */ public void setPriceType(PriceTypeEnumeration priceType); /** * The type of pricing for the item. - * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @return The type of pricing for the item. */ public PriceTypeEnumeration getPriceType(); /** * The processor speed for the product. - * - * + * + * * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * * *
- * + * * processor_speed
Details The processor speed for the product.
Example <g:processor_speed>2</g:processor_speed>
Attribute of Products
Content type floatUnit
- * + * * @param processorSpeed The processor speed for the product. */ public void setProcessorSpeed(FloatUnit processorSpeed); /** * The processor speed for the product. - * - * + * + * * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * * *
- * + * * processor_speed
Details The processor speed for the product.
Example <g:processor_speed>2</g:processor_speed>
Attribute of Products
Content type floatUnit
- * + * * @return The processor speed for the product. */ public FloatUnit getProcessorSpeed(); @@ -1959,36 +1959,36 @@ public interface Product extends GlobalInterface { /** * The type of product being offered. * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
product_type
Details - * + * * The type of product being offered. Toys, books, flowers, etc.
Example <g:product_type>electronics</g:product_type>
Attribute of Products
Content type string
- * + * * @param productTypes The type of product being offered. */ public void setProductTypes(String[] productTypes); @@ -1996,662 +1996,662 @@ public interface Product extends GlobalInterface { /** * The type of product being offered. * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
product_type
Details - * + * * The type of product being offered. Toys, books, flowers, etc.
Example <g:product_type>electronics</g:product_type>
Attribute of Products
Content type string
- * + * * @return The type of product being offered. */ public String[] getProductTypes(); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @param quantity Quantity available. */ public void setQuantity(Integer quantity); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @return Quantity available. */ public Integer getQuantity(); /** * Shipping options available for an item. - * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @param shipping Shipping options available for an item. */ public void setShipping(ShippingType[] shipping); /** * Shipping options available for an item. - * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @return Shipping options available for an item. */ public ShippingType[] getShipping(); /** * Dimensions of the item, expressed in either two or three dimensions. - * - * + * + * * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * * * * - * + * * - * + * * * * *
size
Details Dimensions of the item, expressed in either two or three dimensions.
Example <g:size>12x10x4</g:size>
- * + * * Attribute of Products
Content type string
- * + * * @param size Dimensions of the item, expressed in either two or three dimensions. */ public void setSize(Size size); /** * Dimensions of the item, expressed in either two or three dimensions. - * - * + * + * * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * * * * - * + * * - * + * * * * *
size
Details Dimensions of the item, expressed in either two or three dimensions.
Example <g:size>12x10x4</g:size>
- * + * * Attribute of Products
Content type string
- * + * * @return Dimensions of the item, expressed in either two or three dimensions. */ public Size getSize(); /** * Tax rate associated with the event. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @param taxPercent Tax rate associated with the event. */ public void setTaxPercent(Float taxPercent); /** * Tax rate associated with the event. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @return Tax rate associated with the event. */ public Float getTaxPercent(); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @param taxRegion Region where tax applies. */ public void setTaxRegion(String taxRegion); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @return Region where tax applies. */ public String getTaxRegion(); /** * Product UPC code (Isn't that redundant?). - * - * - * + * + * + * * - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
- * + * * upc
Details Product UPC code.
Example <g:upc>834721479305</g:upc>
Attribute of Products
- * + * * Content type string
- * + * * @param upc Product UPC code (Isn't that redundant?). */ public void setUpc(String upc); /** * Product UPC code (Isn't that redundant?). - * - * - * + * + * + * * - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
- * + * * upc
Details Product UPC code.
Example <g:upc>834721479305</g:upc>
Attribute of Products
- * + * * Content type string
- * + * * @return Product UPC code (Isn't that redundant?). */ public String getUpc(); /** * Weight of the item. - * + * * - * + * * * - * - * + * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
weight
Details Weight of the item.
Example <g:weight>5</g:weight>
Attribute of Products
- * + * * Content type floatUnit
- * + * * @param weight Weight of the item. */ public void setWeight(FloatUnit weight); /** * Weight of the item. - * + * * - * + * * * - * - * + * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * * * * * *
weight
Details Weight of the item.
Example <g:weight>5</g:weight>
Attribute of Products
- * + * * Content type floatUnit
- * + * * @return Weight of the item. */ public FloatUnit getWeight(); 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 19e75bf..b17d41a 100644 --- a/src/main/java/org/rometools/feed/module/base/Review.java +++ b/src/main/java/org/rometools/feed/module/base/Review.java @@ -46,88 +46,88 @@ 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. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public interface Review extends GlobalInterface { /** * Author of the item. - * - * + * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @param authors Author of the item. */ public void setAuthors(String[] authors); /** * Author of the item. - * - * + * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @return Author of the item. */ public String[] getAuthors(); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -135,16 +135,16 @@ public interface Review extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -153,19 +153,19 @@ public interface Review extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public void setDeliveryNotes(String deliveryNotes); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -173,16 +173,16 @@ public interface Review extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -191,12 +191,12 @@ public interface Review extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); @@ -207,7 +207,7 @@ public interface Review extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -215,14 +215,14 @@ public interface Review extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -230,10 +230,10 @@ public interface Review extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public void setDeliveryRadius(FloatUnit deliveryRadius); @@ -244,7 +244,7 @@ public interface Review extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -252,14 +252,14 @@ public interface Review extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -267,168 +267,168 @@ public interface Review extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); /** * The name of an item being reviewed. - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * * - * + * * * * * *
name_of_item_being_reviewed
Details - * + * * The name of an item being reviewed.
Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed>
Attribute of Reviews
Content type string
- * + * * @param nameOfItemBeingReviewed The name of an item being reviewed. */ public void setNameOfItemBeingReviewed(String nameOfItemBeingReviewed); /** * The name of an item being reviewed. - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * * - * + * * * * * *
name_of_item_being_reviewed
Details - * + * * The name of an item being reviewed.
Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed>
Attribute of Reviews
Content type string
- * + * * @return The name of an item being reviewed. */ public String getNameOfItemBeingReviewed(); /** * Date the item was published. - * + * * * * * - * + * * * * - * + * * - * + * * * * - * + * * * - * + * * * * * * * * - * + * * * *
publish_date
Details Date the item was published in ISO 8601 format: * YYYY-MM-DD
Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of - * + * * Reference Items
- * + * * Content type date
- * + * * @param publishDate Date the item was published. */ public void setPublishDate(Date publishDate); /** * Date the item was published. - * + * * * * * - * + * * * * - * + * * - * + * * * * - * + * * * - * + * * * * * * * * - * + * * * *
publish_date
Details Date the item was published in ISO 8601 format: * YYYY-MM-DD
Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of - * + * * Reference Items
- * + * * Content type date
- * + * * @return Date the item was published. */ public Date getPublishDate(); @@ -439,38 +439,38 @@ public interface Review extends GlobalInterface { * * * rating - * + * * * * Details * Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only. * - * + * * - * + * * Example * Acceptable:
* <g:rating>4</g:rating>
- * + * * Not acceptable:
- * + * * <g:rating>good</g:rating> * * * Attribute of - * + * * Reviews - * + * * * * Content type * - * + * * string * * * - * + * * @param rating Rating of the product or service on a scale of 1-5, with 5 as the best. */ public void setRating(Float rating); @@ -481,45 +481,45 @@ public interface Review extends GlobalInterface { * * * rating - * + * * * * Details * Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only. * - * + * * - * + * * Example * Acceptable:
* <g:rating>4</g:rating>
- * + * * Not acceptable:
- * + * * <g:rating>good</g:rating> * * * Attribute of - * + * * Reviews - * + * * * * Content type * - * + * * string * * * - * + * * @return Rating of the product or service on a scale of 1-5, with 5 as the best. */ public Float getRating(); /** * The category of the item being reviewed. - * + * * * * @@ -527,41 +527,41 @@ public interface Review extends GlobalInterface { * * * - * + * * * * * - * + * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
- * + * * Details The category of the item being reviewed.
Example <g:review_type>toy</g:review_type>
- * + * * <g:review_type>music</g:review_type>
* <g:review_type>restaraunt</g:review_type>
Attribute of Reviews
Content type string
- * + * * @param reviewType The category of the item being reviewed. */ public void setReviewType(String reviewType); /** * The category of the item being reviewed. - * + * * * * @@ -569,34 +569,34 @@ public interface Review extends GlobalInterface { * * * - * + * * * * * - * + * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
- * + * * Details The category of the item being reviewed.
Example <g:review_type>toy</g:review_type>
- * + * * <g:review_type>music</g:review_type>
* <g:review_type>restaraunt</g:review_type>
Attribute of Reviews
Content type string
- * + * * @return The category of the item being reviewed. */ public String getReviewType(); @@ -609,33 +609,33 @@ public interface Review extends GlobalInterface { * 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) * * * - * + * * Example * <g:reviewer_type>editorial</g:reviewer_type> - * + * * * * Attribute of - * + * * Reviews * - * + * * * Content type * string - * + * * * * - * + * * @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). */ @@ -649,117 +649,117 @@ public interface Review extends GlobalInterface { * 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) * * * - * + * * Example * <g:reviewer_type>editorial</g:reviewer_type> - * + * * * * Attribute of - * + * * Reviews * - * + * * * Content type * string - * + * * * * - * + * * @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(); /** * The web page of an item being reviewed. - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * * * * * - * + * * *
url_of_item_being_reviewed
- * + * * Details The web page of an item being reviewed.
Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed>
Attribute of - * + * * Reviews
- * + * * Content type uri
- * + * * @param urlOfItemBeingReviewed The web page of an item being reviewed. */ public void setUrlOfItemBeingReviewed(URL urlOfItemBeingReviewed); /** * The web page of an item being reviewed. - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * * * * * - * + * * *
url_of_item_being_reviewed
- * + * * Details The web page of an item being reviewed.
Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed>
Attribute of - * + * * Reviews
- * + * * Content type uri
- * + * * @return The web page of an item being reviewed. */ public URL getUrlOfItemBeingReviewed(); 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 d624039..6c87274 100644 --- a/src/main/java/org/rometools/feed/module/base/ScholarlyArticle.java +++ b/src/main/java/org/rometools/feed/module/base/ScholarlyArticle.java @@ -43,7 +43,7 @@ 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. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ @@ -51,34 +51,34 @@ public interface ScholarlyArticle extends GlobalInterface { /** * Array of Author Names. Limit 10. * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @param authors Array of Author Names. Limit 10. */ public void setAuthors(String[] authors); @@ -86,198 +86,198 @@ public interface ScholarlyArticle extends GlobalInterface { /** * Array of Author Names. Limit 10. * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string
- * + * * @return Array of author names. */ public String[] getAuthors(); /** * Number of pages in the article. - * + * * - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * * * *
pages
Details - * + * * The number of pages in the publication.
Example <g:pages>18</g:pages>
Attribute of Reference Items, News and Articles
- * + * * Content type integer
- * + * * @param pages Number of pages in the article */ public void setPages(Integer pages); /** * Number of pages in the article. - * + * * - * + * * * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * * * *
pages
Details - * + * * The number of pages in the publication.
Example <g:pages>18</g:pages>
Attribute of Reference Items, News and Articles
- * + * * Content type integer
- * + * * @return Number of pages in the article */ public Integer getPages(); /** * Name of the publication. - * + * * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * - * + * * * * * - * + * * * * * *
publication_name
Details - * + * * Name of the publication.
Example <g:publication_name> Journal of Appropriate Technology</g:publication_name>
Attribute of Research studies and publications
- * + * * Content type string
- * + * * @param publicationName Name of the publication. */ public void setPublicationName(String publicationName); /** * Name of the publication. - * + * * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * - * + * * * * * - * + * * * * * *
publication_name
Details - * + * * Name of the publication.
Example <g:publication_name> Journal of Appropriate Technology</g:publication_name>
Attribute of Research studies and publications
- * + * * Content type string
- * + * * @return Name of the publication. */ public String getPublicationName(); @@ -287,35 +287,35 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * *
publication_volume
Details - * + * * Volume of the publication.
Example<g:publication_volume>VI</g:publication_volume>
Attribute of Reference Items
Content type string
- * + * * @param publicationVolume Volume of the publication. */ public void setPublicationVolume(String publicationVolume); @@ -325,123 +325,123 @@ public interface ScholarlyArticle extends GlobalInterface { * * * - * + * * * * * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * *
publication_volume
Details - * + * * Volume of the publication.
Example<g:publication_volume>VI</g:publication_volume>
Attribute of Reference Items
Content type string
- * + * * @return Volume of the publication. */ public String getPublicationVolume(); /** * Date article was published. - * + * * * * * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * * * * * * *
publish_date
- * + * * Details Date the item was published in ISO 8601 format: * YYYY-MM-DD
- * + * * Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of Reference Items
- * + * * Content type - * + * * date
- * + * * @param publishDate Date article was published */ public void setPublishDate(Date publishDate); /** * Date article was published. - * + * * * * * - * + * * * * * - * + * * * * * * - * + * * * - * + * * * * * * * * *
publish_date
- * + * * Details Date the item was published in ISO 8601 format: * YYYY-MM-DD
- * + * * Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of Reference Items
- * + * * Content type - * + * * date
- * + * * @return Date article was published */ public Date getPublishDate(); 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 4f0a629..a540504 100644 --- a/src/main/java/org/rometools/feed/module/base/Service.java +++ b/src/main/java/org/rometools/feed/module/base/Service.java @@ -47,98 +47,98 @@ import org.rometools.feed.module.base.types.ShippingType; /** * This is an interface for the GoogleBase plug in that exposes methods used for service offerings. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public interface Service extends GlobalInterface { /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -146,16 +146,16 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -164,19 +164,19 @@ public interface Service extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public void setDeliveryNotes(String deliveryNotes); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -184,16 +184,16 @@ public interface Service extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -202,12 +202,12 @@ public interface Service extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); @@ -218,7 +218,7 @@ public interface Service extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -226,14 +226,14 @@ public interface Service extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -241,10 +241,10 @@ public interface Service extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public void setDeliveryRadius(FloatUnit deliveryRadius); @@ -255,7 +255,7 @@ public interface Service extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -263,14 +263,14 @@ public interface Service extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -278,10 +278,10 @@ public interface Service extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); @@ -291,43 +291,43 @@ public interface Service extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of the where the service is offered. */ public void setLocation(String location); @@ -337,52 +337,52 @@ public interface Service extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of the where the service is offered. */ public String getLocation(); /** * Payment Methods acceptable for the service. - * + * * - * + * * * * @@ -390,47 +390,47 @@ public interface Service extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @param paymentAccepted Payment Methods acceptable for the service. */ public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); /** * Payment Methods acceptable for the service. - * + * * - * + * * * * @@ -438,744 +438,744 @@ public interface Service extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @return Payment Methods acceptable for the service. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * Additional payment information. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * + * * @param paymentNotes Additional payment information. */ public void setPaymentNotes(String paymentNotes); /** * Additional payment information. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * + * * @return Additional payment information. */ public String getPaymentNotes(); /** * Price for the service.
- * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 � 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @param price Price for the service. */ public void setPrice(FloatUnit price); /** * Price for the service.
- * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 � 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @return Price for the service. */ public FloatUnit getPrice(); /** * Price type information. - * - * + * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @param priceType Price type information. */ public void setPriceType(PriceTypeEnumeration priceType); /** * Price type information. - * - * + * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @return Price type information. */ public PriceTypeEnumeration getPriceType(); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @param quantity Quantity available. */ public void setQuantity(Integer quantity); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @return Quantity available. */ public Integer getQuantity(); /** * The type of service being offered. - * - * + * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
service_type
Details The type of service being offered. Web hosting, legal, gardening, etc.
Example <g:service_type>consulting</g:service_type>
Attribute of Housing
Content type string
- * + * * @param serviceType The type of service being offered. */ public void setServiceType(String serviceType); /** * The type of service being offered. - * - * + * + * * - * + * * * * * * * - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * *
service_type
Details The type of service being offered. Web hosting, legal, gardening, etc.
Example <g:service_type>consulting</g:service_type>
Attribute of Housing
Content type string
- * + * * @return The type of service being offered. */ public String getServiceType(); /** * Shipping options available for an item. - * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @param shipping Shipping options available for an item. */ public void setShipping(ShippingType[] shipping); /** * Shipping options available for an item. - * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @return Shipping options available for an item. */ public ShippingType[] getShipping(); /** * Tax rate associated with the item. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @param taxPercent Tax rate associated with the event. */ public void setTaxPercent(Float taxPercent); /** * Tax rate associated with the service. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @return Tax rate associated with the event. */ public Float getTaxPercent(); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @param taxRegion Region where tax applies. */ public void setTaxRegion(String taxRegion); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @return Region where tax applies. */ public String getTaxRegion(); 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 6df019e..df9b52c 100644 --- a/src/main/java/org/rometools/feed/module/base/Travel.java +++ b/src/main/java/org/rometools/feed/module/base/Travel.java @@ -48,98 +48,98 @@ import org.rometools.feed.module.base.types.ShippingType; /** * This is an interface for the GoogleBase plug in that exposes methods used for travel items. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public interface Travel extends GlobalInterface { /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -147,16 +147,16 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -165,19 +165,19 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public void setDeliveryNotes(String deliveryNotes); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -185,16 +185,16 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -203,12 +203,12 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); @@ -219,7 +219,7 @@ public interface Travel extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -227,14 +227,14 @@ public interface Travel extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -242,10 +242,10 @@ public interface Travel extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public void setDeliveryRadius(FloatUnit deliveryRadius); @@ -256,7 +256,7 @@ public interface Travel extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -264,14 +264,14 @@ public interface Travel extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -279,109 +279,109 @@ public interface Travel extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); /** * Starting city and state/country of the trip. - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
from_location
Details Starting city and state/country of the trip.
Example Acceptable:
* <g:from_location>San Francisco, CA</g:from_location>
- * + * * <g:from_location>Paris, France</g:from_location>
- * + * * Not acceptable:
* <g:from_location> San Francisco International * Airport</g:from_location>
Attribute of Travel
Content type location
- * + * * @param fromLocation Starting city and state/country of the trip. */ public void setFromLocation(String fromLocation); /** * Starting city and state/country of the trip. - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * - * + * * * * * - * + * * * - * + * * *
from_location
Details Starting city and state/country of the trip.
Example Acceptable:
* <g:from_location>San Francisco, CA</g:from_location>
- * + * * <g:from_location>Paris, France</g:from_location>
- * + * * Not acceptable:
* <g:from_location> San Francisco International * Airport</g:from_location>
Attribute of Travel
Content type location
- * + * * @return Starting city and state/country of the trip. */ public String getFromLocation(); /** * Acceptable payment methods for item purchases. - * + * * - * + * * * * @@ -389,45 +389,45 @@ public interface Travel extends GlobalInterface { * * * - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type - * + * * paymentMethodEnumeration
- * + * * @param paymentAccepted Acceptable payment methods for item purchases. */ public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); /** * Acceptable payment methods for item purchases. - * + * * - * + * * * * @@ -435,625 +435,625 @@ public interface Travel extends GlobalInterface { * * * - * + * * - * + * * * * * * * - * + * * * * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type - * + * * paymentMethodEnumeration
- * + * * @return Acceptable payment methods for item purchases. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * Additional instructions to explain a payment policy. - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * - * + * * * * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
- * + * * Content type string
- * + * * @param paymentNotes Additional instructions to explain a payment policy. */ public void setPaymentNotes(String paymentNotes); /** * Additional instructions to explain a payment policy. - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * - * + * * * * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
- * + * * Content type string
- * + * * @return Additional instructions to explain a payment policy. */ public String getPaymentNotes(); /** * Price of the item. - * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 – 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @return Price of the item. */ public FloatUnit getPrice(); /** * The type of pricing for the item. - * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @param priceType The type of pricing for the item. */ public void setPriceType(PriceTypeEnumeration priceType); /** * The type of pricing for the item. - * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @return The type of pricing for the item. */ public PriceTypeEnumeration getPriceType(); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @param quantity Quantity available. */ public void setQuantity(Integer quantity); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @return Quantity available. */ public Integer getQuantity(); /** * Tax rate associated with the event. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @param taxPercent Tax rate associated with the event. */ public void setTaxPercent(Float taxPercent); /** * Tax rate associated with the service. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @return Tax rate associated with the event. */ public Float getTaxPercent(); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @param taxRegion Region where tax applies. */ public void setTaxRegion(String taxRegion); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @return Region where tax applies. */ public String getTaxRegion(); /** * Destination city and state/country of the trip. - * - * + * + * * * * * * - * + * * * * * * * - * + * * * * * * * * * - * + * * * * *
to_location
- * + * * Details Destination city and state/country of the trip.
- * + * * Example Acceptable:
* <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 * Airport</g:to_location>
- * + * * Attribute of Travel
Content type locationyTpe
- * + * * @param toLocation Destination city and state/country of the trip. */ public void setToLocation(String toLocation); /** * Destination city and state/country of the trip. - * - * + * + * * * * * * - * + * * * * * * * - * + * * * * * * * * * - * + * * * * *
to_location
- * + * * Details Destination city and state/country of the trip.
- * + * * Example Acceptable:
* <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 * Airport</g:to_location>
- * + * * Attribute of Travel
Content type locationyTpe
- * + * * @return Destination city and state/country of the trip. */ public String getToLocation(); /** * Departure date and time of the trip. - * + * * * * * - * + * * * * * * * * * - * + * * * * * * - * + * * * * *
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. *
    - * + * *
  • start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • *
  • end = End date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • *
@@ -1062,47 +1062,47 @@ public interface Travel extends GlobalInterface { *
Example <g:travel_date_range>
- * + * * <g:start>2005-12-20T06:00:00</g:start>
* <g:end>2005-12-29T13:00:00</g:end>
* </g:travel_date_range>
- * + * * Attribute of Travel
- * + * * Content type dateTimeRange
- * + * * @param travelDateRange Departure date and time of the trip. */ public void setTravelDateRange(DateTimeRange travelDateRange); /** * Departure date and time of the trip. - * + * * * * * - * + * * * * * * * * * - * + * * * * * * - * + * * * * *
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. *
    - * + * *
  • start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • *
  • end = End date and time of a trip in format YYYY-MM-DDThh:mm:ss
    • *
@@ -1111,28 +1111,28 @@ public interface Travel extends GlobalInterface { *
Example <g:travel_date_range>
- * + * * <g:start>2005-12-20T06:00:00</g:start>
* <g:end>2005-12-29T13:00:00</g:end>
* </g:travel_date_range>
- * + * * Attribute of Travel
- * + * * Content type dateTimeRange
- * + * * @return Departure date and time of the trip. */ public DateTimeRange getTravelDateRange(); @@ -1142,43 +1142,43 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of the property. */ public void setLocation(String location); @@ -1188,99 +1188,99 @@ public interface Travel extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of the property. */ public String getLocation(); /** * Shipping options available for an item. - * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @return Shipping options available for an item. */ public ShippingType[] getShipping(); 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 7173971..d022747 100644 --- a/src/main/java/org/rometools/feed/module/base/Unknown.java +++ b/src/main/java/org/rometools/feed/module/base/Unknown.java @@ -45,7 +45,7 @@ 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. - * + * * @author Robert "kebernet" Cooper */ public interface Unknown extends GlobalInterface { 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 bfb6310..7dd4e9f 100644 --- a/src/main/java/org/rometools/feed/module/base/ValidationException.java +++ b/src/main/java/org/rometools/feed/module/base/ValidationException.java @@ -22,12 +22,17 @@ package org.rometools.feed.module.base; /** * 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 */ public class ValidationException extends RuntimeException { + /** + * + */ + private static final long serialVersionUID = 1L; + /** Creates a new instance of ValidationException */ public ValidationException(final String message) { super(message); 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 72e3458..12071be 100644 --- a/src/main/java/org/rometools/feed/module/base/Vehicle.java +++ b/src/main/java/org/rometools/feed/module/base/Vehicle.java @@ -48,254 +48,254 @@ import org.rometools.feed.module.base.types.YearType; /** * This is an interface for the GoogleBase plug in that exposes methods used for vehicles. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public interface Vehicle extends GlobalInterface { /** * Color of an item. - * + * * - * + * * * * - * + * * * * - * + * * * * - * + * * * - * + * * * * * * - * + * * * - * + * * * * *
color
Details Color of an item.
Example <g:color>Black</g:color>
- * + * * Attribute of Products, Vehicles
Content type string
- * + * * @param color Color of an item. */ public void setColors(String[] color); /** * Color of an item. - * + * * - * + * * * * - * + * * * * - * + * * * * - * + * * * - * + * * * * * * - * + * * * - * + * * * * *
color
Details Color of an item.
Example <g:color>Black</g:color>
- * + * * Attribute of Products, Vehicles
Content type string
- * + * * @return Color of an item. */ public String[] getColors(); /** * Condition of the item. For example: new, used, or refurbished. - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
condition
DetailsCondition of the item. For example: new, used, or refurbished.
Example * <g:condition>refurbished</g:condition>
Attribute ofProducts, Vehicles
Content typestring
- * + * * @param condition Condition of the item. For example: new, used, or refurbished. */ public void setCondition(String condition); /** * Condition of the item. For example: new, used, or refurbished. - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * - * + * * * * * * - * + * * *
condition
DetailsCondition of the item. For example: new, used, or refurbished.
Example * <g:condition>refurbished</g:condition>
Attribute ofProducts, Vehicles
Content typestring
- * + * * @return Condition of the item. For example: new, used, or refurbished. */ public String getCondition(); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @param value Currency of the price amount for an item. */ public void setCurrency(CurrencyEnumeration value); /** * Currency of the price amount for an item. - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * * - * + * * * *
currency
DetailsCurrency of the price amount for an item. Values must be in ISO 4217 currency code format.
ExampleAcceptable:
* <g:currency>USD</g:currency>
- * + * * Not acceptable:
* <g:currency>US Dollars</g:currency>
Attribute ofEvents, Housing, Products, Services, Travel, Vehicles
Content typecurrencyEnumeration
- * + * * @return Currency of the price amount for an item. */ public CurrencyEnumeration getCurrency(); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -303,16 +303,16 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -321,19 +321,19 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public void setDeliveryNotes(String deliveryNotes); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -341,16 +341,16 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -359,12 +359,12 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); @@ -375,7 +375,7 @@ public interface Vehicle extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -383,14 +383,14 @@ public interface Vehicle extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -398,10 +398,10 @@ public interface Vehicle extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public void setDeliveryRadius(FloatUnit deliveryRadius); @@ -412,7 +412,7 @@ public interface Vehicle extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -420,14 +420,14 @@ public interface Vehicle extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -435,10 +435,10 @@ public interface Vehicle extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); @@ -448,43 +448,43 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of a property. Should include street, city, state, postal code, and country, in that order. */ public void setLocation(String location); @@ -494,211 +494,211 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of a property. Should include street, city, state, postal code, and country, in that order. */ public String getLocation(); /** * The vehicle manufacturer. - * + * * - * + * * * * * * * * * * * - * + * * - * + * * * * * * * - * + * * * - * + * * * *
make
- * + * * Details - * + * * The vehicle manufacturer.
Example <g:make>Honda</g:make>
Attribute of - * + * * Vehicles
Content type string
- * + * * @param make The vehicle manufacturer. */ public void setMake(String make); /** * The vehicle manufacturer. - * + * * - * + * * * * * * * * * * * - * + * * - * + * * * * * * * - * + * * * - * + * * * *
make
- * + * * Details - * + * * The vehicle manufacturer.
Example <g:make>Honda</g:make>
Attribute of - * + * * Vehicles
Content type string
- * + * * @return The vehicle manufacturer. */ public String getMake(); /** * Current mileage of the vehicle. - * + * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * *
mileage
Details Current mileage of the vehicle.
- * + * * Example <g:mileage>1700</g:mileage>
*
* <g:mileage>1,700 miles</g:mileage>
Attribute of Vehicles
Content type intUnit
- * + * * @param mileage Current mileage of the vehicle. */ public void setMileage(Integer mileage); /** * Current mileage of the vehicle. - * + * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * - * + * * * * *
mileage
Details Current mileage of the vehicle.
- * + * * Example <g:mileage>1700</g:mileage>
*
* <g:mileage>1,700 miles</g:mileage>
Attribute of Vehicles
Content type intUnit
- * + * * @return Current mileage of the vehicle. */ public Integer getMileage(); @@ -709,32 +709,32 @@ public interface Vehicle extends GlobalInterface { * * * model - * + * * * * Details - * + * * The vehicle model. * * * Example - * + * * <g:model>Camry</g:model> - * + * * * * Attribute of * Vehicles - * + * * * - * + * * Content type * string * * * - * + * * @param model The vehicle model. */ public void setModel(String model); @@ -745,41 +745,41 @@ public interface Vehicle extends GlobalInterface { * * * model - * + * * * * Details - * + * * The vehicle model. * * * Example - * + * * <g:model>Camry</g:model> - * + * * * * Attribute of * Vehicles - * + * * * - * + * * Content type * string * * * - * + * * @return The vehicle model. */ public String getModel(); /** * Payment Methods acceptable for the service. - * + * * - * + * * * * @@ -787,47 +787,47 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @param paymentAccepted Payment Methods acceptable for the service. */ public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); /** * Payment Methods acceptable for the service. - * + * * - * + * * * * @@ -835,930 +835,930 @@ public interface Vehicle extends GlobalInterface { * * * - * + * * - * + * * * * * - * + * * * - * + * * * * - * + * * * - * + * * * *
payment_accepted
Details 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.
Example Acceptable:
* <g:payment_accepted>Cash</g:payment_accepted>
- * + * * <g:payment_accepted>Check</g:payment_accepted>
- * + * * <g:payment_accepted>Paypal</g:payment_accepted>
* Not acceptable:
* <g:payment_accepted>Cash Check Paypal</g:payment_accepted>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type paymentMethodEnumeration
- * + * * @return Payment Methods acceptable for the service. */ public PaymentTypeEnumeration[] getPaymentAccepted(); /** * Additional payment information. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * + * * @param paymentNotes Additional payment information. */ public void setPaymentNotes(String paymentNotes); /** * Additional payment information. - * + * * * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * - * + * * * * - * + * * * *
payment_notes
Details Additional instructions to explain a payment policy.
Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
Attribute of - * + * * Events, Housing, Products, Services, Travel, Vehicles
Content type string
- * + * * @return Additional payment information. */ public String getPaymentNotes(); /** * Price for the service.
- * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 � 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @param price Price for the service. */ public void setPrice(FloatUnit price); /** * Price for the service.
- * - * + * + * * * * - * + * * * * * * - * + * * * * * * * * - * + * * * * * * - * + * * * *
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.
Example Acceptable:
* <g:price>5.95</g:price>
- * + * * <g:price>0</g:price>
* Not acceptable:
* <g:price>5,95</g:price>
* <g:price>5.00 � 10.00</g:price>
- * + * * <g:price>100 or best offer</g:price>
* <g:price>free</g:price>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content typefloatUnit
- * + * * @return Price for the service. */ public FloatUnit getPrice(); /** * Price type information. - * - * + * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @param priceType Price type information. */ public void setPriceType(PriceTypeEnumeration priceType); /** * Price type information. - * - * + * + * * * * * * - * + * * - * + * * * * * - * + * * - * + * * - * + * * - * + * * * * * * - * + * * * * * *
price_type
DetailsThe type of pricing for the item. Acceptable values are �negotiable,� or �starting.� The default is �starting�
ExampleAcceptable:
* <g:price_type>starting</g:price_type>
* Not acceptable:
* <g:price_type>100 OBO</g:price_type>
Attribute of Events, Housing, Products, Services, Travel, Vehicles
Content type priceTypeEnumeration
- * + * * @return Price type information. */ public PriceTypeEnumeration getPriceType(); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @param quantity Quantity available. */ public void setQuantity(Integer quantity); /** * Quantity available. - * + * * * * - * + * * - * + * * * * * - * + * * * - * + * * * * * * - * + * * * * * - * + * * * * *
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.
Example Acceptable:
* <g:quantity>18</g:quantity>
- * + * * <g:quantity>0</g:quantity>
- * + * * Not acceptable:
* <g:quantity>out of stock</g:quantity>
- * + * * Attribute of Events, Products, Services, Travel, Vehicles
Content type - * + * * integer
- * + * * @return Quantity available. */ public Integer getQuantity(); /** * Shipping options available for an item. - * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @param shipping Shipping options available for an item. */ public void setShipping(ShippingType[] shipping); /** * Shipping options available for an item. - * + * * * * * * * * - * + * * - * + * * * * * * * - * + * * - * + * * * * * * - * + * * * *
- * + * * 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: *
    - * + * *
  • 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.
    • *
*
- * + * * Example <g:shipping>
* <g:country>US</g:country>
- * + * * <g:service>UPS</g:shipping>
- * + * * <g:price>35.95</g:price>
* </g:shipping>
Attribute of Products
- * + * * Content type shippingType
- * + * * @return Shipping options available for an item. */ public ShippingType[] getShipping(); /** * Tax rate associated with the item. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @param taxPercent Tax rate associated with the event. */ public void setTaxPercent(Float taxPercent); /** * Tax rate associated with the item. - * + * * * * * * - * + * * * * * * - * + * * - * + * * * * * * * * * - * + * * - * + * * * *
tax_percent
- * + * * Details Tax rate as a percentage.
Example <g:tax_percent>8.2<g:/tax_percent>
- * + * * Attribute of - * + * * Products, Events
Content type percentType
- * + * * @return Tax rate associated with the event. */ public Float getTaxPercent(); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @param taxRegion Region where tax applies. */ public void setTaxRegion(String taxRegion); /** * Region where tax applies. - * - * - * + * + * + * * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * - * + * * * * - * + * * * *
- * + * * tax_region
Details Geographical region a tax rate applies to.
- * + * * Example <g:tax_region>California</g:tax_region>
Attribute of Product, Events,
Content typestring
- * + * * @return Region where tax applies. */ public String getTaxRegion(); /** * The type of vehicle: Car, motorcycle, scooter, etc. - * + * * * * * * * - * + * * * - * + * * * * * * - * + * * * - * + * * * * * * * * *
- * + * * vehicle_type
Details The type of vehicle: Car, motorcycle, scooter, etc.
- * + * * Example <g:vehicle_type>truck</g:vehicle_type>
Attribute of Products
- * + * * Content type - * + * * string
- * + * * @param vehicleType The type of vehicle: Car, motorcycle, scooter, etc. */ public void setVehicleType(String vehicleType); /** * The type of vehicle: Car, motorcycle, scooter, etc. - * + * * * * * * * - * + * * * - * + * * * * * * - * + * * * - * + * * * * * * * * *
- * + * * vehicle_type
Details The type of vehicle: Car, motorcycle, scooter, etc.
- * + * * Example <g:vehicle_type>truck</g:vehicle_type>
Attribute of Products
- * + * * Content type - * + * * string
- * + * * @return The type of vehicle: Car, motorcycle, scooter, etc. */ public String getVehicleType(); /** * Vehicle Identification Number. - * + * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * * * * *
vin
Details Vehicle Identification Number.
Example <g:vin>1M8GDM9AXKP042788</g:vin>
Attribute of Vehicles
- * + * * Content type string
- * + * * @param vin Vehicle Identification Number. */ public void setVin(String vin); /** * Vehicle Identification Number. - * + * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * - * + * * - * + * * * * * * * * * *
vin
Details Vehicle Identification Number.
Example <g:vin>1M8GDM9AXKP042788</g:vin>
Attribute of Vehicles
- * + * * Content type string
- * + * * @return Vehicle Identification Number. */ public String getVin(); /** * The four digit model year or year built. - * - * - * + * + * + * * * * * * * - * + * * - * + * * * * * * * - * + * * * * - * + * * * * * * - * + * * *
year
Details The four digit model year or year built. Format YYYY
- * + * * Example Acceptable:
- * + * * <g:year>2005</g:year>
* Not acceptable:
* <g:year>79</g:year>
- * + * * <g:year>26</g:year>
Attribute of Housing, Vehicles
- * + * * Content type year
- * + * * @param year The four digit model year or year built. */ public void setYear(YearType year); /** * The four digit model year or year built. - * - * - * + * + * + * * * * * * * - * + * * - * + * * * * * * * - * + * * * * - * + * * * * * * - * + * * *
year
Details The four digit model year or year built. Format YYYY
- * + * * Example Acceptable:
- * + * * <g:year>2005</g:year>
* Not acceptable:
* <g:year>79</g:year>
- * + * * <g:year>26</g:year>
Attribute of Housing, Vehicles
- * + * * Content type year
- * + * * @return The four digit model year or year built. */ public YearType getYear(); 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 db77a3a..e53610e 100644 --- a/src/main/java/org/rometools/feed/module/base/Wanted.java +++ b/src/main/java/org/rometools/feed/module/base/Wanted.java @@ -43,14 +43,14 @@ import org.rometools.feed.module.base.types.FloatUnit; /** * This is an interface for the GoogleBase plug in that exposes methods used for wanted ads. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public interface Wanted extends GlobalInterface { /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -58,16 +58,16 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -76,19 +76,19 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public void setDeliveryNotes(String deliveryNotes); /** * Additional instructions to explain the item’s delivery process. - * + * * * * @@ -96,16 +96,16 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * * * - * + * * * * @@ -114,12 +114,12 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * *
DetailsAdditional instructions to explain the item’s delivery process.
Example * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
- * + * *
Attribute of
Content typestring
- * + * * @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); @@ -130,7 +130,7 @@ public interface Wanted extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -138,14 +138,14 @@ public interface Wanted extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -153,10 +153,10 @@ public interface Wanted extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public void setDeliveryRadius(FloatUnit deliveryRadius); @@ -167,7 +167,7 @@ public interface Wanted extends GlobalInterface { * * * delivery_radius - * + * * * * Details @@ -175,14 +175,14 @@ public interface Wanted extends GlobalInterface { * * * Example - * + * * * <g:delivery_radius>10<g:/delivery_radius>
* <g:delivery_radius>10km</g:delivery_radius> * * * Attribute of - * + * * * Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads. * @@ -190,10 +190,10 @@ public interface Wanted extends GlobalInterface { * Content type * floatUnit * - * + * * * - * + * * @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); @@ -203,43 +203,43 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @param location Location of the property. */ public void setLocation(String location); @@ -249,43 +249,43 @@ public interface Wanted extends GlobalInterface { * * * - * + * * * * - * + * * * - * + * * * * - * + * * - * + * * * * * * - * + * * - * + * * * * * *
location
Details 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, * USA</g:location>
- * + * * Not acceptable:
* <g:location>123 Main St,, CA, 12345, * USA</g:location>
* <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.
Content type locationType
- * + * * @return Location of the property. */ public String getLocation(); diff --git a/src/main/java/org/rometools/feed/module/base/io/CustomTagParser.java b/src/main/java/org/rometools/feed/module/base/io/CustomTagParser.java index 48b9f68..b11cad3 100644 --- a/src/main/java/org/rometools/feed/module/base/io/CustomTagParser.java +++ b/src/main/java/org/rometools/feed/module/base/io/CustomTagParser.java @@ -95,7 +95,7 @@ public class CustomTagParser implements ModuleParser { try { tags.add(new CustomTagImpl(child.getName(), new DateTimeRange(GoogleBaseParser.LONG_DT_FMT.parse(child .getChild("start", CustomTagParser.NS).getText().trim()), GoogleBaseParser.LONG_DT_FMT.parse(child - .getChild("end", CustomTagParser.NS).getText().trim())))); + .getChild("end", CustomTagParser.NS).getText().trim())))); } catch (final Exception e) { log.log(Level.WARNING, "Unable to parse date type on " + child.getName(), e); } diff --git a/src/main/java/org/rometools/feed/module/base/io/GoogleBaseGenerator.java b/src/main/java/org/rometools/feed/module/base/io/GoogleBaseGenerator.java index 3362902..3969c03 100644 --- a/src/main/java/org/rometools/feed/module/base/io/GoogleBaseGenerator.java +++ b/src/main/java/org/rometools/feed/module/base/io/GoogleBaseGenerator.java @@ -66,7 +66,7 @@ import com.sun.syndication.feed.module.Module; import com.sun.syndication.io.ModuleGenerator; /** - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ diff --git a/src/main/java/org/rometools/feed/module/base/io/GoogleBaseParser.java b/src/main/java/org/rometools/feed/module/base/io/GoogleBaseParser.java index b067b33..542592a 100644 --- a/src/main/java/org/rometools/feed/module/base/io/GoogleBaseParser.java +++ b/src/main/java/org/rometools/feed/module/base/io/GoogleBaseParser.java @@ -75,7 +75,7 @@ import com.sun.syndication.io.ModuleParser; /** * DOCUMENT ME! - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.3 $ */ diff --git a/src/main/java/org/rometools/feed/module/base/types/CloneableType.java b/src/main/java/org/rometools/feed/module/base/types/CloneableType.java index 3ab9d34..fdd2c27 100644 --- a/src/main/java/org/rometools/feed/module/base/types/CloneableType.java +++ b/src/main/java/org/rometools/feed/module/base/types/CloneableType.java @@ -41,7 +41,7 @@ package org.rometools.feed.module.base.types; /** * This is just a holder interface for cloneable elements. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ diff --git a/src/main/java/org/rometools/feed/module/base/types/CurrencyEnumeration.java b/src/main/java/org/rometools/feed/module/base/types/CurrencyEnumeration.java index 3701ae0..9f71421 100644 --- a/src/main/java/org/rometools/feed/module/base/types/CurrencyEnumeration.java +++ b/src/main/java/org/rometools/feed/module/base/types/CurrencyEnumeration.java @@ -43,7 +43,7 @@ import java.util.HashMap; /** * An Enumeration of valid currency types. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -572,7 +572,7 @@ public class CurrencyEnumeration { /** * Creates a new instance of CurrencyEnumeration - * + * * @param value DOCUMENT ME! */ private CurrencyEnumeration(final String value) { diff --git a/src/main/java/org/rometools/feed/module/base/types/DateTimeRange.java b/src/main/java/org/rometools/feed/module/base/types/DateTimeRange.java index e7eddbb..3adbff5 100644 --- a/src/main/java/org/rometools/feed/module/base/types/DateTimeRange.java +++ b/src/main/java/org/rometools/feed/module/base/types/DateTimeRange.java @@ -43,7 +43,7 @@ import java.util.Date; /** * Represents a time range. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ @@ -59,7 +59,7 @@ public class DateTimeRange implements CloneableType { /** * Creates a new instance of DateTimeRange - * + * * @param start Beginning of the timeframe. * @param end End of the Timeframe. */ @@ -70,7 +70,7 @@ public class DateTimeRange implements CloneableType { /** * The end of the timeframe. - * + * * @return The end of the timeframe. */ public Date getEnd() { @@ -79,7 +79,7 @@ public class DateTimeRange implements CloneableType { /** * The beginning of the timeframe. - * + * * @return The beginning of the timeframe. */ public Date getStart() { @@ -88,7 +88,7 @@ public class DateTimeRange implements CloneableType { /** * Clones the object - * + * * @return Duplicate of this object. */ @Override @@ -108,7 +108,7 @@ public class DateTimeRange implements CloneableType { /** * String representation of the object. - * + * * @return String representation of the object. */ @Override diff --git a/src/main/java/org/rometools/feed/module/base/types/FloatUnit.java b/src/main/java/org/rometools/feed/module/base/types/FloatUnit.java index 3a9eeba..a334bbe 100644 --- a/src/main/java/org/rometools/feed/module/base/types/FloatUnit.java +++ b/src/main/java/org/rometools/feed/module/base/types/FloatUnit.java @@ -43,7 +43,7 @@ import org.rometools.feed.module.base.io.GoogleBaseParser; /** * This class represents a quantity consisting of a float value and an optional units specification. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -59,7 +59,7 @@ public class FloatUnit implements CloneableType { /** * Looks for a char in an array - * + * * @param find char to search for * @param array array to search * @return boolean indicating presence. @@ -75,7 +75,7 @@ public class FloatUnit implements CloneableType { /** * Creates a new float unit by parsing a String value - * + * * @param source String value to parse */ public FloatUnit(final String source) { @@ -101,7 +101,7 @@ public class FloatUnit implements CloneableType { /** * Creates a new instance of FloatUnit - * + * * @param value float value * @param units Units represented, or null. */ @@ -112,7 +112,7 @@ public class FloatUnit implements CloneableType { /** * Returns the units. - * + * * @return Returns the units. */ public String getUnits() { @@ -121,7 +121,7 @@ public class FloatUnit implements CloneableType { /** * Returns the float value. - * + * * @return Returns the float value. */ public float getValue() { @@ -130,7 +130,7 @@ public class FloatUnit implements CloneableType { /** * Duplicates the object. - * + * * @return Duplicate FloatUnit */ @Override @@ -140,7 +140,7 @@ public class FloatUnit implements CloneableType { /** * Returns a String representation of the object. - * + * * @return Returns a String representation of the object. */ @Override diff --git a/src/main/java/org/rometools/feed/module/base/types/GenderEnumeration.java b/src/main/java/org/rometools/feed/module/base/types/GenderEnumeration.java index a339b41..adb5a90 100644 --- a/src/main/java/org/rometools/feed/module/base/types/GenderEnumeration.java +++ b/src/main/java/org/rometools/feed/module/base/types/GenderEnumeration.java @@ -41,7 +41,7 @@ package org.rometools.feed.module.base.types; /** * Simple enumeration for Genders. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ diff --git a/src/main/java/org/rometools/feed/module/base/types/IntUnit.java b/src/main/java/org/rometools/feed/module/base/types/IntUnit.java index af163a7..3d26289 100644 --- a/src/main/java/org/rometools/feed/module/base/types/IntUnit.java +++ b/src/main/java/org/rometools/feed/module/base/types/IntUnit.java @@ -42,7 +42,7 @@ package org.rometools.feed.module.base.types; import org.rometools.feed.module.base.io.GoogleBaseParser; /** - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ diff --git a/src/main/java/org/rometools/feed/module/base/types/PaymentTypeEnumeration.java b/src/main/java/org/rometools/feed/module/base/types/PaymentTypeEnumeration.java index 6393ee4..d87c259 100644 --- a/src/main/java/org/rometools/feed/module/base/types/PaymentTypeEnumeration.java +++ b/src/main/java/org/rometools/feed/module/base/types/PaymentTypeEnumeration.java @@ -42,7 +42,7 @@ package org.rometools.feed.module.base.types; import java.util.HashMap; /** - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ diff --git a/src/main/java/org/rometools/feed/module/base/types/PriceTypeEnumeration.java b/src/main/java/org/rometools/feed/module/base/types/PriceTypeEnumeration.java index fd7e2a5..28cdbbd 100644 --- a/src/main/java/org/rometools/feed/module/base/types/PriceTypeEnumeration.java +++ b/src/main/java/org/rometools/feed/module/base/types/PriceTypeEnumeration.java @@ -41,7 +41,7 @@ package org.rometools.feed.module.base.types; /** * Enumeration of values suitable for "price_type" or "salary_type". - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -61,7 +61,7 @@ public class PriceTypeEnumeration implements CloneableType { /** * Creates a new instance of PriceTypeEnumeration - * + * * @param value Value to encapsulate */ private PriceTypeEnumeration(final String value) { @@ -70,7 +70,7 @@ public class PriceTypeEnumeration implements CloneableType { /** * Returns the string value of this instance. - * + * * @return Returns the string value of this instance. */ public String getValue() { @@ -79,7 +79,7 @@ public class PriceTypeEnumeration implements CloneableType { /** * Returns a PriceTypeEnumeration based on the String value or null. - * + * * @param value Value to search for. * @return PriceTypeEnumeration or null. */ @@ -93,7 +93,7 @@ public class PriceTypeEnumeration implements CloneableType { /** * Returns a duplicate of this instance - * + * * @return The same instance. */ @Override @@ -103,7 +103,7 @@ public class PriceTypeEnumeration implements CloneableType { /** * Returns the string value of this instance. - * + * * @return Returns the string value of this instance. */ @Override diff --git a/src/main/java/org/rometools/feed/module/base/types/ShippingType.java b/src/main/java/org/rometools/feed/module/base/types/ShippingType.java index 39ea7bc..0362686 100644 --- a/src/main/java/org/rometools/feed/module/base/types/ShippingType.java +++ b/src/main/java/org/rometools/feed/module/base/types/ShippingType.java @@ -43,7 +43,7 @@ import java.util.HashMap; /** * This class represents a specific shipping option for an item. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -63,7 +63,7 @@ public class ShippingType implements CloneableType { /** * Creates a new instance of ShippingType - * + * * @param price The price of the shipping option * @param service Shipping service used. * @param country Country shipped to. @@ -76,7 +76,7 @@ public class ShippingType implements CloneableType { /** * Returns the destination country. - * + * * @return Returns the destination country. */ public String getCountry() { @@ -85,7 +85,7 @@ public class ShippingType implements CloneableType { /** * Returns the price of this shipping option. - * + * * @return Returns the price of this shipping option. */ public FloatUnit getPrice() { @@ -94,7 +94,7 @@ public class ShippingType implements CloneableType { /** * Returns the ServiceEnumeration instance for the shipping service used. - * + * * @return Returns the ServiceEnumeration instance for the shipping service used. */ public ServiceEnumeration getService() { @@ -103,7 +103,7 @@ public class ShippingType implements CloneableType { /** * Clones this object. - * + * * @return Duplicate ShippingType object. */ @Override @@ -113,7 +113,7 @@ public class ShippingType implements CloneableType { /** * Returns a String representation of this object. - * + * * @return String representation of this object. */ @Override @@ -160,7 +160,7 @@ public class ShippingType implements CloneableType { /** * Creates a new instance of ServiceEnumeration. - * + * * @param value String value to encapsulate. */ private ServiceEnumeration(final String value) { @@ -170,7 +170,7 @@ public class ShippingType implements CloneableType { /** * String value of this Service. - * + * * @return String value of this Service. */ public String getValue() { @@ -179,7 +179,7 @@ public class ShippingType implements CloneableType { /** * Looks up a ServiceEnumeration based on the string value. - * + * * @param value String value to search for. * @return ServiceEnumeration or null. */ @@ -189,7 +189,7 @@ public class ShippingType implements CloneableType { /** * String value of this Service. - * + * * @return String value of this Service. */ @Override 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 8655161..117bb8e 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 @@ -44,13 +44,18 @@ 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. - * + * * Move along. Nothing to see here. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ public class ShortDate extends Date implements CloneableType { + /** + * + */ + private static final long serialVersionUID = 1L; + /** Creates a new instance of ShortDate */ public ShortDate() { super(); @@ -58,7 +63,7 @@ public class ShortDate extends Date implements CloneableType { /** * Creates a new Short Date based on a Date value. - * + * * @param date Date value to read from. */ public ShortDate(final Date date) { @@ -67,7 +72,7 @@ public class ShortDate extends Date implements CloneableType { /** * Creates a new ShortDate based on a millisecond time. - * + * * @param time Millisecond time to start with. */ public ShortDate(final long time) { @@ -76,7 +81,7 @@ public class ShortDate extends Date implements CloneableType { /** * Returns a duplicate of this object. - * + * * @return Duplicate of the object. */ @Override diff --git a/src/main/java/org/rometools/feed/module/base/types/Size.java b/src/main/java/org/rometools/feed/module/base/types/Size.java index eb11992..db86847 100644 --- a/src/main/java/org/rometools/feed/module/base/types/Size.java +++ b/src/main/java/org/rometools/feed/module/base/types/Size.java @@ -43,7 +43,7 @@ import java.util.StringTokenizer; /** * Represents the size on an item in 2 or 3 dimensions. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ @@ -63,7 +63,7 @@ public class Size implements CloneableType { /** * Creates a new Size object parsing a string value. - * + * * @param source String value to parse */ public Size(final String source) { @@ -78,7 +78,7 @@ public class Size implements CloneableType { /** * Creates a new instance of Size - * + * * @param length lenght value * @param width width value */ @@ -89,7 +89,7 @@ public class Size implements CloneableType { /** * Creates a new instance of Size. - * + * * @param length Length value. * @param width Width value. * @param height Height value. @@ -102,7 +102,7 @@ public class Size implements CloneableType { /** * Height value. - * + * * @return Height value. */ public FloatUnit getHeight() { @@ -111,7 +111,7 @@ public class Size implements CloneableType { /** * Length value. - * + * * @return Length value. */ public FloatUnit getLength() { @@ -120,7 +120,7 @@ public class Size implements CloneableType { /** * Width value. - * + * * @return Width value. */ public FloatUnit getWidth() { @@ -129,7 +129,7 @@ public class Size implements CloneableType { /** * Duplicates this object. - * + * * @return A duplicate Size object. */ @Override @@ -143,7 +143,7 @@ public class Size implements CloneableType { /** * Returns a string representation of this object. - * + * * @return A string representation of this object. */ @Override diff --git a/src/main/java/org/rometools/feed/module/base/types/YearType.java b/src/main/java/org/rometools/feed/module/base/types/YearType.java index a577450..683ca01 100644 --- a/src/main/java/org/rometools/feed/module/base/types/YearType.java +++ b/src/main/java/org/rometools/feed/module/base/types/YearType.java @@ -44,7 +44,7 @@ import java.util.Date; /** * This class represents a simple 4 digit year. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.1 $ */ @@ -56,7 +56,7 @@ public class YearType implements CloneableType { /** * Creates a new year from a string value. - * + * * @param year String to parse. */ public YearType(final String year) { @@ -65,7 +65,7 @@ public class YearType implements CloneableType { /** * Creates a new instance of YearType - * + * * @param date Date to get the year from. */ public YearType(final Date date) { @@ -76,7 +76,7 @@ public class YearType implements CloneableType { /** * Duplicates this object. - * + * * @return Cloned Year. */ @Override @@ -86,7 +86,7 @@ public class YearType implements CloneableType { /** * Returns a String representation of this object. - * + * * @return Returns a String representation of this object. */ @Override diff --git a/src/main/java/org/rometools/feed/module/cc/CreativeCommons.java b/src/main/java/org/rometools/feed/module/cc/CreativeCommons.java index f31831a..a746bcc 100644 --- a/src/main/java/org/rometools/feed/module/cc/CreativeCommons.java +++ b/src/main/java/org/rometools/feed/module/cc/CreativeCommons.java @@ -3,7 +3,7 @@ * * Created on November 20, 2005, 5:05 PM * - * This library is provided under dual licenses. + * This library is provided under dual licenses. * You may choose the terms of the Lesser General Public License or the Apache * License at your discretion. * @@ -28,14 +28,14 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and - * limitations under the License. + * limitations under the License. */ package org.rometools.feed.module.cc; @@ -45,7 +45,7 @@ import org.rometools.feed.module.cc.types.License; import com.sun.syndication.feed.module.Module; /** - * + * * @author Robert "kebernet" Cooper */ public interface CreativeCommons extends Module { diff --git a/src/main/java/org/rometools/feed/module/cc/CreativeCommonsImpl.java b/src/main/java/org/rometools/feed/module/cc/CreativeCommonsImpl.java index 06eb937..3a39696 100644 --- a/src/main/java/org/rometools/feed/module/cc/CreativeCommonsImpl.java +++ b/src/main/java/org/rometools/feed/module/cc/CreativeCommonsImpl.java @@ -3,7 +3,7 @@ * * Created on November 20, 2005, 5:12 PM * - * This library is provided under dual licenses. + * This library is provided under dual licenses. * You may choose the terms of the Lesser General Public License or the Apache * License at your discretion. * @@ -28,14 +28,14 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and - * limitations under the License. + * limitations under the License. */ package org.rometools.feed.module.cc; @@ -54,6 +54,10 @@ import com.sun.syndication.feed.impl.ToStringBean; */ public class CreativeCommonsImpl implements CreativeCommons { + /** + * + */ + private static final long serialVersionUID = 1L; public static final String RDF_URI = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"; public static final String RSS2_URI = "http://backend.userland.com/creativeCommonsRssModule"; public static final String RSS1_URI = "http://web.resource.org/cc/"; diff --git a/src/main/java/org/rometools/feed/module/cc/io/CCModuleGenerator.java b/src/main/java/org/rometools/feed/module/cc/io/CCModuleGenerator.java index b5eb06f..e2d8f8e 100644 --- a/src/main/java/org/rometools/feed/module/cc/io/CCModuleGenerator.java +++ b/src/main/java/org/rometools/feed/module/cc/io/CCModuleGenerator.java @@ -3,7 +3,7 @@ * * Created on November 20, 2005, 5:23 PM * - * This library is provided under dual licenses. + * This library is provided under dual licenses. * You may choose the terms of the Lesser General Public License or the Apache * License at your discretion. * @@ -28,14 +28,14 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and - * limitations under the License. + * limitations under the License. */ package org.rometools.feed.module.cc.io; diff --git a/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS1.java b/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS1.java index 85a2a1a..906c376 100644 --- a/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS1.java +++ b/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS1.java @@ -3,7 +3,7 @@ * * Created on November 20, 2005, 5:23 PM * - * This library is provided under dual licenses. + * This library is provided under dual licenses. * You may choose the terms of the Lesser General Public License or the Apache * License at your discretion. * @@ -28,14 +28,14 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and - * limitations under the License. + * limitations under the License. */ package org.rometools.feed.module.cc.io; diff --git a/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS2.java b/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS2.java index aa266cd..1bc4657 100644 --- a/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS2.java +++ b/src/main/java/org/rometools/feed/module/cc/io/ModuleParserRSS2.java @@ -3,7 +3,7 @@ * * Created on November 20, 2005, 6:15 PM * - * This library is provided under dual licenses. + * This library is provided under dual licenses. * You may choose the terms of the Lesser General Public License or the Apache * License at your discretion. * @@ -28,14 +28,14 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and - * limitations under the License. + * limitations under the License. */ package org.rometools.feed.module.cc.io; @@ -54,7 +54,7 @@ import com.sun.syndication.feed.module.Module; import com.sun.syndication.io.ModuleParser; /** - * + * * @version $Revision: 1.3 $ * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/cc/types/License.java b/src/main/java/org/rometools/feed/module/cc/types/License.java index c7c358c..0c7c072 100644 --- a/src/main/java/org/rometools/feed/module/cc/types/License.java +++ b/src/main/java/org/rometools/feed/module/cc/types/License.java @@ -3,7 +3,7 @@ * * Created on November 20, 2005, 3:20 PM * - * This library is provided under dual licenses. + * This library is provided under dual licenses. * You may choose the terms of the Lesser General Public License or the Apache * License at your discretion. * @@ -28,14 +28,14 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and - * limitations under the License. + * limitations under the License. */ package org.rometools.feed.module.cc.types; diff --git a/src/main/java/org/rometools/feed/module/content/ContentItem.java b/src/main/java/org/rometools/feed/module/content/ContentItem.java index c70f250..37c09b5 100644 --- a/src/main/java/org/rometools/feed/module/content/ContentItem.java +++ b/src/main/java/org/rometools/feed/module/content/ContentItem.java @@ -45,7 +45,7 @@ import java.util.List; /** * This class represents a content item per the "Original Syntax". http://purl.org/rss/1.0/modules/content/ - * + * * @version $Revision: 1.1 $ * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/content/ContentModule.java b/src/main/java/org/rometools/feed/module/content/ContentModule.java index 7b9f741..39dc100 100644 --- a/src/main/java/org/rometools/feed/module/content/ContentModule.java +++ b/src/main/java/org/rometools/feed/module/content/ContentModule.java @@ -54,14 +54,14 @@ public interface ContentModule extends Module { /** * Returns a List of Strings containing the New Syntax Encoded values are in the element. - * + * * @return List of content Strings */ public List getEncodeds(); /** * Sets a List of Strings containing the New Syntax Encoded values are in the element. - * + * * @return List of content Strings */ public void setEncodeds(List encodeds); @@ -73,7 +73,7 @@ public interface ContentModule extends Module { /** * Contains a list of ContentItems that represent the "Original Syntax" set. - * + * * @see com.totsp.xml.syndication.content.ContentItem * @return List of ContentItems. */ @@ -81,7 +81,7 @@ public interface ContentModule extends Module { /** * Contains a list of ContentItems that represent the "Original Syntax" set. - * + * * @see com.totsp.xml.syndication.content.ContentItem * @param List of ContentItems. */ @@ -89,14 +89,14 @@ public interface ContentModule extends Module { /** * Returns a List of Strings containing whatever new or original syntax items are in the element. - * + * * @return List of content Strings */ public List getContents(); /** * Sets a List of Strings containing whatever new or original syntax items are in the element. - * + * * @return List of content Strings */ public void setContents(List contents); diff --git a/src/main/java/org/rometools/feed/module/content/ContentModuleImpl.java b/src/main/java/org/rometools/feed/module/content/ContentModuleImpl.java index 02d52af..61296b5 100644 --- a/src/main/java/org/rometools/feed/module/content/ContentModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/content/ContentModuleImpl.java @@ -53,6 +53,10 @@ import com.sun.syndication.feed.CopyFrom; * @author Robert "kebernet" Cooper */ public class ContentModuleImpl extends com.sun.syndication.feed.module.ModuleImpl implements ContentModule { + /** + * + */ + private static final long serialVersionUID = 1L; private List encodeds; private List contents; private List contentItems; diff --git a/src/main/java/org/rometools/feed/module/feedburner/FeedBurner.java b/src/main/java/org/rometools/feed/module/feedburner/FeedBurner.java index 268047f..fb42012 100644 --- a/src/main/java/org/rometools/feed/module/feedburner/FeedBurner.java +++ b/src/main/java/org/rometools/feed/module/feedburner/FeedBurner.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -23,10 +23,10 @@ import com.sun.syndication.feed.module.Module; /** * Interface for the FeedBurner RSS extension. - * + * * @version 1.0 * @author Georg Schmidl - * + * */ public interface FeedBurner extends Module, Serializable, Cloneable { diff --git a/src/main/java/org/rometools/feed/module/feedburner/FeedBurnerImpl.java b/src/main/java/org/rometools/feed/module/feedburner/FeedBurnerImpl.java index 0572f6a..1ec3d38 100644 --- a/src/main/java/org/rometools/feed/module/feedburner/FeedBurnerImpl.java +++ b/src/main/java/org/rometools/feed/module/feedburner/FeedBurnerImpl.java @@ -21,10 +21,10 @@ import com.sun.syndication.feed.CopyFrom; /** * Implementation of the FeedBurner RSS extension. - * + * * @version 1.0 * @author Georg Schmidl - * + * */ public class FeedBurnerImpl implements FeedBurner { diff --git a/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleGenerator.java b/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleGenerator.java index f5813c5..06f8317 100644 --- a/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleGenerator.java +++ b/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleGenerator.java @@ -28,10 +28,10 @@ import com.sun.syndication.io.ModuleGenerator; /** * ModuleGenerator implementation for the FeedBurner RSS extension. - * + * * @version 1.0 * @author Georg Schmidl - * + * */ public class FeedBurnerModuleGenerator implements ModuleGenerator { private static final Namespace NS = Namespace.getNamespace("feedburner", FeedBurner.URI); diff --git a/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleParser.java b/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleParser.java index df7046b..34b3822 100644 --- a/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleParser.java +++ b/src/main/java/org/rometools/feed/module/feedburner/io/FeedBurnerModuleParser.java @@ -28,10 +28,10 @@ import com.sun.syndication.io.ModuleParser; /** * ModuleParser implementation for the FeedBurner RSS extension. - * + * * @version 1.0 * @author Georg Schmidl - * + * */ public class FeedBurnerModuleParser implements ModuleParser { private static final Namespace NS = Namespace.getNamespace(FeedBurner.URI); diff --git a/src/main/java/org/rometools/feed/module/georss/GMLGenerator.java b/src/main/java/org/rometools/feed/module/georss/GMLGenerator.java index 74301f3..7aaa98e 100644 --- a/src/main/java/org/rometools/feed/module/georss/GMLGenerator.java +++ b/src/main/java/org/rometools/feed/module/georss/GMLGenerator.java @@ -38,10 +38,10 @@ import com.sun.syndication.io.ModuleGenerator; /** * GMLGenerator produces georss elements in georss GML format. - * + * * @author Marc Wick * @version $Id: GMLGenerator.java,v 1.1 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class GMLGenerator implements ModuleGenerator { @@ -66,7 +66,6 @@ public class GMLGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#getNamespaceUri() */ @Override @@ -76,7 +75,6 @@ public class GMLGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#getNamespaces() */ @Override @@ -86,7 +84,6 @@ public class GMLGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#generate(com.sun.syndication.feed.module.Module, org.jdom2.Element) */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/GMLModuleImpl.java b/src/main/java/org/rometools/feed/module/georss/GMLModuleImpl.java index 1f330ec..a26dd90 100644 --- a/src/main/java/org/rometools/feed/module/georss/GMLModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/georss/GMLModuleImpl.java @@ -18,20 +18,24 @@ package org.rometools.feed.module.georss; /** * GMLModuleImpl is the implementation of the {@link GeoRSSModule} Interface for the gml GeoRSS format. - * + * * @author Marc Wick * @version $Id: GMLModuleImpl.java,v 1.1 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class GMLModuleImpl extends GeoRSSModule { + /** + * + */ + private static final long serialVersionUID = 1L; + public GMLModuleImpl() { super(GeoRSSModule.class, GeoRSSModule.GEORSS_GML_URI); } /* * (non-Javadoc) - * * @see com.sun.syndication.feed.CopyFrom#getInterface() */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/GMLParser.java b/src/main/java/org/rometools/feed/module/georss/GMLParser.java index a3bda01..94f9acc 100644 --- a/src/main/java/org/rometools/feed/module/georss/GMLParser.java +++ b/src/main/java/org/rometools/feed/module/georss/GMLParser.java @@ -34,16 +34,15 @@ import com.sun.syndication.io.ModuleParser; /** * GMLParser is a parser for the GML georss format. - * + * * @author Marc Wick * @version $Id: GMLParser.java,v 1.2 2007/06/05 20:44:53 marcwick Exp $ - * + * */ public class GMLParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#getNamespaceUri() */ @Override @@ -53,7 +52,6 @@ public class GMLParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#parse(org.jdom2.Element) */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/GeoRSSModule.java b/src/main/java/org/rometools/feed/module/georss/GeoRSSModule.java index b802533..116e40e 100644 --- a/src/main/java/org/rometools/feed/module/georss/GeoRSSModule.java +++ b/src/main/java/org/rometools/feed/module/georss/GeoRSSModule.java @@ -26,11 +26,16 @@ import com.sun.syndication.feed.module.ModuleImpl; /** * GeoRSSModule is the main georss interface defining the methods to produce and consume georss elements. - * + * * @author Marc Wick * @version $Id: GeoRSSModule.java,v 1.8 2007/06/06 09:47:32 marcwick Exp $ */ public abstract class GeoRSSModule extends ModuleImpl implements Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; + protected AbstractGeometry geometry; public static final String version = "0.9.8"; @@ -56,13 +61,13 @@ public abstract class GeoRSSModule extends ModuleImpl implements Cloneable { public static final Namespace SIMPLE_NS = Namespace.getNamespace("georss", GeoRSSModule.GEORSS_GEORSS_URI); /** - * + * * Namespace for w3c georss : xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" */ public static final Namespace W3CGEO_NS = Namespace.getNamespace("geo", GeoRSSModule.GEORSS_W3CGEO_URI); /** - * + * * Namespace for gml georss : xmlns:gml="http://www.opengis.net/gml" */ public static final Namespace GML_NS = Namespace.getNamespace("gml", GeoRSSModule.GEORSS_GML_URI); @@ -73,7 +78,7 @@ public abstract class GeoRSSModule extends ModuleImpl implements Cloneable { /** * Set geometry of georss element - * + * * @param geometry geometry */ public void setGeometry(final AbstractGeometry geometry) { @@ -82,7 +87,7 @@ public abstract class GeoRSSModule extends ModuleImpl implements Cloneable { /** * returns the geometry - * + * * @return geometry */ public AbstractGeometry getGeometry() { @@ -91,7 +96,7 @@ public abstract class GeoRSSModule extends ModuleImpl implements Cloneable { /** * Convenience method to return point geometry. Returns null if the geometry is non-point. - * + * * @return geometry */ public Position getPosition() { @@ -103,7 +108,7 @@ public abstract class GeoRSSModule extends ModuleImpl implements Cloneable { /** * Convenience method to set point geometry. - * + * * @return geometry */ public void setPosition(final Position pos) { @@ -114,7 +119,6 @@ public abstract class GeoRSSModule extends ModuleImpl implements Cloneable { /* * (non-Javadoc) - * * @see com.sun.syndication.feed.CopyFrom#copyFrom(java.lang.Object) */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/GeoRSSPoint.java b/src/main/java/org/rometools/feed/module/georss/GeoRSSPoint.java index bca5cdf..512bc83 100644 --- a/src/main/java/org/rometools/feed/module/georss/GeoRSSPoint.java +++ b/src/main/java/org/rometools/feed/module/georss/GeoRSSPoint.java @@ -18,7 +18,7 @@ package org.rometools.feed.module.georss; /** * @author marc - * + * */ public class GeoRSSPoint implements Cloneable { private double latitude; 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 3d96ad6..5b94f45 100644 --- a/src/main/java/org/rometools/feed/module/georss/GeoRSSUtils.java +++ b/src/main/java/org/rometools/feed/module/georss/GeoRSSUtils.java @@ -21,10 +21,10 @@ import com.sun.syndication.feed.synd.SyndFeed; /** * static utility methods for georss. - * + * * @author Marc Wick * @version $Id: GeoRSSUtils.java,v 1.4 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class GeoRSSUtils { @@ -54,7 +54,7 @@ public class GeoRSSUtils { /** * 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 */ @@ -76,15 +76,13 @@ public class GeoRSSUtils { /* * 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; + * 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). - * + * * @param feed the element in the feed which might have a georss element * @return a georssmodule or null if none is present */ @@ -107,9 +105,7 @@ public class GeoRSSUtils { /* * 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; + * Error("geometry of simple and w3c do not match"); } } return geoRSSModule; */ } } diff --git a/src/main/java/org/rometools/feed/module/georss/SimpleGenerator.java b/src/main/java/org/rometools/feed/module/georss/SimpleGenerator.java index 6fe6dfc..3a4b976 100644 --- a/src/main/java/org/rometools/feed/module/georss/SimpleGenerator.java +++ b/src/main/java/org/rometools/feed/module/georss/SimpleGenerator.java @@ -36,10 +36,10 @@ import com.sun.syndication.io.ModuleGenerator; /** * SimpleGenerator produces georss elements in georss simple format. - * + * * @author Marc Wick * @version $Id: SimpleGenerator.java,v 1.4 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class SimpleGenerator implements ModuleGenerator { @@ -60,7 +60,6 @@ public class SimpleGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#getNamespaceUri() */ @Override @@ -70,7 +69,6 @@ public class SimpleGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#getNamespaces() */ @Override @@ -80,7 +78,6 @@ public class SimpleGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#generate(com.sun.syndication.feed.module.Module, org.jdom2.Element) */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/SimpleModuleImpl.java b/src/main/java/org/rometools/feed/module/georss/SimpleModuleImpl.java index a1c6b7c..8cfef68 100644 --- a/src/main/java/org/rometools/feed/module/georss/SimpleModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/georss/SimpleModuleImpl.java @@ -18,19 +18,23 @@ package org.rometools.feed.module.georss; /** * SimpleModuleImpl is the implementation of the {@link GeoRSSModule} Interface for the GeoRSS Simple format. - * + * * @author Marc Wick * @version $Id: SimpleModuleImpl.java,v 1.4 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class SimpleModuleImpl extends GeoRSSModule { + /** + * + */ + private static final long serialVersionUID = 1L; + public SimpleModuleImpl() { super(GeoRSSModule.class, GeoRSSModule.GEORSS_GEORSS_URI); } /* * (non-Javadoc) - * * @see com.sun.syndication.feed.CopyFrom#getInterface() */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/SimpleParser.java b/src/main/java/org/rometools/feed/module/georss/SimpleParser.java index ee0f17b..a9bf156 100644 --- a/src/main/java/org/rometools/feed/module/georss/SimpleParser.java +++ b/src/main/java/org/rometools/feed/module/georss/SimpleParser.java @@ -32,16 +32,15 @@ import com.sun.syndication.io.ModuleParser; /** * SimpleParser is a parser for the GeoRSS Simple format. - * + * * @author Marc Wick * @version $Id: SimpleParser.java,v 1.4 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class SimpleParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#getNamespaceUri() */ @Override @@ -61,7 +60,6 @@ public class SimpleParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#parse(org.jdom2.Element) */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/W3CGeoGenerator.java b/src/main/java/org/rometools/feed/module/georss/W3CGeoGenerator.java index 8c287ef..e213212 100644 --- a/src/main/java/org/rometools/feed/module/georss/W3CGeoGenerator.java +++ b/src/main/java/org/rometools/feed/module/georss/W3CGeoGenerator.java @@ -30,10 +30,10 @@ import com.sun.syndication.io.ModuleGenerator; /** * W3CGeoGenerator produces georss elements in georss W3C geo format. - * + * * @author Marc Wick * @version $Id: W3CGeoGenerator.java,v 1.3 2007/04/18 09:59:30 marcwick Exp $ - * + * */ public class W3CGeoGenerator implements ModuleGenerator { @@ -53,7 +53,6 @@ public class W3CGeoGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#getNamespaceUri() */ @Override @@ -63,7 +62,6 @@ public class W3CGeoGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#getNamespaces() */ @Override @@ -73,7 +71,6 @@ public class W3CGeoGenerator implements ModuleGenerator { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleGenerator#generate(com.sun.syndication.feed.module.Module, org.jdom2.Element) */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/W3CGeoModuleImpl.java b/src/main/java/org/rometools/feed/module/georss/W3CGeoModuleImpl.java index 15a6977..9f8464f 100644 --- a/src/main/java/org/rometools/feed/module/georss/W3CGeoModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/georss/W3CGeoModuleImpl.java @@ -18,20 +18,24 @@ package org.rometools.feed.module.georss; /** * W3CGeoModuleImpl is the implementation of the {@link GeoRSSModule} Interface for the W3C geo format. - * + * * @author Marc Wick * @version $Id: W3CGeoModuleImpl.java,v 1.2 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class W3CGeoModuleImpl extends GeoRSSModule { + /** + * + */ + private static final long serialVersionUID = 1L; + public W3CGeoModuleImpl() { super(GeoRSSModule.class, GeoRSSModule.GEORSS_W3CGEO_URI); } /* * (non-Javadoc) - * * @see com.sun.syndication.feed.CopyFrom#getInterface() */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/W3CGeoParser.java b/src/main/java/org/rometools/feed/module/georss/W3CGeoParser.java index dc90d76..58d3c01 100644 --- a/src/main/java/org/rometools/feed/module/georss/W3CGeoParser.java +++ b/src/main/java/org/rometools/feed/module/georss/W3CGeoParser.java @@ -27,16 +27,15 @@ import com.sun.syndication.io.ModuleParser; /** * W3CGeoParser is a parser for the W3C geo format. - * + * * @author Marc Wick * @version $Id: W3CGeoParser.java,v 1.4 2007/04/18 09:59:29 marcwick Exp $ - * + * */ public class W3CGeoParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#getNamespaceUri() */ @Override @@ -71,7 +70,6 @@ public class W3CGeoParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#parse(org.jdom2.Element) */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractCurve.java b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractCurve.java index 695f442..64754c7 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractCurve.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractCurve.java @@ -11,11 +11,16 @@ package org.rometools.feed.module.georss.geometries; /** * Abstract base class for Curves (linear objects) - * + * * @author runaas */ public abstract class AbstractCurve extends AbstractGeometricPrimitive { + /** + * + */ + private static final long serialVersionUID = 1L; + /** Creates a new instance of Curve */ public AbstractCurve() { } diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometricPrimitive.java b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometricPrimitive.java index ddf7a06..033fb79 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometricPrimitive.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometricPrimitive.java @@ -11,11 +11,16 @@ package org.rometools.feed.module.georss.geometries; /** * Abstract base class for geometric primitives (non-composite geometric objects) - * + * * @author runaas */ public abstract class AbstractGeometricPrimitive extends AbstractGeometry { + /** + * + */ + private static final long serialVersionUID = 1L; + /** Creates a new instance of GeometricPrimitive */ public AbstractGeometricPrimitive() { diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometry.java b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometry.java index b5b25e9..9f27557 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometry.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractGeometry.java @@ -13,18 +13,23 @@ import java.io.Serializable; /** * Abstract base class for geometries. - * + * * @author runaas */ public abstract class AbstractGeometry implements Cloneable, Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; + /** Creates a new instance of Geometry */ public AbstractGeometry() { } /** * Make a deep copy of the geometric object - * + * * @return A copy of the object */ @Override diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractRing.java b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractRing.java index cdc2dde..0405d45 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractRing.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractRing.java @@ -13,11 +13,16 @@ import java.io.Serializable; /** * Abstract base class for rings (closed linear objects used for polygon borders) - * + * * @author runaas */ public abstract class AbstractRing implements Cloneable, Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; + /** Creates a new instance of AbstractRing */ public AbstractRing() { } diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractSurface.java b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractSurface.java index b77a596..b355ba2 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/AbstractSurface.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/AbstractSurface.java @@ -11,11 +11,16 @@ package org.rometools.feed.module.georss.geometries; /** * Abstract base class for surface (area) objects - * + * * @author runaas */ public abstract class AbstractSurface extends AbstractGeometricPrimitive { + /** + * + */ + private static final long serialVersionUID = 1L; + /** Creates a new instance of Surface */ public AbstractSurface() { } 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 2b3997a..5b8dff4 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 @@ -12,10 +12,14 @@ 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. - * + * * @author runaas */ public class Envelope extends AbstractGeometry { + /** + * + */ + private static final long serialVersionUID = 1L; protected double minLatitude, minLongitude, maxLatitude, maxLongitude; /** Creates a new instance of Envelope */ @@ -25,7 +29,7 @@ public class Envelope extends AbstractGeometry { /** * Construct object from coordinate values - * + * * @param minLatitude * @param minLongitude * @param maxLatitude diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/LineString.java b/src/main/java/org/rometools/feed/module/georss/geometries/LineString.java index cf69e7f..ecec3c1 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/LineString.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/LineString.java @@ -11,10 +11,14 @@ package org.rometools.feed.module.georss.geometries; /** * Linear object constructed by linear interpolation between points - * + * * @author runaas */ public final class LineString extends AbstractCurve { + /** + * + */ + private static final long serialVersionUID = 1L; private PositionList posList; /** Creates a new instance of LineString */ @@ -51,7 +55,7 @@ public final class LineString extends AbstractCurve { /** * Get the position list - * + * * @return the positionlist */ public PositionList getPositionList() { @@ -63,7 +67,7 @@ public final class LineString extends AbstractCurve { /** * Set the position list - * + * * @param posList the new position list */ public void setPositionList(final PositionList posList) { 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 5283791..b474ed8 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 @@ -11,10 +11,14 @@ package org.rometools.feed.module.georss.geometries; /** * Linear boundary object constructed by linear interpolation between points. Start and end point should be identical. - * + * * @author runaas */ public final class LinearRing extends AbstractRing { + /** + * + */ + private static final long serialVersionUID = 1L; private PositionList posList; /** Creates a new instance of LinearLing */ @@ -47,7 +51,7 @@ public final class LinearRing extends AbstractRing { /** * Get the position list - * + * * @return the positionlist */ public PositionList getPositionList() { @@ -59,7 +63,7 @@ public final class LinearRing extends AbstractRing { /** * Set the position list - * + * * @param posList the new position list */ public void setPositionList(final PositionList posList) { diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/Point.java b/src/main/java/org/rometools/feed/module/georss/geometries/Point.java index ea1b76d..d059c3e 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/Point.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/Point.java @@ -11,10 +11,14 @@ package org.rometools.feed.module.georss.geometries; /** * Point object, contains a position - * + * * @author runaas */ public final class Point extends AbstractGeometricPrimitive { + /** + * + */ + private static final long serialVersionUID = 1L; private Position pos; /** Creates a new instance of Point */ @@ -48,7 +52,7 @@ public final class Point extends AbstractGeometricPrimitive { /** * Get the position - * + * * @return the position */ public Position getPosition() { @@ -60,7 +64,7 @@ public final class Point extends AbstractGeometricPrimitive { /** * Set the position - * + * * @param pos the new position */ public void setPosition(final Position pos) { diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/Polygon.java b/src/main/java/org/rometools/feed/module/georss/geometries/Polygon.java index 062d3eb..df54fac 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/Polygon.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/Polygon.java @@ -15,10 +15,14 @@ import java.util.List; /** * Polygon, a surface object bounded by one external ring and zero or more internal rings - * + * * @author runaas */ public final class Polygon extends AbstractSurface implements Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private AbstractRing exterior; private List interior; @@ -79,7 +83,7 @@ public final class Polygon extends AbstractSurface implements Cloneable { /** * Retrieve the outer border - * + * * @return the border ring */ public AbstractRing getExterior() { @@ -88,7 +92,7 @@ public final class Polygon extends AbstractSurface implements Cloneable { /** * Retrieve the inner border - * + * * @return the list of border rings */ public List getInterior() { @@ -100,7 +104,7 @@ public final class Polygon extends AbstractSurface implements Cloneable { /** * Set the outer border - * + * * @param exterior the outer ring */ public void setExterior(final AbstractRing exterior) { @@ -109,7 +113,7 @@ public final class Polygon extends AbstractSurface implements Cloneable { /** * Set the list of inner borders (holes) - * + * * @param interior the list of inner rings */ public void setInterior(final List interior) { diff --git a/src/main/java/org/rometools/feed/module/georss/geometries/Position.java b/src/main/java/org/rometools/feed/module/georss/geometries/Position.java index e29a0a0..75097ff 100644 --- a/src/main/java/org/rometools/feed/module/georss/geometries/Position.java +++ b/src/main/java/org/rometools/feed/module/georss/geometries/Position.java @@ -13,10 +13,14 @@ import java.io.Serializable; /** * A two dimensional position represented by latitude and longitude decimal degrees in WGS84 - * + * * @author runaas */ public class Position implements Cloneable, Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; private double latitude; private double longitude; @@ -28,7 +32,7 @@ public class Position implements Cloneable, Serializable { /** * Create Position from a pair of coordinate values - * + * * @param latitude * @param longitude */ @@ -64,7 +68,7 @@ public class Position implements Cloneable, Serializable { /** * Set the latitude - * + * * @param latitude the new latitude */ public void setLatitude(final double latitude) { @@ -80,7 +84,7 @@ public class Position implements Cloneable, Serializable { /** * Set the longitude - * + * * @param longitude the new longitude */ public void setLongitude(final double longitude) { 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 33c9191..a62d27b 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 @@ -13,10 +13,14 @@ import java.io.Serializable; /** * A list of geographic positions, latitude, longitude decimal degrees WGS84 - * + * * @author runaas */ public class PositionList implements Cloneable, Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; private double[] latitude; private double[] longitude; private int size; @@ -106,7 +110,7 @@ public class PositionList implements Cloneable, Serializable { /** * Add a position at the end of the list - * + * * @param latitude * @param longitude */ @@ -119,7 +123,7 @@ 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" - * + * * @param pos position index * @param latitude * @param longitude @@ -135,7 +139,7 @@ public class PositionList implements Cloneable, Serializable { /** * Replace the position at the index with new values - * + * * @param pos position index * @param latitude * @param longitude @@ -147,7 +151,7 @@ public class PositionList implements Cloneable, Serializable { /** * Remove the position at the index, the rest of the list is shifted one place to the "left" - * + * * @param pos position index */ public void remove(final int pos) { diff --git a/src/main/java/org/rometools/feed/module/itunes/AbstractITunesObject.java b/src/main/java/org/rometools/feed/module/itunes/AbstractITunesObject.java index 76d0697..e32f112 100644 --- a/src/main/java/org/rometools/feed/module/itunes/AbstractITunesObject.java +++ b/src/main/java/org/rometools/feed/module/itunes/AbstractITunesObject.java @@ -44,11 +44,16 @@ import com.sun.syndication.feed.CopyFrom; /** * This is an abstract object that implements the attributes common across Feeds or Items in an iTunes compatible RSS feed. - * + * * @version $Revision: 1.4 $ * @author Robert "kebernet" Cooper */ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; + /** * The URI that iTunes used for its custom tags. *

@@ -76,7 +81,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Defined by the ROME module API - * + * * @param obj Object to copy from */ @Override @@ -84,7 +89,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Defined by the ROME API - * + * * @return Class of the Interface for this module. */ @Override @@ -94,7 +99,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * The URI this module implements - * + * * @return "http://www.itunes.com/dtds/podcast-1.0.dtd" */ @Override @@ -104,7 +109,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Required by the ROME API - * + * * @return A clone of this module object */ @Override @@ -112,7 +117,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Returns the author string for this feed or entry - * + * * @return Returns the author string for this feed or entry */ @Override @@ -122,7 +127,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Sets the author string for this feed or entry - * + * * @param author Sets the author string for this feed or entry */ @Override @@ -132,7 +137,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Boolean as to whether to block this feed or entry - * + * * @return Boolean as to whether to block this feed or entry */ @Override @@ -142,7 +147,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Boolean as to whether to block this feed or entry - * + * * @param block Boolean as to whether to block this feed or entry */ @Override @@ -152,7 +157,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Boolean as to whether this feed or entry contains adult content - * + * * @return Boolean as to whether this feed or entry contains adult content */ @Override @@ -162,7 +167,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * Boolean as to whether this feed or entry contains adult content - * + * * @param explicit Boolean as to whether this feed or entry contains adult content */ @Override @@ -172,9 +177,9 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * A list of keywords for this feed or entry - * + * * Must not contain spaces - * + * * @return A list of keywords for this feed or entry */ @Override @@ -184,9 +189,9 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * A list of keywords for this feed or entry - * + * * Must not contain spaces - * + * * @param keywords A list of keywords for this feed or enty */ @Override @@ -196,7 +201,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * A subtitle for this feed or entry - * + * * @return A subtitle for this feed or entry */ @Override @@ -206,7 +211,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * A subtitle for this feed or entry - * + * * @param subtitle A subtitle for this feed or entry */ @Override @@ -216,7 +221,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * A subtitle for this feed or entry - * + * * @return A subtitle for this feed or entry */ @Override @@ -226,7 +231,7 @@ public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneabl /** * A subtitle for this feed or entry - * + * * @param summary A subtitle for this feed or entry */ @Override diff --git a/src/main/java/org/rometools/feed/module/itunes/EntryInformation.java b/src/main/java/org/rometools/feed/module/itunes/EntryInformation.java index 17bba08..d44e4a7 100644 --- a/src/main/java/org/rometools/feed/module/itunes/EntryInformation.java +++ b/src/main/java/org/rometools/feed/module/itunes/EntryInformation.java @@ -45,23 +45,23 @@ import org.rometools.feed.module.itunes.types.Duration; /** * This class contains information for iTunes podcast feeds that exist at the Item level. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ - * + * */ public interface EntryInformation extends ITunes { /** * Returns the Duration object for this Item - * + * * @return Returns the Duration object for this Item */ public Duration getDuration(); /** * Sets the Duration object for this Item - * + * * @param duration Sets the Duration object for this Item */ public void setDuration(Duration duration); diff --git a/src/main/java/org/rometools/feed/module/itunes/EntryInformationImpl.java b/src/main/java/org/rometools/feed/module/itunes/EntryInformationImpl.java index 4354b51..0f9e961 100644 --- a/src/main/java/org/rometools/feed/module/itunes/EntryInformationImpl.java +++ b/src/main/java/org/rometools/feed/module/itunes/EntryInformationImpl.java @@ -46,11 +46,15 @@ import com.sun.syndication.feed.CopyFrom; /** * This class contains information for iTunes podcast feeds that exist at the Item level. - * + * * @version $Revision: 1.2 $ * @author Robert "kebernet" Cooper */ public class EntryInformationImpl extends AbstractITunesObject implements EntryInformation { + /** + * + */ + private static final long serialVersionUID = 1L; private Duration duration; /** @@ -61,7 +65,7 @@ public class EntryInformationImpl extends AbstractITunesObject implements EntryI /** * Returns the Duration object for this Item - * + * * @return Returns the Duration object for this Item */ @Override @@ -71,7 +75,7 @@ public class EntryInformationImpl extends AbstractITunesObject implements EntryI /** * Sets the Duration object for this Item - * + * * @param duration Sets the Duration object for this Item */ @Override @@ -81,7 +85,7 @@ public class EntryInformationImpl extends AbstractITunesObject implements EntryI /** * Defined by the ROME module API - * + * * @param obj Object to copy from */ @Override @@ -106,7 +110,7 @@ public class EntryInformationImpl extends AbstractITunesObject implements EntryI /** * Required by the ROME API - * + * * @return A clone of this module object */ @Override diff --git a/src/main/java/org/rometools/feed/module/itunes/FeedInformation.java b/src/main/java/org/rometools/feed/module/itunes/FeedInformation.java index e2fd226..7e1d59e 100644 --- a/src/main/java/org/rometools/feed/module/itunes/FeedInformation.java +++ b/src/main/java/org/rometools/feed/module/itunes/FeedInformation.java @@ -45,7 +45,7 @@ import java.util.List; /** * This class contains information for iTunes podcast feeds that exist at the Channel level. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ @@ -53,60 +53,60 @@ public interface FeedInformation extends ITunes { /** * The parent categories for this feed - * + * * @return The parent categories for this feed */ public List getCategories(); /** * The parent categories for this feed - * + * * @param categories The parent categories for this feed */ public void setCategories(List categories); /** * Sets the URL for the image. - * + * * NOTE: To specification images should be in PNG or JPEG format. - * + * * @param image Sets the URL for the image. */ public void setImage(URL image); /** * Returns the URL for the image. - * + * * NOTE: To specification images should be in PNG or JPEG format. - * + * * @return Returns the URL for the image. */ public URL getImage(); /** * Sets the owner email address for the feed. - * + * * @param ownerEmailAddress Sets the owner email address for the feed. */ public void setOwnerEmailAddress(String ownerEmailAddress); /** * Returns the owner email address for the feed. - * + * * @return Returns the owner email address for the feed. */ public String getOwnerEmailAddress(); /** * Sets the owner name for the feed - * + * * @param ownerName Sets the owner name for the feed */ public void setOwnerName(String ownerName); /** * Returns the owner name for the feed - * + * * @return Returns the owner name for the feed */ public String getOwnerName(); diff --git a/src/main/java/org/rometools/feed/module/itunes/FeedInformationImpl.java b/src/main/java/org/rometools/feed/module/itunes/FeedInformationImpl.java index 7277460..87629af 100644 --- a/src/main/java/org/rometools/feed/module/itunes/FeedInformationImpl.java +++ b/src/main/java/org/rometools/feed/module/itunes/FeedInformationImpl.java @@ -51,11 +51,15 @@ import com.sun.syndication.feed.CopyFrom; /** * This class contains information for iTunes podcast feeds that exist at the Channel level. - * + * * @version $Revision: 1.2 $ * @author Robert "kebernet" Cooper */ public class FeedInformationImpl extends AbstractITunesObject implements FeedInformation { + /** + * + */ + private static final long serialVersionUID = 1L; private String ownerName; private String ownerEmailAddress; private URL image; @@ -69,7 +73,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * The parent categories for this feed - * + * * @return The parent categories for this feed */ @Override @@ -79,7 +83,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * The parent categories for this feed - * + * * @param categories The parent categories for this feed */ @Override @@ -89,7 +93,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Returns the owner name for the feed - * + * * @return Returns the owner name for the feed */ @Override @@ -99,7 +103,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Sets the owner name for the feed - * + * * @param ownerName Sets the owner name for the feed */ @Override @@ -109,7 +113,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Returns the owner email address for the feed. - * + * * @return Returns the owner email address for the feed. */ @Override @@ -119,7 +123,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Sets the owner email address for the feed. - * + * * @param ownerEmailAddress Sets the owner email address for the feed. */ @Override @@ -129,9 +133,9 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Returns the URL for the image. - * + * * NOTE: To specification images should be in PNG or JPEG format. - * + * * @return Returns the URL for the image. */ @Override @@ -141,9 +145,9 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Sets the URL for the image. - * + * * NOTE: To specification images should be in PNG or JPEG format. - * + * * @param image Sets the URL for the image. */ @Override @@ -153,7 +157,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Required by the ROME API - * + * * @param obj object to copy property values from */ @Override @@ -189,7 +193,7 @@ public class FeedInformationImpl extends AbstractITunesObject implements FeedInf /** * Returns a copy of this FeedInformationImpl object - * + * * @return Returns a copy of this FeedInformationImpl object */ @Override diff --git a/src/main/java/org/rometools/feed/module/itunes/ITunes.java b/src/main/java/org/rometools/feed/module/itunes/ITunes.java index baf66d5..08b3465 100644 --- a/src/main/java/org/rometools/feed/module/itunes/ITunes.java +++ b/src/main/java/org/rometools/feed/module/itunes/ITunes.java @@ -44,7 +44,7 @@ import com.sun.syndication.feed.module.Module; /** * This interface contains the methods common to all iTunes module points. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.3 $ */ @@ -54,88 +54,88 @@ public interface ITunes extends Module { /** * Returns the author string for this feed or entry - * + * * @return Returns the author string for this feed or entry */ public String getAuthor(); /** * Sets the author string for this feed or entry - * + * * @param author Sets the author string for this feed or entry */ public void setAuthor(String author); /** * Boolean as to whether to block this feed or entry - * + * * @return Boolean as to whether to block this feed or entry */ public boolean getBlock(); /** * Boolean as to whether to block this feed or entry - * + * * @param block Boolean as to whether to block this feed or entry */ public void setBlock(boolean block); /** * Boolean as to whether this feed or entry contains adult content - * + * * @return Boolean as to whether this feed or entry contains adult content */ public boolean getExplicit(); /** * Boolean as to whether this feed or entry contains adult content - * + * * @param explicit Boolean as to whether this feed or entry contains adult content */ public void setExplicit(boolean explicit); /** * A list of keywords for this feed or entry - * + * * Must not contain spaces - * + * * @return A list of keywords for this feed or entry */ public String[] getKeywords(); /** * A list of keywords for this feed or entry - * + * * Must not contain spaces - * + * * @param keywords A list of keywords for this feed or enty */ public void setKeywords(String[] keywords); /** * A subtitle for this feed or entry - * + * * @return A subtitle for this feed or entry */ public String getSubtitle(); /** * A subtitle for this feed or entry - * + * * @param subtitle A subtitle for this feed or entry */ public void setSubtitle(String subtitle); /** * A subtitle for this feed or entry - * + * * @return A subtitle for this feed or entry */ public String getSummary(); /** * A subtitle for this feed or entry - * + * * @param summary A subtitle for this feed or entry */ public void setSummary(String summary); diff --git a/src/main/java/org/rometools/feed/module/itunes/io/ITunesGenerator.java b/src/main/java/org/rometools/feed/module/itunes/io/ITunesGenerator.java index abf3fbc..8884889 100644 --- a/src/main/java/org/rometools/feed/module/itunes/io/ITunesGenerator.java +++ b/src/main/java/org/rometools/feed/module/itunes/io/ITunesGenerator.java @@ -162,7 +162,7 @@ public class ITunesGenerator implements ModuleGenerator { /** * Returns the list of namespaces this module uses. - * + * * @return set of Namespace objects. */ @Override @@ -172,7 +172,7 @@ public class ITunesGenerator implements ModuleGenerator { /** * Returns the namespace URI this module handles. - * + * * @return Returns the namespace URI this module handles. */ @Override diff --git a/src/main/java/org/rometools/feed/module/itunes/io/ITunesParser.java b/src/main/java/org/rometools/feed/module/itunes/io/ITunesParser.java index 1434f7f..6acdd8b 100644 --- a/src/main/java/org/rometools/feed/module/itunes/io/ITunesParser.java +++ b/src/main/java/org/rometools/feed/module/itunes/io/ITunesParser.java @@ -36,7 +36,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. - + */ package org.rometools.feed.module.itunes.io; diff --git a/src/main/java/org/rometools/feed/module/itunes/io/ITunesParserOldNamespace.java b/src/main/java/org/rometools/feed/module/itunes/io/ITunesParserOldNamespace.java index b56e011..8dbeb01 100644 --- a/src/main/java/org/rometools/feed/module/itunes/io/ITunesParserOldNamespace.java +++ b/src/main/java/org/rometools/feed/module/itunes/io/ITunesParserOldNamespace.java @@ -24,7 +24,7 @@ package org.rometools.feed.module.itunes.io; import org.jdom2.Namespace; /** - * + * * @author Robert "kebernet" Cooper */ public class ITunesParserOldNamespace extends ITunesParser { 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 a129499..6d7029f 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 @@ -44,11 +44,15 @@ import java.io.Serializable; /** * 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 */ public class Category implements Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; private String name; private Subcategory subcategory; @@ -58,7 +62,7 @@ public class Category implements Serializable { /** * Creates a new instance of Category with a given name. - * + * * @param name Name of the category. */ public Category(final String name) { @@ -67,7 +71,7 @@ public class Category implements Serializable { /** * Returns the name of the category - * + * * @return Returns the name of the category */ public String getName() { @@ -76,7 +80,7 @@ public class Category implements Serializable { /** * Sets the name of the category - * + * * @param name Sets the name of the category */ public void setName(final String name) { @@ -85,7 +89,7 @@ public class Category implements Serializable { /** * Returns the Subcategory object for this category - * + * * @return Returns the Subcategory object for this category */ public Subcategory getSubcategory() { @@ -94,7 +98,7 @@ public class Category implements Serializable { /** * Sets the Subcategory object for this category - * + * * @param subcategory Sets the Subcategory object for this category */ public void setSubcategory(final Subcategory subcategory) { @@ -103,7 +107,7 @@ public class Category implements Serializable { /** * Returns a copy of this category. - * + * * @return Returns a copy of this category. */ @Override 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 38663f6..11d069a 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 @@ -47,11 +47,15 @@ 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. - * + * * @version $Revision: 1.7 $ * @author Robert "kebernet" Cooper */ public class Duration implements Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; static final long SECOND = 1000; static final long MINUTE = SECOND * 60; static final long HOUR = MINUTE * 60; @@ -73,7 +77,7 @@ public class Duration implements Serializable { /** * Creates a new instance of Duration specifying a length in milliseconds - * + * * @param milliseconds Creates a new instance of Duration specifying a length in milliseconds */ public Duration(final long milliseconds) { @@ -82,7 +86,7 @@ public class Duration implements Serializable { /** * Creates a new duration object with the given hours, minutes and seconds - * + * * @param hours number of hours * @param minutes number of minutes * @param seconds number of seconds @@ -93,30 +97,30 @@ public class Duration implements Serializable { /** * Creates a new Duration parsing the String value. - * + * * @param duration A String to parse */ public Duration(final String duration) { final StringTokenizer tok = new StringTokenizer(duration, ":"); switch (tok.countTokens()) { - case 1: - setMilliseconds((long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND)); - break; - case 2: - setMilliseconds(NumberParser.parseLong(tok.nextToken(), 0l) * MINUTE + (long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND)); - break; - case 3: - setMilliseconds(NumberParser.parseLong(tok.nextToken(), 0l) * HOUR + NumberParser.parseLong(tok.nextToken(), 0l) * MINUTE - + (long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND)); - break; - default: - throw new RuntimeException("Illegal time value: " + duration); + case 1: + setMilliseconds((long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND)); + break; + case 2: + setMilliseconds(NumberParser.parseLong(tok.nextToken(), 0l) * MINUTE + (long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND)); + break; + case 3: + setMilliseconds(NumberParser.parseLong(tok.nextToken(), 0l) * HOUR + NumberParser.parseLong(tok.nextToken(), 0l) * MINUTE + + (long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND)); + break; + default: + throw new RuntimeException("Illegal time value: " + duration); } } /** * Returns a String representation in the formation HH:MM:SS - * + * * @return Returns a String representation in the formation HH:MM:SS */ @Override @@ -128,7 +132,7 @@ public class Duration implements Serializable { /** * Returns the millisecond length - * + * * @return the millisecond length */ public long getMilliseconds() { @@ -137,7 +141,7 @@ public class Duration implements Serializable { /** * Sets the millisecond length - * + * * @param milliseconds the millisecond length */ public void setMilliseconds(final long milliseconds) { diff --git a/src/main/java/org/rometools/feed/module/itunes/types/Subcategory.java b/src/main/java/org/rometools/feed/module/itunes/types/Subcategory.java index 78b7e64..092a5da 100644 --- a/src/main/java/org/rometools/feed/module/itunes/types/Subcategory.java +++ b/src/main/java/org/rometools/feed/module/itunes/types/Subcategory.java @@ -44,11 +44,15 @@ import java.io.Serializable; /** * This class represents a Subcategor of a Category. - * + * * @author Robert "kebernet" Cooper * @version $Revision: 1.2 $ */ public class Subcategory implements Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; private String name; /** Creates a new instance of SubCategory */ @@ -57,7 +61,7 @@ public class Subcategory implements Serializable { /** * Creates a new instance of Category with a given name. - * + * * @param name Name of the category. */ public Subcategory(final String name) { @@ -66,7 +70,7 @@ public class Subcategory implements Serializable { /** * Returns the name of the subcategory. - * + * * @return Returns the name of the subcategory. */ public String getName() { @@ -75,7 +79,7 @@ public class Subcategory implements Serializable { /** * Set the name of the subcategory. - * + * * @param name Set the name of the subcategory. */ public void setName(final String name) { @@ -84,7 +88,7 @@ public class Subcategory implements Serializable { /** * Clones the object. - * + * * @return Clone of the object. */ @Override @@ -97,7 +101,7 @@ public class Subcategory implements Serializable { /** * String representation of the object. - * + * * @return String representation of the object. */ @Override diff --git a/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModule.java b/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModule.java index 675984e..65e1320 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModule.java +++ b/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModule.java @@ -27,20 +27,20 @@ import org.rometools.feed.module.mediarss.types.MediaGroup; /** * Represents entry/item level information. - * + * * @author cooper */ public interface MediaEntryModule extends MediaModule { /** * Returns the MediaContent items for the entry. - * + * * @return Returns the MediaContent items for the entry. */ public MediaContent[] getMediaContents(); /** * Returns the media groups for the entry. - * + * * @return Returns the media groups for the entry. */ public MediaGroup[] getMediaGroups(); 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 db9d7bb..b9cf4d3 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/mediarss/MediaEntryModuleImpl.java @@ -33,7 +33,7 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * Represents information for an Entry/Item level. - * + * * @author Nathanial X. Freitas */ public class MediaEntryModuleImpl extends MediaModuleImpl implements MediaEntryModule, Cloneable, Serializable { @@ -54,7 +54,7 @@ public class MediaEntryModuleImpl extends MediaModuleImpl implements MediaEntryM /** * MediaContent items for the entry - * + * * @param mediaContents MediaContent items for the entry */ public void setMediaContents(final MediaContent[] mediaContents) { @@ -63,7 +63,7 @@ public class MediaEntryModuleImpl extends MediaModuleImpl implements MediaEntryM /** * MediaContent items for the entry - * + * * @return MediaContent items for the entry */ @Override @@ -73,7 +73,7 @@ public class MediaEntryModuleImpl extends MediaModuleImpl implements MediaEntryM /** * MediaGroups for the entry - * + * * @param mediaGroups MediaGroups for the entry */ public void setMediaGroups(final MediaGroup[] mediaGroups) { @@ -82,7 +82,7 @@ public class MediaEntryModuleImpl extends MediaModuleImpl implements MediaEntryM /** * MediaGroups for the entry - * + * * @return MediaGroups for the entry */ @Override 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 01e69d2..f407db8 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/MediaModule.java +++ b/src/main/java/org/rometools/feed/module/mediarss/MediaModule.java @@ -31,7 +31,7 @@ import com.sun.syndication.feed.module.Module; *

* 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 */ public interface MediaModule extends Module { @@ -40,14 +40,14 @@ public interface MediaModule extends Module { /** * Returns Metadata associated with the feed. - * + * * @return Returns Metadata associated with the feed. */ public Metadata getMetadata(); /** * Returns a player reference associated with the feed. - * + * * @return Returns a player reference associated with the feed. */ public PlayerReference getPlayer(); diff --git a/src/main/java/org/rometools/feed/module/mediarss/MediaModuleImpl.java b/src/main/java/org/rometools/feed/module/mediarss/MediaModuleImpl.java index ffef8f0..5b5061f 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/MediaModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/mediarss/MediaModuleImpl.java @@ -31,9 +31,9 @@ import com.sun.syndication.feed.CopyFrom; import com.sun.syndication.feed.module.ModuleImpl; /** - * + * * This class represents feed/channel level elements for MediaRSS - * + * * @author cooper */ public class MediaModuleImpl extends ModuleImpl implements MediaModule, Serializable { @@ -49,7 +49,7 @@ public class MediaModuleImpl extends ModuleImpl implements MediaModule, Serializ /** * constructor that passes values up to ModuleImpl. - * + * * @param clazz * @param uri */ @@ -64,7 +64,7 @@ public class MediaModuleImpl extends ModuleImpl implements MediaModule, Serializ /** * Metadata for a feed. - * + * * @param metadata Metadata for a feed. */ public void setMetadata(final Metadata metadata) { @@ -73,7 +73,7 @@ public class MediaModuleImpl extends ModuleImpl implements MediaModule, Serializ /** * Metadata for a feed. - * + * * @return Metadata for a feed. */ @Override @@ -83,7 +83,7 @@ public class MediaModuleImpl extends ModuleImpl implements MediaModule, Serializ /** * Player for a feed. - * + * * @param player Player for a feed. */ public void setPlayer(final PlayerReference player) { @@ -92,7 +92,7 @@ public class MediaModuleImpl extends ModuleImpl implements MediaModule, Serializ /** * Player for a feed. - * + * * @return Player for a feed. */ @Override diff --git a/src/main/java/org/rometools/feed/module/mediarss/io/AlternateMediaModuleParser.java b/src/main/java/org/rometools/feed/module/mediarss/io/AlternateMediaModuleParser.java index 5ff6145..7ab4593 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/io/AlternateMediaModuleParser.java +++ b/src/main/java/org/rometools/feed/module/mediarss/io/AlternateMediaModuleParser.java @@ -12,7 +12,7 @@ package org.rometools.feed.module.mediarss.io; import org.jdom2.Namespace; /** - * + * * @author cooper */ public class AlternateMediaModuleParser extends MediaModuleParser { diff --git a/src/main/java/org/rometools/feed/module/mediarss/io/MediaModuleParser.java b/src/main/java/org/rometools/feed/module/mediarss/io/MediaModuleParser.java index 9aa8713..34f12a5 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/io/MediaModuleParser.java +++ b/src/main/java/org/rometools/feed/module/mediarss/io/MediaModuleParser.java @@ -55,7 +55,7 @@ import com.sun.syndication.io.impl.NumberParser; /** * @author Nathanial X. Freitas - * + * */ public class MediaModuleParser implements ModuleParser { private static final Logger LOG = Logger.getLogger(MediaModuleParser.class.getName()); @@ -67,7 +67,6 @@ public class MediaModuleParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#getNamespaceUri() */ @Override @@ -78,7 +77,6 @@ public class MediaModuleParser implements ModuleParser { /* * (non-Javadoc) - * * @see com.sun.syndication.io.ModuleParser#parse(org.jdom2.Element) */ @Override diff --git a/src/main/java/org/rometools/feed/module/mediarss/io/RSS20YahooParser.java b/src/main/java/org/rometools/feed/module/mediarss/io/RSS20YahooParser.java index bb83961..1a736ec 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/io/RSS20YahooParser.java +++ b/src/main/java/org/rometools/feed/module/mediarss/io/RSS20YahooParser.java @@ -33,8 +33,8 @@ import com.sun.syndication.io.impl.RSS20Parser; /** * @author Nathanial X. Freitas - * - * + * + * */ public class RSS20YahooParser extends RSS20Parser { // the Yahoo Namespace URI they sometimes use in the returns for video.search.yahoo.com RSS feed @@ -53,7 +53,7 @@ public class RSS20YahooParser extends RSS20Parser { * Indicates if a JDom document is an RSS instance that can be parsed with the parser. *

* It checks for RDF ("http://www.w3.org/1999/02/22-rdf-syntax-ns#") and RSS ("http://purl.org/rss/1.0/") namespaces being defined in the root element. - * + * * @param document document to check if it can be parsed with this parser implementation. * @return true if the document is RSS1., false otherwise. */ @@ -73,7 +73,7 @@ public class RSS20YahooParser extends RSS20Parser { /** * Returns the namespace used by RSS elements in document of the RSS 1.0 *

- * + * * @return returns "http://purl.org/rss/1.0/". */ @Override @@ -83,7 +83,7 @@ public class RSS20YahooParser extends RSS20Parser { /** * After we parse the feed we put "rss_2.0" in it (so converters and generators work) this parser is a phantom. - * + * */ @Override protected WireFeed parseChannel(final Element rssRoot, final Locale locale) { diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/AbstractSchemeValue.java b/src/main/java/org/rometools/feed/module/mediarss/types/AbstractSchemeValue.java index 80339dd..79cd482 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/AbstractSchemeValue.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/AbstractSchemeValue.java @@ -27,7 +27,7 @@ import java.io.Serializable; /** * Simple data bean parent for scheme-value type entities. - * + * * @author cooper */ public abstract class AbstractSchemeValue implements Serializable { 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 afec0b1..3a02de0 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 @@ -28,33 +28,33 @@ import com.sun.syndication.feed.impl.EqualsBean; 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. *

- * + * * 
  * <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'. *

- * + * *

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

- * + * * @author cooper */ public class Category implements Serializable { @@ -69,7 +69,7 @@ public class Category implements Serializable { /** * Creates a new instance of Category - * + * * @param scheme scheme used * @param label label for the category * @param value value of the category item @@ -82,7 +82,7 @@ public class Category implements Serializable { /** * Creates a new Category. - * + * * @param value value of the category. */ public Category(final String value) { @@ -91,7 +91,7 @@ public class Category implements Serializable { /** * 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() { @@ -101,7 +101,7 @@ public class Category implements Serializable { /** * 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'. */ @@ -111,7 +111,7 @@ public class Category implements Serializable { /** * value of the category - * + * * @return value of the category */ public String getValue() { 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 8378b6a..5d3f28b 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 @@ -28,32 +28,32 @@ import com.sun.syndication.feed.impl.EqualsBean; 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. *

- * + * * 
  * <media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
  *
*

* role specifies the role the entity played. Must be lowercase. It is an optional attribute. *

- * + * *

* 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. *

- * - * + * + * *

* Example roles: *

- * + * * 
  * actor
  *        anchor person
@@ -79,7 +79,7 @@ import com.sun.syndication.feed.impl.ToStringBean;
  *
*

* Additional roles: European Broadcasting Union Role Codes - * + * * @author cooper */ public class Credit implements Serializable { @@ -94,7 +94,7 @@ public class Credit implements Serializable { /** * Creates a new instance of Credit - * + * * @param scheme schem used * @param role role name * @param name persons name @@ -111,7 +111,7 @@ public class Credit implements Serializable { /** * Person/organizations name - * + * * @return Person/organizations name */ public String getName() { @@ -120,7 +120,7 @@ public class Credit implements Serializable { /** * Role name - * + * * @return Role name */ public String getRole() { @@ -129,7 +129,7 @@ public class Credit implements Serializable { /** * Scheme used. - * + * * @return Scheme used. */ public String getScheme() { 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 f718a50..849a374 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 @@ -28,22 +28,22 @@ import com.sun.syndication.feed.impl.EqualsBean; 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. *

*

*

- * + * * 
  * <media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
  *
- * + * *

* 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 */ public class Hash extends AbstractSchemeValue implements Serializable { @@ -51,7 +51,7 @@ public class Hash extends AbstractSchemeValue implements Serializable { /** * Creates a new instance of Hash - * + * * @param algorithm algoright used * @param value value of the hash */ @@ -61,7 +61,7 @@ public class Hash extends AbstractSchemeValue implements Serializable { /** * Creates a new instance of Hash assuming the default algorithm of MD5 - * + * * @param algorithm algoright used */ public Hash(final String value) { @@ -70,7 +70,7 @@ public class Hash extends AbstractSchemeValue implements Serializable { /** * Alsorithm used for the hash - * + * * @return Alsorithm used for the hash */ public String getAlgorithm() { 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 74686d3..3821391 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 @@ -33,7 +33,7 @@ import com.sun.syndication.feed.impl.ToStringBean; * 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
  *               url="http://www.foo.com/movie.mov"
@@ -51,7 +51,7 @@ import com.sun.syndication.feed.impl.ToStringBean;
  *               width="300"
  *               lang="en" />
  *
- * + * *

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

@@ -61,24 +61,24 @@ import com.sun.syndication.feed.impl.ToStringBean; *

* type is the standard MIME type of the object. 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. *

- * + * *

* 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. *

@@ -95,31 +95,31 @@ import com.sun.syndication.feed.impl.ToStringBean; *

* duration is the number of seconds the media object plays. It is an optional attribute. *

- * - * - * - * - * + * + * + * + * + * *

* height is the height of the media object. It is an optional attribute. *

*

* width is the width of the media object. 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. *

- * + * * @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. */ @@ -162,7 +162,7 @@ public class MediaContent implements Serializable { /** * Creates a new MediaContent - * + * * @param reference UrlReference or Player reference for the item. */ public MediaContent(final Reference reference) { @@ -177,7 +177,7 @@ 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. */ public void setAudioChannels(final Integer audioChannels) { @@ -186,7 +186,7 @@ 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. */ public Integer getAudioChannels() { @@ -195,7 +195,7 @@ public class MediaContent implements Serializable { /** * bitrate is the kilobits per second rate of media. It is an optional attribute. - * + * * @param bitrate bitrate is the kilobits per second rate of media. It is an optional attribute. */ public void setBitrate(final Float bitrate) { @@ -204,7 +204,7 @@ public class MediaContent implements Serializable { /** * bitrate is the kilobits per second rate of media. It is an optional attribute. - * + * * @return bitrate is the kilobits per second rate of media. It is an optional attribute. */ public Float getBitrate() { @@ -214,7 +214,7 @@ 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. - * + * * @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. */ @@ -225,7 +225,7 @@ 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. - * + * * @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. */ @@ -235,7 +235,7 @@ 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. */ public void setDuration(final Long duration) { @@ -244,7 +244,7 @@ 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. */ public Long getDuration() { @@ -254,7 +254,7 @@ public class MediaContent implements 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. - * + * * @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. */ @@ -265,7 +265,7 @@ public class MediaContent implements 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. - * + * * @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. */ @@ -274,9 +274,9 @@ public class MediaContent implements Serializable { } /** - * + * * fileSize is the number of bytes of the media object. It is an optional attribute. - * + * * @param fileSize The fileSize to set. */ public void setFileSize(final Long fileSize) { @@ -285,7 +285,7 @@ public class MediaContent implements Serializable { /** * fileSize is the number of bytes of the media object. It is an optional attribute. - * + * * @return Returns the fileSize. */ public Long getFileSize() { @@ -294,7 +294,7 @@ public class MediaContent implements Serializable { /** * 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) { @@ -303,7 +303,7 @@ public class MediaContent implements Serializable { /** * 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() { @@ -312,7 +312,7 @@ public class MediaContent implements Serializable { /** * height is the height of the media object. It is an optional attribute. - * + * * @param height height is the height of the media object. It is an optional attribute. */ public void setHeight(final Integer height) { @@ -321,7 +321,7 @@ public class MediaContent implements Serializable { /** * height is the height of the media object. It is an optional attribute. - * + * * @return height is the height of the media object. It is an optional attribute. */ public Integer getHeight() { @@ -331,7 +331,7 @@ 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. - * + * * @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. */ @@ -342,7 +342,7 @@ 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. - * + * * @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. */ @@ -352,7 +352,7 @@ public class MediaContent implements Serializable { /** * Set the value of medium - * + * * @param newmedium new value of medium */ public void setMedium(final String newmedium) { @@ -361,7 +361,7 @@ public class MediaContent implements Serializable { /** * Get the value of medium - * + * * @return the value of medium */ public String getMedium() { @@ -370,7 +370,7 @@ public class MediaContent implements Serializable { /** * The metadata for the item - * + * * @param metadata The metadata for the item */ public void setMetadata(final Metadata metadata) { @@ -379,7 +379,7 @@ public class MediaContent implements Serializable { /** * The metadata for the item - * + * * @return The metadata for the item */ public Metadata getMetadata() { @@ -392,23 +392,23 @@ public class MediaContent implements Serializable { * 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. *

- * + * *

* 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. *

- * + * *

- * + * * @param player PlayerReference for the item. */ public void setPlayer(final PlayerReference player) { @@ -421,21 +421,21 @@ public class MediaContent implements Serializable { * 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. *

- * + * *

* 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. *

- * + * * @return PlayerReference for the item. */ public PlayerReference getPlayer() { @@ -444,7 +444,7 @@ public class MediaContent implements Serializable { /** * The player or URL reference for the item - * + * * @param reference The player or URL reference for the item */ public void setReference(final Reference reference) { @@ -457,7 +457,7 @@ public class MediaContent implements Serializable { /** * The player or URL reference for the item - * + * * @return The player or URL reference for the item */ public Reference getReference() { @@ -467,7 +467,7 @@ 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. - * + * * @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. */ @@ -478,7 +478,7 @@ 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. - * + * * @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. */ @@ -487,9 +487,9 @@ public class MediaContent implements Serializable { } /** - * + * * type is the standard MIME type of the object. It is an optional attribute. - * + * * @param type The type to set. */ public void setType(final String type) { @@ -497,9 +497,9 @@ public class MediaContent implements Serializable { } /** - * + * * type is the standard MIME type of the object. It is an optional attribute. - * + * * @return Returns the type. */ public String getType() { @@ -508,7 +508,7 @@ public class MediaContent implements Serializable { /** * width is the width of the media object. It is an optional attribute. - * + * * @param width width is the width of the media object. It is an optional attribute. */ public void setWidth(final Integer width) { @@ -517,7 +517,7 @@ public class MediaContent implements Serializable { /** * width is the width of the media object. It is an optional attribute. - * + * * @return width is the width of the media object. It is an optional attribute. */ public Integer getWidth() { 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 3a2631f..4ad7909 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 @@ -35,7 +35,7 @@ import com.sun.syndication.feed.impl.ToStringBean; * 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 */ public class MediaGroup implements Cloneable, Serializable { @@ -47,7 +47,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * Creates a new instance of MediaGroup - * + * * @param contents Contents of the group. */ public MediaGroup(final MediaContent[] contents) { @@ -56,7 +56,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * Creates a new instance of MediaGroup - * + * * @param contents contents of the group * @param defaultContentIndex index of the default content value. */ @@ -67,7 +67,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * Creates a new instance of MediaGroup - * + * * @param contents contents of the group * @param defaultContentIndex index of the default content item. * @param metadata metadata for the group. @@ -80,7 +80,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * MediaContents for the group - * + * * @param contents MediaContents for the group */ public void setContents(final MediaContent[] contents) { @@ -89,7 +89,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * MediaContents for the group - * + * * @return MediaContents for the group */ public MediaContent[] getContents() { @@ -98,7 +98,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * Default content index MediaContent. - * + * * @param defaultContentIndex Default content index MediaContent. */ public void setDefaultContentIndex(final Integer defaultContentIndex) { @@ -115,7 +115,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * Default content index MediaContent. - * + * * @return Default content index MediaContent. */ public Integer getDefaultContentIndex() { @@ -124,7 +124,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * Metadata for the group - * + * * @param metadata Metadata for the group */ public void setMetadata(final Metadata metadata) { @@ -133,7 +133,7 @@ public class MediaGroup implements Cloneable, Serializable { /** * Metadata for the group - * + * * @return Metadata for the group */ public Metadata getMetadata() { 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 d32c3da..ba1bac9 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 @@ -30,29 +30,29 @@ import com.sun.syndication.feed.impl.EqualsBean; 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>. - * - * + * + * *

*

- * + * * 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. - * + * * 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 */ public class Metadata implements Cloneable, Serializable { @@ -83,28 +83,28 @@ public class Metadata implements Cloneable, Serializable { *

* 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'. *

- * + * *

* 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 */ public void setCategories(final Category[] categories) { @@ -116,28 +116,28 @@ public class Metadata implements Cloneable, Serializable { *

* 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'. *

- * + * *

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

- * + * * @return categories for the item. */ public Category[] getCategories() { @@ -149,7 +149,7 @@ public class Metadata implements Cloneable, Serializable { *

* Copyright information for media object. It has 1 optional attribute. *

- * + * * 
      * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
      *
@@ -157,7 +157,7 @@ public class Metadata implements Cloneable, Serializable { * 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 */ public void setCopyright(final String copyright) { @@ -169,7 +169,7 @@ public class Metadata implements Cloneable, Serializable { *

* Copyright information for media object. It has 1 optional attribute. *

- * + * * 
      * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
      *
@@ -177,7 +177,7 @@ public class Metadata implements Cloneable, Serializable { * 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 */ public String getCopyright() { @@ -189,7 +189,7 @@ public class Metadata implements Cloneable, Serializable { *

* Copyright information for media object. It has 1 optional attribute. *

- * + * * 
      * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
      *
@@ -197,7 +197,7 @@ public class Metadata implements Cloneable, Serializable { * 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. */ public void setCopyrightUrl(final URI copyrightUrl) { @@ -209,7 +209,7 @@ public class Metadata implements Cloneable, Serializable { *

* Copyright information for media object. It has 1 optional attribute. *

- * + * * 
      * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
      *
@@ -217,7 +217,7 @@ public class Metadata implements Cloneable, Serializable { * 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. */ public URI getCopyrightUrl() { @@ -226,30 +226,30 @@ 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. *

- * + * * 
      * <media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
      *
*

* role specifies the role the entity played. Must be lowercase. It is an optional attribute. *

- * + * *

* 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. *

- * - * + * + * *

* Example roles: *

- * + * * 
      * actor
      *        anchor person
@@ -275,7 +275,7 @@ public class Metadata implements Cloneable, Serializable {
      *
*

* Additional roles: European Broadcasting Union Role Codes - * + * * @param credits credits for the item. */ public void setCredits(final Credit[] credits) { @@ -284,30 +284,30 @@ 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. *

- * + * * 
      * <media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
      *
*

* role specifies the role the entity played. Must be lowercase. It is an optional attribute. *

- * + * *

* 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. *

- * - * + * + * *

* Example roles: *

- * + * * 
      * actor
      *        anchor person
@@ -333,7 +333,7 @@ public class Metadata implements Cloneable, Serializable {
      *
*

* Additional roles: European Broadcasting Union Role Codes - * + * * @return credits for the time. */ public Credit[] getCredits() { @@ -345,7 +345,7 @@ public class Metadata implements Cloneable, Serializable { *

* 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>
      *
@@ -353,7 +353,7 @@ 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. *

- * + * * @param description value of the description */ public void setDescription(final String description) { @@ -365,7 +365,7 @@ public class Metadata implements Cloneable, Serializable { *

* 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>
      *
@@ -373,7 +373,7 @@ 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. *

- * + * * @return value of the description */ public String getDescription() { @@ -385,7 +385,7 @@ public class Metadata implements Cloneable, Serializable { *

* 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>
      *
@@ -393,7 +393,7 @@ 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. *

- * + * * @param descriptionType type of the description. */ public void setDescriptionType(final String descriptionType) { @@ -405,7 +405,7 @@ public class Metadata implements Cloneable, Serializable { *

* 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>
      *
@@ -413,7 +413,7 @@ 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. *

- * + * * @return type of the description */ public String getDescriptionType() { @@ -422,22 +422,22 @@ 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. *

*

*

- * + * * 
      * <media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
      *
- * + * *

* 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. */ public void setHash(final Hash hash) { @@ -446,22 +446,22 @@ 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. *

*

*

- * + * * 
      * <media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
      *
- * + * *

* 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. */ public Hash getHash() { @@ -473,11 +473,11 @@ public class Metadata implements Cloneable, Serializable { *

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

- * + * * 
      * <media:keywords>kitty, cat, big dog, yarn, fluffy</media:keywords>
      *
- * + * * @param keywords Array of keywords */ public void setKeywords(final String[] keywords) { @@ -489,11 +489,11 @@ public class Metadata implements Cloneable, Serializable { *

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

- * + * * 
      * <media:keywords>kitty, cat, big dog, yarn, fluffy</media:keywords>
      *
- * + * * @return Array of keywords */ public String[] getKeywords() { @@ -502,29 +502,29 @@ public class Metadata implements Cloneable, Serializable { /** * <media:rating>

- * - * + * + * *

* 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). *

- * + * *

- * + * * @param ratings Ratings objects */ public void setRatings(final Rating[] ratings) { @@ -533,29 +533,29 @@ public class Metadata implements Cloneable, Serializable { /** * <media:rating>

- * - * + * + * *

* 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). *

- * + * *

- * + * * @return Ratings objects */ public Rating[] getRatings() { @@ -564,7 +564,7 @@ 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 @@ -572,16 +572,16 @@ public class Metadata implements Cloneable, Serializable { * 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). *

- * + * * 
      * <media:restriction relationship="allow" type="country">au us</media:restriction>
      *
- * + * *

* 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. */ public void setRestrictions(final Restriction[] restrictions) { @@ -590,7 +590,7 @@ 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 @@ -598,16 +598,16 @@ public class Metadata implements Cloneable, Serializable { * 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). *

- * + * * 
      * <media:restriction relationship="allow" type="country">au us</media:restriction>
      *
- * + * *

* 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. */ public Restriction[] getRestrictions() { @@ -621,11 +621,11 @@ public class Metadata implements Cloneable, Serializable { * 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>
      *
@@ -633,26 +633,26 @@ 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. *

- * - * - * - * - * - * + * + * + * + * + * + * *

* 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. *

- * + * *

* 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. */ public void setText(final Text[] text) { @@ -666,11 +666,11 @@ public class Metadata implements Cloneable, Serializable { * 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>
      *
@@ -678,26 +678,26 @@ 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. *

- * - * - * - * - * - * + * + * + * + * + * + * *

* 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. *

- * + * *

* 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. */ public Text[] getText() { @@ -706,17 +706,17 @@ public class Metadata implements Cloneable, Serializable { /** * <media:thumbnail>

- * - * + * + * *

* 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. *

- * - * - * - * - * + * + * + * + * + * * 
      * <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
      *
@@ -729,14 +729,14 @@ public class Metadata implements Cloneable, Serializable { *

* width specifies the width of the thumbnail. 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 */ public void setThumbnail(final Thumbnail[] thumbnail) { @@ -745,17 +745,17 @@ public class Metadata implements Cloneable, Serializable { /** * <media:thumbnail>

- * - * + * + * *

* 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. *

- * - * - * - * - * + * + * + * + * + * * 
      * <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
      *
@@ -768,14 +768,14 @@ public class Metadata implements Cloneable, Serializable { *

* width specifies the width of the thumbnail. 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 */ public Thumbnail[] getThumbnail() { @@ -787,16 +787,16 @@ public class Metadata implements Cloneable, Serializable { *

* The title of the particular media object. It has 1 optional attribute. *

- * + * * 
      * <media:title type="plain">The Judy's - The Moo Song</media:title>
      *
- * + * *

* 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 */ public void setTitle(final String title) { @@ -808,16 +808,16 @@ public class Metadata implements Cloneable, Serializable { *

* The title of the particular media object. It has 1 optional attribute. *

- * + * * 
      * <media:title type="plain">The Judy's - The Moo Song</media:title>
      *
- * + * *

* 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. */ public String getTitle() { @@ -829,16 +829,16 @@ public class Metadata implements Cloneable, Serializable { *

* The title of the particular media object. It has 1 optional attribute. *

- * + * * 
      * <media:title type="plain">The Judy's - The Moo Song</media:title>
      *
- * + * *

* 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. */ public void setTitleType(final String titleType) { @@ -850,16 +850,16 @@ public class Metadata implements Cloneable, Serializable { *

* The title of the particular media object. It has 1 optional attribute. *

- * + * * 
      * <media:title type="plain">The Judy's - The Moo Song</media:title>
      *
- * + * *

* 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 */ public String getTitleType() { @@ -871,7 +871,7 @@ public class Metadata implements Cloneable, Serializable { *

* Copyright information for media object. It has 1 optional attribute. *

- * + * * 
      * <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
      *
@@ -879,7 +879,7 @@ public class Metadata implements Cloneable, Serializable { * 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. */ @Override 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 6dee0d3..b8893f5 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 @@ -29,27 +29,27 @@ import com.sun.syndication.feed.impl.EqualsBean; 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. *

- * + * * 
  * <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. *

- * + * *

* 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. *

- * + * * @author cooper */ public class PlayerReference implements Reference, Serializable { @@ -61,7 +61,7 @@ public class PlayerReference implements Reference, Serializable { /** * Creates a new instance of PlayerReference - * + * * @param url url of the player * @param width width of the player * @param height height of the player @@ -80,7 +80,7 @@ public class PlayerReference implements Reference, Serializable { /** * Constructs a new PlayerReference - * + * * @param url URL of the player */ public PlayerReference(final URI url) { @@ -89,7 +89,7 @@ public class PlayerReference implements Reference, Serializable { /** * Height of the player - * + * * @return Height of the player */ public Integer getHeight() { @@ -98,7 +98,7 @@ public class PlayerReference implements Reference, Serializable { /** * URL of the player - * + * * @return URL of the player */ public URI getUrl() { @@ -107,7 +107,7 @@ public class PlayerReference implements Reference, Serializable { /** * Width of the player - * + * * @return Width of the player */ public Integer getWidth() { 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 f2c16e5..bb25729 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 @@ -27,29 +27,29 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * <media:rating>

- * - * + * + * *

* 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). *

- * + * * For compatibility, a medai:adult tag will appear in the ratings as a urn:simple equiv. - * + * * @author cooper */ public class Rating extends AbstractSchemeValue { @@ -67,7 +67,7 @@ public class Rating extends AbstractSchemeValue { /** * Constructs a new Rating object. - * + * * @param scheme scheme used for the rating * @param value value of the rating. */ @@ -76,7 +76,7 @@ public class Rating extends AbstractSchemeValue { } /** - * + * * @param obj * @return */ @@ -88,7 +88,7 @@ public class Rating extends AbstractSchemeValue { } /** - * + * * @return */ @Override @@ -99,7 +99,7 @@ public class Rating extends AbstractSchemeValue { } /** - * + * * @return */ @Override 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 9039863..7302822 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 @@ -24,7 +24,7 @@ package org.rometools.feed.module.mediarss.types; /** * This class is an idenfier for UrlReference and PlayerReference and is required for constructing a MediaContent object. - * + * * @author cooper */ public interface Reference { 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 f6cfc74..5da3149 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 @@ -29,7 +29,7 @@ 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 @@ -37,16 +37,16 @@ import com.sun.syndication.feed.impl.ToStringBean; * 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). *

- * + * * 
  * <media:restriction relationship="allow" type="country">au us</media:restriction>
  *
- * + * *

* 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. @@ -54,22 +54,22 @@ import com.sun.syndication.feed.impl.ToStringBean; *

* A more explicit method would be: *

- * + * * 
  * <media:restriction relationship="allow" type="country">au us</media:restriction>
  *
- * + * *

* 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] *

*

* "uri" allows restrictions based on URI. Examples: urn:apple, http://images.google.com, urn:yahoo, etc. - * + * * @author cooper */ public class Restriction implements Serializable { @@ -81,7 +81,7 @@ public class Restriction implements Serializable { /** * Creates a new instance of Restriction - * + * * @param relationship a Restriction.Relationship object * @param type A Restriction.Type object * @param value a value for the restriction. 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 c557335..3e794af 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 @@ -34,11 +34,11 @@ import com.sun.syndication.feed.impl.ToStringBean; * 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>
  *
@@ -46,27 +46,27 @@ import com.sun.syndication.feed.impl.ToStringBean; * 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. *

- * - * - * - * - * - * + * + * + * + * + * + * *

* 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. *

- * + * *

* 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 */ public class Text implements Serializable { @@ -78,7 +78,7 @@ public class Text implements Serializable { /** * Creates a text object. - * + * * @param value value of the text */ public Text(final String value) { @@ -87,7 +87,7 @@ public class Text implements Serializable { /** * Creates a new instance of Text - * + * * @param type type of text * @param value value of text */ @@ -98,7 +98,7 @@ public class Text implements Serializable { /** * Creates a text object with start and end times - * + * * @param type type of text * @param value value of text * @param start start time @@ -112,7 +112,7 @@ public class Text implements Serializable { /** * End time of the text - * + * * @return End time of the text */ public Time getEnd() { @@ -121,7 +121,7 @@ public class Text implements Serializable { /** * Start time of the text - * + * * @return Start time of the text */ public Time getStart() { @@ -130,7 +130,7 @@ public class Text implements Serializable { /** * type of the text - * + * * @return type of the text */ public String getType() { @@ -139,7 +139,7 @@ public class Text implements Serializable { /** * Value of the text - * + * * @return type of the text */ public String getValue() { 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 6b0393b..c4e7cb3 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 @@ -29,17 +29,17 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * <media:thumbnail>

- * - * + * + * *

* 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. *

- * - * - * - * - * + * + * + * + * + * * 
  * <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
  *
@@ -52,8 +52,8 @@ import com.sun.syndication.feed.impl.ToStringBean; *

* width specifies the width of the thumbnail. 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 @@ -70,7 +70,7 @@ public class Thumbnail implements Cloneable, Serializable { /** * Creates a new thumbnail - * + * * @param url URL to thumbnail * @param width width in pixels * @param height height in pixels @@ -85,7 +85,7 @@ public class Thumbnail implements Cloneable, Serializable { /** * Creates a new thumbnail - * + * * @param url URL * @param width width * @param height height @@ -96,7 +96,7 @@ public class Thumbnail implements Cloneable, Serializable { /** * Creates a new thumbnail - * + * * @param url URL */ public Thumbnail(final URI url) { @@ -104,9 +104,9 @@ public class Thumbnail implements Cloneable, Serializable { } /** - * + * * Returns the thumbHeight. - * + * * @return Returns the thumbHeight. */ public Integer getHeight() { @@ -115,7 +115,7 @@ public class Thumbnail implements Cloneable, Serializable { /** * returns the time that the thumbnail was captured from its source - * + * * @return returns the time that the thumbnail was captured from its source */ public Time getTime() { @@ -123,9 +123,9 @@ public class Thumbnail implements Cloneable, Serializable { } /** - * + * * Retursn the URL - * + * * @return Returns the thumbUrl. */ public URI getUrl() { @@ -133,9 +133,9 @@ public class Thumbnail implements Cloneable, Serializable { } /** - * + * * Returns width. - * + * * @return Returns the thumbWidth. */ public Integer getWidth() { 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 3fd26b4..55c4e00 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 @@ -29,7 +29,7 @@ import com.sun.syndication.feed.impl.EqualsBean; /** * Represents a RFC 2326 3.6 Normal Play Time timestamp. - * + * * @author cooper */ public class Time implements Serializable { @@ -48,7 +48,7 @@ public class Time implements Serializable { /** * Creates a new instance of Time - * + * * @param milliseconds milliseconds in length or offset. */ public Time(final long milliseconds) { @@ -57,7 +57,7 @@ public class Time implements Serializable { /** * Creates a new instance of Time - * + * * @param value RFC 2326 3.6 Normal Play Time value */ public Time(final String value) { diff --git a/src/main/java/org/rometools/feed/module/mediarss/types/UrlReference.java b/src/main/java/org/rometools/feed/module/mediarss/types/UrlReference.java index 3240a85..c3aa720 100644 --- a/src/main/java/org/rometools/feed/module/mediarss/types/UrlReference.java +++ b/src/main/java/org/rometools/feed/module/mediarss/types/UrlReference.java @@ -31,7 +31,7 @@ import com.sun.syndication.feed.impl.EqualsBean; /** * Used to indicate a URL primary reference for a MediaContent object. - * + * * @author cooper */ public class UrlReference implements Reference, Serializable { @@ -41,7 +41,7 @@ public class UrlReference implements Reference, Serializable { /** * Creates a new UrlReference. - * + * * @param url URL to the media source */ public UrlReference(final URI url) { @@ -54,7 +54,7 @@ public class UrlReference implements Reference, Serializable { /** * Creates a new instance of UrlReference - * + * * @param url String value of a URL * @throws java.net.MalformedURLException thrown on bad URLs */ @@ -70,7 +70,7 @@ public class UrlReference implements Reference, Serializable { /** * Returns the URL value - * + * * @return Returns the URL value */ public URI getUrl() { diff --git a/src/main/java/org/rometools/feed/module/opensearch/OpenSearchModule.java b/src/main/java/org/rometools/feed/module/opensearch/OpenSearchModule.java index b02d925..09ec0df 100644 --- a/src/main/java/org/rometools/feed/module/opensearch/OpenSearchModule.java +++ b/src/main/java/org/rometools/feed/module/opensearch/OpenSearchModule.java @@ -19,7 +19,7 @@ import com.sun.syndication.feed.module.Module; /** * Provides access to A9 Open Search information. - * + * * @author Michael W. Nassif (enrouteinc@gmail.com) */ public interface OpenSearchModule extends Module, OpenSearchResponse { 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 fdd7812..93be7e4 100644 --- a/src/main/java/org/rometools/feed/module/opensearch/OpenSearchResponse.java +++ b/src/main/java/org/rometools/feed/module/opensearch/OpenSearchResponse.java @@ -23,85 +23,85 @@ import com.sun.syndication.feed.atom.Link; /** * Provides access to A9 Open Search information. - * + * * @author Michael W. Nassif (enrouteinc@gmail.com) */ 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. - * + * * @param totalResults A positive integer value. */ public void setTotalResults(int totalResults); /** * # 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. - * + * * @return a positive integer value. */ public int getTotalResults(); /** * # 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. - * + * * @param startIndex int value >= 1. */ public void setStartIndex(int startIndex); /** * # 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. - * + * * @return int value >= 1. */ public int getStartIndex(); /** * # 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. - * + * * @param itemsPerPage int value >= 1. */ public void setItemsPerPage(int itemsPerPage); /** * # 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. - * + * * @return int value >= 1 */ public int getItemsPerPage(); /** * # 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. - * + * * @param link link to the open search spec. */ public void setLink(Link link); /** * # 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. - * + * * @return link to the opensearch spec. */ public Link getLink(); @@ -113,7 +113,7 @@ public interface OpenSearchResponse { *

    *
  • Note: New in version 1.1.
    • *
  • Requirements: May appear zero or more times. Note that the “Q” is capitalized.
    • - * + * * @param query List of OSQuery objects. */ public void setQueries(List query); @@ -124,7 +124,7 @@ public interface OpenSearchResponse { *
      *
    • Note: New in version 1.1.
      • *
    • Requirements: May appear zero or more times. Note that the “Q” is capitalized.
      • - * + * * @return A list of OSQuery objects. */ public List getQueries(); @@ -132,7 +132,7 @@ public interface OpenSearchResponse { // convenience method /** * Adds a query to the module. - * + * * @param query OSQuery object to add. */ public void addQuery(OSQuery query); 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 1897dd5..bdbd71e 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 @@ -46,10 +46,10 @@ public class OSQuery implements Cloneable, Serializable { /** * Creates a deep 'bean' clone of the object. *

      - * + * * @return a clone of the object. * @throws CloneNotSupportedException thrown if an element of the object cannot be cloned. - * + * */ @Override public Object clone() throws CloneNotSupportedException { @@ -59,10 +59,10 @@ public class OSQuery implements Cloneable, Serializable { /** * 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. * @return true if 'this' object is equal to the 'other' object. - * + * */ @Override public boolean equals(final Object other) { @@ -74,9 +74,9 @@ public class OSQuery implements Cloneable, Serializable { *

      * It follows the contract defined by the Object hashCode() method. *

      - * + * * @return the hashcode of the bean object. - * + * */ @Override public int hashCode() { @@ -86,9 +86,9 @@ public class OSQuery implements Cloneable, Serializable { /** * Returns the String representation for the object. *

      - * + * * @return String representation for the object. - * + * */ @Override public String toString() { @@ -104,7 +104,7 @@ public class OSQuery implements Cloneable, Serializable { /** * Typically represents a url link to the os description file - * + * * @param osd The osd to set. */ public void setOsd(final String osd) { 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 8662e79..cabc7e5 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 @@ -57,7 +57,7 @@ public class OpenSearchModuleGenerator implements ModuleGenerator { * 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. */ @Override diff --git a/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleImpl.java b/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleImpl.java index 57daf7a..b6b4996 100644 --- a/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleImpl.java @@ -131,7 +131,6 @@ public class OpenSearchModuleImpl extends ModuleImpl implements OpenSearchModule /* * (non-Javadoc) - * * @see com.sun.syndication.feed.CopyFrom#copyFrom(java.lang.Object) */ @Override @@ -152,7 +151,6 @@ public class OpenSearchModuleImpl extends ModuleImpl implements OpenSearchModule /* * (non-Javadoc) - * * @see com.sun.syndication.feed.CopyFrom#getInterface() */ @Override 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 29fc33a..fd04873 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 @@ -154,21 +154,21 @@ public class OpenSearchModuleParser implements ModuleParser { final Link link = new Link(); String att = e.getAttributeValue("rel");// getAtomNamespace()); DONT - // KNOW WHY DOESN'T WORK + // KNOW WHY DOESN'T WORK if (att != null) { link.setRel(att); } att = e.getAttributeValue("type");// getAtomNamespace()); DONT KNOW WHY - // DOESN'T WORK + // DOESN'T WORK if (att != null) { link.setType(att); } att = e.getAttributeValue("href");// getAtomNamespace()); DONT KNOW WHY - // DOESN'T WORK + // DOESN'T WORK if (att != null) { @@ -180,14 +180,14 @@ public class OpenSearchModuleParser implements ModuleParser { } att = e.getAttributeValue("hreflang");// getAtomNamespace()); DONT KNOW - // WHY DOESN'T WORK + // WHY DOESN'T WORK if (att != null) { link.setHreflang(att); } att = e.getAttributeValue("length");// getAtomNamespace()); DONT KNOW - // WHY DOESN'T WORK + // WHY DOESN'T WORK return link; } 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 6e7fc80..a62dbae 100644 --- a/src/main/java/org/rometools/feed/module/photocast/PhotocastModule.java +++ b/src/main/java/org/rometools/feed/module/photocast/PhotocastModule.java @@ -48,9 +48,9 @@ import com.sun.syndication.feed.module.Module; /** * This is a ROME module that provides support for the "http://www.apple.com/ilife/wallpapers" namespace. - * + * * See the package information for example usage. - * + * * @author Robert "kebernet" Cooper */ public interface PhotocastModule extends Module { @@ -61,70 +61,70 @@ public interface PhotocastModule extends Module { /** * Returns the Item level photoDate value. - * + * * @return Returns the Item level photoDate value. */ public Date getPhotoDate(); /** * Set the Item level photoDate value. - * + * * @param photoDate Item level photoDate value */ public void setPhotoDate(Date photoDate); /** * Returns the cropDate value from the item level. - * + * * @return Item level cropDate value */ public Date getCropDate(); /** * Sets the cropDate value for the item level. - * + * * @param cropDate cropDate value for the item level */ public void setCropDate(Date cropDate); /** * The URL of the image. - * + * * @return The URL of the image. */ public URL getImageUrl(); /** * The URL of the image. - * + * * @param imageUrl The URL of the image. */ public void setImageUrl(URL imageUrl); /** * The URL of the image thumbnail. - * + * * @return The URL of the image thumbnail. */ public URL getThumbnailUrl(); /** * The URL of the image thumbnail. - * + * * @param thumbnailUrl The URL of the image thumbnail. */ public void setThumbnailUrl(URL thumbnailUrl); /** * The iPhoto metadata for the image. - * + * * @return The iPhoto metadata for the image. */ public Metadata getMetadata(); /** * The iPhoto metadata for the image. - * + * * @param metadata The iPhoto metadata for the image. */ public void setMetadata(Metadata metadata); diff --git a/src/main/java/org/rometools/feed/module/photocast/PhotocastModuleImpl.java b/src/main/java/org/rometools/feed/module/photocast/PhotocastModuleImpl.java index a0db0b7..c319c0b 100644 --- a/src/main/java/org/rometools/feed/module/photocast/PhotocastModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/photocast/PhotocastModuleImpl.java @@ -51,10 +51,14 @@ import com.sun.syndication.feed.impl.EqualsBean; import com.sun.syndication.feed.impl.ToStringBean; /** - * + * * @author Robert "kebernet" Cooper */ public class PhotocastModuleImpl implements PhotocastModule { + /** + * + */ + private static final long serialVersionUID = 1L; private Date photoDate; private Date cropDate; private URL imageUrl; diff --git a/src/main/java/org/rometools/feed/module/photocast/io/Generator.java b/src/main/java/org/rometools/feed/module/photocast/io/Generator.java index 8135177..cc33e4f 100644 --- a/src/main/java/org/rometools/feed/module/photocast/io/Generator.java +++ b/src/main/java/org/rometools/feed/module/photocast/io/Generator.java @@ -52,7 +52,7 @@ import com.sun.syndication.feed.module.Module; import com.sun.syndication.io.ModuleGenerator; /** - * + * * @author Robert "kebernet" Cooper */ public class Generator implements ModuleGenerator { diff --git a/src/main/java/org/rometools/feed/module/photocast/io/Parser.java b/src/main/java/org/rometools/feed/module/photocast/io/Parser.java index 57b97b5..0a3514f 100644 --- a/src/main/java/org/rometools/feed/module/photocast/io/Parser.java +++ b/src/main/java/org/rometools/feed/module/photocast/io/Parser.java @@ -60,7 +60,7 @@ import com.sun.syndication.feed.module.Module; import com.sun.syndication.io.ModuleParser; /** - * + * * @author Robert "kebernet" Cooper */ public class Parser implements ModuleParser { 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 81bef28..de93459 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 @@ -46,7 +46,7 @@ import com.sun.syndication.feed.impl.ToStringBean; /** * This is an immutable class representing the apple-wallpapers:metadata tag in the photocast module. - * + * * @author Robert "kebernet" Cooper */ public class Metadata { @@ -56,7 +56,7 @@ public class Metadata { /** * Creates a new instance of Metadata with a set photoDate and comments value. - * + * * @param photoDate PhotoDate value to use * @param comments comments about this photo. */ @@ -67,7 +67,7 @@ public class Metadata { /** * Returns the PhotoDate value. - * + * * @return Returns the PhotoDate value. */ public PhotoDate getPhotoDate() { @@ -76,7 +76,7 @@ public class Metadata { /** * Returns comments about the photo. - * + * * @return Returns comments about the photo. */ public String getComments() { @@ -85,7 +85,7 @@ public class Metadata { /** * Returns a String representation of the metadata object. - * + * * @return Returns a String representation of the metadata object. */ @Override 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 0aef960..ebebb70 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 @@ -47,11 +47,15 @@ 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. - * + * * @author Robert "kebernet" Cooper */ public class PhotoDate extends Date { + /** + * + */ + private static final long serialVersionUID = 1L; private static final long Y2K = 946616400531l; private static final double DAY = 24 * 60 * 60 * 1000; @@ -62,7 +66,7 @@ public class PhotoDate extends Date { /** * Creates a new instance of PhotoDate with the timestamp provided. - * + * * @param time milliseconds time */ public PhotoDate(final long time) { @@ -71,7 +75,7 @@ public class PhotoDate extends Date { /** * 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 */ public PhotoDate(final double photoDateValue) { @@ -83,7 +87,7 @@ public class PhotoDate extends Date { /** * Returns a string representing the fractional number of days since 00:00:00 01/01/00. - * + * * @return Returns a string representing the fractional number of days since 00:00:00 01/01/00. */ @Override diff --git a/src/main/java/org/rometools/feed/module/portablecontacts/ContactModule.java b/src/main/java/org/rometools/feed/module/portablecontacts/ContactModule.java index b768510..adb80c1 100644 --- a/src/main/java/org/rometools/feed/module/portablecontacts/ContactModule.java +++ b/src/main/java/org/rometools/feed/module/portablecontacts/ContactModule.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -18,7 +18,7 @@ package org.rometools.feed.module.portablecontacts; /** - * + * * @author robert.cooper */ public interface ContactModule { diff --git a/src/main/java/org/rometools/feed/module/portablecontacts/types/Address.java b/src/main/java/org/rometools/feed/module/portablecontacts/types/Address.java index 8c331c5..e3a7736 100644 --- a/src/main/java/org/rometools/feed/module/portablecontacts/types/Address.java +++ b/src/main/java/org/rometools/feed/module/portablecontacts/types/Address.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -18,7 +18,7 @@ package org.rometools.feed.module.portablecontacts.types; /** - * + * * @author robert.cooper */ public class Address { diff --git a/src/main/java/org/rometools/feed/module/slash/Slash.java b/src/main/java/org/rometools/feed/module/slash/Slash.java index bbd5019..e189d35 100644 --- a/src/main/java/org/rometools/feed/module/slash/Slash.java +++ b/src/main/java/org/rometools/feed/module/slash/Slash.java @@ -46,7 +46,7 @@ import com.sun.syndication.feed.module.Module; /** * This interface represents the Slash RSS extension. - * + * * @version $Revision: 1.2 $ * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/slash/SlashImpl.java b/src/main/java/org/rometools/feed/module/slash/SlashImpl.java index eee5d5d..94a263f 100644 --- a/src/main/java/org/rometools/feed/module/slash/SlashImpl.java +++ b/src/main/java/org/rometools/feed/module/slash/SlashImpl.java @@ -3,7 +3,7 @@ * * Created on November 19, 2005, 8:53 PM * - * + * * This library is provided under dual licenses. * You may choose the terms of the Lesser General Public License or the Apache * License at your discretion. @@ -50,6 +50,11 @@ import com.sun.syndication.feed.impl.EqualsBean; */ public class SlashImpl implements Slash { + /** + * + */ + private static final long serialVersionUID = 1L; + private String section; private String department; diff --git a/src/main/java/org/rometools/feed/module/slash/io/SlashModuleGenerator.java b/src/main/java/org/rometools/feed/module/slash/io/SlashModuleGenerator.java index c9bec76..3be208c 100644 --- a/src/main/java/org/rometools/feed/module/slash/io/SlashModuleGenerator.java +++ b/src/main/java/org/rometools/feed/module/slash/io/SlashModuleGenerator.java @@ -51,7 +51,7 @@ import com.sun.syndication.io.ModuleGenerator; /** * The ModuleGenerator implementation for the Slash plug in. - * + * * @version $Revision: 1.1 $ * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/slash/io/SlashModuleParser.java b/src/main/java/org/rometools/feed/module/slash/io/SlashModuleParser.java index 9803478..8e3f380 100644 --- a/src/main/java/org/rometools/feed/module/slash/io/SlashModuleParser.java +++ b/src/main/java/org/rometools/feed/module/slash/io/SlashModuleParser.java @@ -53,7 +53,7 @@ import com.sun.syndication.io.ModuleParser; /** * ModuleParser implementation for Slash RSS. - * + * * @version $Revision: 1.3 $ * @author Robert "kebernet" Cooper */ 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 dad5822..259ec1b 100644 --- a/src/main/java/org/rometools/feed/module/sle/SimpleListExtension.java +++ b/src/main/java/org/rometools/feed/module/sle/SimpleListExtension.java @@ -24,7 +24,7 @@ import com.sun.syndication.feed.module.Module; /** * This is the primary module interface for the MS Simple List Extensions. - * + * * @author Robert "kebernet" Cooper */ public interface SimpleListExtension extends Module { @@ -37,7 +37,7 @@ public interface SimpleListExtension extends Module { * 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); @@ -46,7 +46,7 @@ public interface SimpleListExtension extends Module { * 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(); @@ -54,7 +54,7 @@ public interface SimpleListExtension extends Module { /** * 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); @@ -62,7 +62,7 @@ public interface SimpleListExtension extends Module { /** * 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(); @@ -70,14 +70,14 @@ public interface SimpleListExtension extends Module { /** * 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. - * + * * @return treatAs value. */ public String getTreatAs(); diff --git a/src/main/java/org/rometools/feed/module/sle/SimpleListExtensionImpl.java b/src/main/java/org/rometools/feed/module/sle/SimpleListExtensionImpl.java index daa0397..1c2dd61 100644 --- a/src/main/java/org/rometools/feed/module/sle/SimpleListExtensionImpl.java +++ b/src/main/java/org/rometools/feed/module/sle/SimpleListExtensionImpl.java @@ -24,10 +24,14 @@ import com.sun.syndication.feed.CopyFrom; import com.sun.syndication.feed.module.ModuleImpl; /** - * + * * @author Robert "kebernet" Cooper */ public class SimpleListExtensionImpl extends ModuleImpl implements SimpleListExtension { + /** + * + */ + private static final long serialVersionUID = 1L; private String treatAs = "list"; private Group[] groupFields; private Sort[] sortFields; @@ -52,7 +56,7 @@ public class SimpleListExtensionImpl extends ModuleImpl implements SimpleListExt *

      * This is useful when dealing with properties that may have multiple implementations. For example, Module. *

      - * + * * @return the interface the copyFrom works on. */ @Override @@ -83,7 +87,7 @@ public class SimpleListExtensionImpl extends ModuleImpl implements SimpleListExt /** * Returns the URI of the module. *

      - * + * * @return URI of the module. */ @Override @@ -99,7 +103,7 @@ public class SimpleListExtensionImpl extends ModuleImpl implements SimpleListExt * This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a * Hibernate ready implementation. *

      - * + * * @param obj the instance to copy properties from. */ @Override 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 0e630c0..beed519 100644 --- a/src/main/java/org/rometools/feed/module/sle/SleEntry.java +++ b/src/main/java/org/rometools/feed/module/sle/SleEntry.java @@ -27,7 +27,7 @@ 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. - * + * * @author Robert "kebernet" Cooper */ public interface SleEntry extends Module { @@ -38,7 +38,7 @@ public interface SleEntry extends Module { /** * Returns an EntryValue for the given element name. - * + * * @param element element name to look for * @return Returns an EntryValue for the given element name. */ @@ -46,14 +46,14 @@ public interface SleEntry extends Module { /** * An array of EntryValue objects that correspond to the grouping for the feed. - * + * * @return An array of EntryValue objects that correspond to the grouping for the feed. */ public EntryValue[] getGroupValues(); /** * Returns an EntryValue for the given element name. - * + * * @param element element name * @return Returns an EntryValue for the given element name. */ @@ -61,11 +61,11 @@ 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! - * + * * @return Array of EntryValue implementations from this entry. */ public EntryValue[] getSortValues(); diff --git a/src/main/java/org/rometools/feed/module/sle/SleEntryImpl.java b/src/main/java/org/rometools/feed/module/sle/SleEntryImpl.java index 1f8024b..002d5fe 100644 --- a/src/main/java/org/rometools/feed/module/sle/SleEntryImpl.java +++ b/src/main/java/org/rometools/feed/module/sle/SleEntryImpl.java @@ -29,10 +29,14 @@ import com.sun.syndication.feed.impl.ObjectBean; /** * 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 */ public class SleEntryImpl implements SleEntry { + /** + * + */ + private static final long serialVersionUID = 1L; private static final EntryValue[] EMPTY_VALUES = new EntryValue[0]; private final ObjectBean obj = new ObjectBean(SleEntryImpl.class, this); private EntryValue[] groupValues = EMPTY_VALUES; @@ -70,7 +74,7 @@ public class SleEntryImpl implements SleEntry { *

      * This is useful when dealing with properties that may have multiple implementations. For example, Module. *

      - * + * * @return the interface the copyFrom works on. */ @Override @@ -106,7 +110,7 @@ public class SleEntryImpl implements SleEntry { /** * Returns the URI of the module. *

      - * + * * @return URI of the module. */ @Override @@ -127,7 +131,7 @@ public class SleEntryImpl implements SleEntry { * This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a * Hibernate ready implementation. *

      - * + * * @param obj the instance to copy properties from. */ @Override diff --git a/src/main/java/org/rometools/feed/module/sle/SleUtility.java b/src/main/java/org/rometools/feed/module/sle/SleUtility.java index 4692286..e574a00 100644 --- a/src/main/java/org/rometools/feed/module/sle/SleUtility.java +++ b/src/main/java/org/rometools/feed/module/sle/SleUtility.java @@ -35,11 +35,11 @@ import com.sun.syndication.io.impl.ModuleGenerators; /** * This is a utiltiy class for grouping and sorting lists of entries based on the SLE. - * + * *

      * Note, this class can ONLY be used on parsed feeds, unless you manually add the appropriate SleEntry objects on the items. *

      - * + * * @author Robert "kebernet" Cooper * @see SleEntry */ @@ -53,7 +53,7 @@ public class SleUtility { /** * Groups values by the groups from the SLE. - * + * * @param values List of Extendable implementations to group. * @param groups Group fields (from the SimpleListExtension module) * @return Grouped list of entries. @@ -71,7 +71,7 @@ public class SleUtility { /** * Sorts a list of values based on a given sort field using a selection sort. - * + * * @param values List of values (implements Extendable) to sort. * @param sort The sort field to sort on. * @param ascending Sort ascending/descending. @@ -86,7 +86,7 @@ public class SleUtility { /** * Sorts and groups a set of entries. - * + * * @param values List of Extendable implementations. * @param groups Group items to group by. * @param sort Field to sort on. @@ -150,6 +150,11 @@ public class SleUtility { } private static class SortableList extends ArrayList { + /** + * + */ + private static final long serialVersionUID = 1L; + public SortableList(final Collection c) { super(c); } diff --git a/src/main/java/org/rometools/feed/module/sle/io/ItemParser.java b/src/main/java/org/rometools/feed/module/sle/io/ItemParser.java index 0572b95..5559534 100644 --- a/src/main/java/org/rometools/feed/module/sle/io/ItemParser.java +++ b/src/main/java/org/rometools/feed/module/sle/io/ItemParser.java @@ -36,7 +36,7 @@ import com.sun.syndication.feed.module.Module; import com.sun.syndication.io.impl.DateParser; /** - * + * * @author Robert "kebernet" Cooper */ public class ItemParser implements com.sun.syndication.io.ModuleParser { @@ -48,7 +48,7 @@ public class ItemParser implements com.sun.syndication.io.ModuleParser { /** * Returns the namespace URI this parser handles. *

      - * + * * @return the namespace URI. */ @Override @@ -59,7 +59,7 @@ public class ItemParser implements com.sun.syndication.io.ModuleParser { /** * Parses the XML node (JDOM element) extracting module information. *

      - * + * * @param element the XML node (JDOM element) to extract module information from. * @return a module instance, null if the element did not have module information. */ @@ -83,7 +83,7 @@ public class ItemParser implements com.sun.syndication.io.ModuleParser { element.removeContent(group); } - sle.setGroupValues((EntryValue[]) values.toArray(new EntryValue[values.size()])); + sle.setGroupValues(values.toArray(new EntryValue[values.size()])); values = values.size() == 0 ? values : new ArrayList(); final List sorts = new ArrayList(element.getChildren("sort", ModuleParser.TEMP)); @@ -150,7 +150,7 @@ public class ItemParser implements com.sun.syndication.io.ModuleParser { } } // System.out.println("Values created "+values.size()+" from sorts" +sorts.size()); - sle.setSortValues((EntryValue[]) values.toArray(new EntryValue[values.size()])); + sle.setSortValues(values.toArray(new EntryValue[values.size()])); return sle; } diff --git a/src/main/java/org/rometools/feed/module/sle/io/ModuleGenerator.java b/src/main/java/org/rometools/feed/module/sle/io/ModuleGenerator.java index 188c2b0..f1fda93 100644 --- a/src/main/java/org/rometools/feed/module/sle/io/ModuleGenerator.java +++ b/src/main/java/org/rometools/feed/module/sle/io/ModuleGenerator.java @@ -20,7 +20,7 @@ import org.rometools.feed.module.sle.types.Sort; import com.sun.syndication.feed.module.Module; /** - * + * * @author Robert "kebernet" Cooper */ public class ModuleGenerator implements com.sun.syndication.io.ModuleGenerator { @@ -38,7 +38,7 @@ public class ModuleGenerator implements com.sun.syndication.io.ModuleGenerator { /** * Returns the namespace URI this generator handles. *

      - * + * * @return the namespace URI. */ @Override @@ -52,7 +52,7 @@ public class ModuleGenerator implements com.sun.syndication.io.ModuleGenerator { * 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. */ @Override @@ -63,7 +63,7 @@ public class ModuleGenerator implements com.sun.syndication.io.ModuleGenerator { /** * Generates and injectts module metadata in a XML node (JDOM element). *

      - * + * * @param module the module to inject into the XML node (JDOM element). * @param element the XML node to inject the module metadata to. */ diff --git a/src/main/java/org/rometools/feed/module/sle/io/ModuleParser.java b/src/main/java/org/rometools/feed/module/sle/io/ModuleParser.java index 98fd6c6..982e2bf 100644 --- a/src/main/java/org/rometools/feed/module/sle/io/ModuleParser.java +++ b/src/main/java/org/rometools/feed/module/sle/io/ModuleParser.java @@ -31,7 +31,7 @@ import org.rometools.feed.module.sle.types.Sort; import com.sun.syndication.feed.module.Module; /** - * + * * @author Robert "kebernet" Cooper */ public class ModuleParser implements com.sun.syndication.io.ModuleParser { @@ -46,7 +46,7 @@ public class ModuleParser implements com.sun.syndication.io.ModuleParser { /** * Returns the namespace URI this parser handles. *

      - * + * * @return the namespace URI. */ @Override @@ -57,7 +57,7 @@ public class ModuleParser implements com.sun.syndication.io.ModuleParser { /** * Parses the XML node (JDOM element) extracting module information. *

      - * + * * @param element the XML node (JDOM element) to extract module information from. * @return a module instance, null if the element did not have module information. */ @@ -79,7 +79,7 @@ public class ModuleParser implements com.sun.syndication.io.ModuleParser { values.add(new Group(ns, elementName, label)); } - sle.setGroupFields((Group[]) values.toArray(new Group[values.size()])); + sle.setGroupFields(values.toArray(new Group[values.size()])); values = values.size() == 0 ? values : new ArrayList(); for (final Element se : listInfo.getChildren("sort", NS)) { @@ -92,7 +92,7 @@ public class ModuleParser implements com.sun.syndication.io.ModuleParser { values.add(new Sort(ns, elementName, dataType, label, defaultOrder)); } - sle.setSortFields((Sort[]) values.toArray(new Sort[values.size()])); + sle.setSortFields(values.toArray(new Sort[values.size()])); insertValues(sle, element.getChildren()); return sle; diff --git a/src/main/java/org/rometools/feed/module/sle/types/DateValue.java b/src/main/java/org/rometools/feed/module/sle/types/DateValue.java index 8d56be8..1bd30b1 100644 --- a/src/main/java/org/rometools/feed/module/sle/types/DateValue.java +++ b/src/main/java/org/rometools/feed/module/sle/types/DateValue.java @@ -25,7 +25,7 @@ import com.sun.syndication.feed.impl.ObjectBean; /** * An EntryValue implementation representing a "date" data-type. - * + * * @author Robert "kebernet" Cooper */ public class DateValue implements EntryValue { @@ -42,7 +42,7 @@ public class DateValue implements EntryValue { } /** - * + * * @param element */ public void setElement(final String element) { @@ -50,7 +50,7 @@ public class DateValue implements EntryValue { } /** - * + * * @return */ @Override @@ -59,7 +59,7 @@ public class DateValue implements EntryValue { } /** - * + * * @param label */ public void setLabel(final String label) { @@ -67,7 +67,7 @@ public class DateValue implements EntryValue { } /** - * + * * @return */ @Override @@ -76,7 +76,7 @@ public class DateValue implements EntryValue { } /** - * + * * @param value */ public void setValue(final Date value) { @@ -84,7 +84,7 @@ public class DateValue implements EntryValue { } /** - * + * * @return */ @Override diff --git a/src/main/java/org/rometools/feed/module/sle/types/EntryValue.java b/src/main/java/org/rometools/feed/module/sle/types/EntryValue.java index f33e7b3..6a80986 100644 --- a/src/main/java/org/rometools/feed/module/sle/types/EntryValue.java +++ b/src/main/java/org/rometools/feed/module/sle/types/EntryValue.java @@ -23,34 +23,34 @@ import org.jdom2.Namespace; /** * An interface that parents data types for sorting and grouping. - * + * * @author Robert "kebernet" Cooper */ public interface EntryValue extends Serializable, Cloneable { /** * Returns the name of the element. - * + * * @return Returns the name of the element. */ public String getElement(); /** * Returns a label for the element. - * + * * @return Returns a label for the element. */ public String getLabel(); /** * Returns the value of the element. - * + * * @return Returns the value of the element. */ public Comparable getValue(); /** * Returns the namespace of the element. - * + * * @return Returns the namespace of the element. */ public Namespace getNamespace(); 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 79c0cd4..8c4519c 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 @@ -25,17 +25,17 @@ import com.sun.syndication.feed.impl.ObjectBean; /** * 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 contains the following attributes: *

      - * + * *
        *
      • 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 @@ -43,12 +43,12 @@ import com.sun.syndication.feed.impl.ObjectBean; *
      • 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.  
        • *
      - * + * * @author Robert "kebernet" Cooper */ public class Group implements Serializable, Cloneable { @@ -60,7 +60,7 @@ public class Group implements Serializable, Cloneable { /** * Creates a new instance of Group - * + * * @param namespace Namespace of the element * @param element Name of the element * @param label Label for the grouping. @@ -73,7 +73,7 @@ public class Group implements Serializable, Cloneable { /** * Returns the name of the element. - * + * * @return Returns the name of the element. */ public String getElement() { @@ -82,7 +82,7 @@ public class Group implements Serializable, Cloneable { /** * Returns the label of the element. - * + * * @return Returns the label of the element. */ public String getLabel() { @@ -91,7 +91,7 @@ public class Group implements Serializable, Cloneable { /** * Returns the namespace of the element. - * + * * @return Returns the namespace of the element. */ public Namespace getNamespace() { diff --git a/src/main/java/org/rometools/feed/module/sle/types/NumberValue.java b/src/main/java/org/rometools/feed/module/sle/types/NumberValue.java index 51316b4..e905036 100644 --- a/src/main/java/org/rometools/feed/module/sle/types/NumberValue.java +++ b/src/main/java/org/rometools/feed/module/sle/types/NumberValue.java @@ -25,7 +25,7 @@ import com.sun.syndication.feed.impl.ObjectBean; /** * An EntryValue implementation for "number" data-type values. - * + * * @author Robert "kebernet" Cooper */ public class NumberValue implements EntryValue { 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 a405ff6..3384147 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 @@ -26,22 +26,22 @@ import com.sun.syndication.feed.impl.ObjectBean; /** *

      * 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 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). *

      - * + * *

      * The cf:sort element contains the following attributes: *

      - * + * *
        *
      • 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 @@ -49,7 +49,7 @@ import com.sun.syndication.feed.impl.ObjectBean; *
      • 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 @@ -58,9 +58,9 @@ import com.sun.syndication.feed.impl.ObjectBean; * 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.
        • - * + * *
      - * + * * @author Robert "kebernet" Cooper */ public class Sort implements Serializable, Cloneable { @@ -86,7 +86,7 @@ public class Sort implements Serializable, Cloneable { /** * Creates a new instance of Sort - * + * * @param namespace Namespace of the element * @param element Name of the element * @param dataType data-type of the element @@ -104,7 +104,7 @@ public class Sort implements Serializable, Cloneable { /** * Returns the dataType of the sort - * + * * @return Returns the dataType of the sort */ public String getDataType() { @@ -113,7 +113,7 @@ public class Sort implements Serializable, Cloneable { /** * Indicates this is the natural order of the feed. - * + * * @return Indicates this is the natural order of the feed. */ public boolean getDefaultOrder() { @@ -122,7 +122,7 @@ public class Sort implements Serializable, Cloneable { /** * Name of the element. - * + * * @return Name of the element. */ public String getElement() { @@ -131,7 +131,7 @@ public class Sort implements Serializable, Cloneable { /** * User label for sorting. - * + * * @return User label for sorting. */ public String getLabel() { @@ -140,7 +140,7 @@ public class Sort implements Serializable, Cloneable { /** * Namespace of the element - * + * * @return Namespace of the element */ public Namespace getNamespace() { diff --git a/src/main/java/org/rometools/feed/module/sle/types/StringValue.java b/src/main/java/org/rometools/feed/module/sle/types/StringValue.java index 500f9b4..7666222 100644 --- a/src/main/java/org/rometools/feed/module/sle/types/StringValue.java +++ b/src/main/java/org/rometools/feed/module/sle/types/StringValue.java @@ -23,7 +23,7 @@ import com.sun.syndication.feed.impl.ObjectBean; /** * An EntryValue implementation for "text" data-types. - * + * * @author Robert "kebernet" Cooper */ public class StringValue implements EntryValue { 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 4e31192..ac81ba4 100644 --- a/src/main/java/org/rometools/feed/module/sse/SSE091Generator.java +++ b/src/main/java/org/rometools/feed/module/sse/SSE091Generator.java @@ -1,7 +1,6 @@ package org.rometools.feed.module.sse; import java.util.Date; -import java.util.Iterator; import java.util.List; import java.util.Locale; import java.util.Set; @@ -27,7 +26,7 @@ import com.sun.syndication.io.impl.RSS20Generator; /** * Generator for the SSE Module. *

      - * + * * @author Laird Dornin */ public class SSE091Generator implements DelegatingModuleGenerator { @@ -52,7 +51,7 @@ public class SSE091Generator implements DelegatingModuleGenerator { * 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. */ @Override @@ -124,9 +123,9 @@ public class SSE091Generator implements DelegatingModuleGenerator { private void generateConflicts(final Element syncElement, final List conflicts) { if (conflicts != null) { final Element conflictsElement = new Element(Conflicts.NAME, SSEModule.SSE_NS); - for (final Iterator confictIter = conflicts.iterator(); confictIter.hasNext();) { + for (final Conflict conflict2 : conflicts) { final Element conflictElement = new Element(Conflict.NAME, SSEModule.SSE_NS); - final Conflict conflict = (Conflict) confictIter.next(); + final Conflict conflict = conflict2; generateAttribute(conflictElement, Conflict.BY_ATTRIBUTE, conflict.getBy()); generateAttribute(conflictElement, Conflict.VERSION_ATTRIBUTE, conflict.getVersion()); generateAttribute(conflictElement, Conflict.WHEN_ATTRIBUTE, conflict.getWhen()); @@ -158,9 +157,8 @@ public class SSE091Generator implements DelegatingModuleGenerator { private void generateUpdates(final Element historyElement, final List updates) { if (updates != null) { - for (final Iterator updateIter = updates.iterator(); updateIter.hasNext();) { + for (final Update update : updates) { final Element updateElement = new Element(Update.NAME, SSEModule.SSE_NS); - final Update update = updateIter.next(); generateAttribute(updateElement, Update.BY_ATTRIBUTE, update.getBy()); generateAttribute(updateElement, Update.WHEN_ATTRIBUTE, update.getWhen()); historyElement.addContent(updateElement); diff --git a/src/main/java/org/rometools/feed/module/sse/SSE091Parser.java b/src/main/java/org/rometools/feed/module/sse/SSE091Parser.java index 5dc2954..f0ff7d0 100644 --- a/src/main/java/org/rometools/feed/module/sse/SSE091Parser.java +++ b/src/main/java/org/rometools/feed/module/sse/SSE091Parser.java @@ -2,7 +2,6 @@ package org.rometools.feed.module.sse; import java.util.ArrayList; import java.util.Date; -import java.util.Iterator; import java.util.List; import java.util.Locale; import java.util.logging.Logger; @@ -29,7 +28,7 @@ import com.sun.syndication.io.impl.RSS20Parser; /** * Parses embedded SSE content from RSS channel and item content. - * + * * @author ldornin */ public class SSE091Parser implements DelegatingModuleParser { @@ -119,12 +118,10 @@ public class SSE091Parser implements DelegatingModuleParser { List conflicts = null; final List conflictsContent = syncElement.getContent(new ContentFilter(Conflicts.NAME)); - for (final Iterator conflictsIter = conflictsContent.iterator(); conflictsIter.hasNext();) { - final Element conflictsElement = conflictsIter.next(); - + for (final Element conflictsElement : conflictsContent) { final List conflictContent = conflictsElement.getContent(new ContentFilter(Conflict.NAME)); - for (final Iterator conflictIter = conflictContent.iterator(); conflictIter.hasNext();) { - final Element conflictElement = (Element) conflictIter.next(); + for (final Element element : conflictContent) { + final Element conflictElement = element; final Conflict conflict = new Conflict(); conflict.setBy(parseStringAttribute(conflictElement, Conflict.BY_ATTRIBUTE)); @@ -132,8 +129,8 @@ public class SSE091Parser implements DelegatingModuleParser { conflict.setVersion(parseIntegerAttribute(conflictElement, Conflict.VERSION_ATTRIBUTE)); final List conflictItemContent = conflictElement.getContent(new ContentFilter("item")); - for (final Iterator conflictItemIter = conflictItemContent.iterator(); conflictItemIter.hasNext();) { - final Element conflictItemElement = (Element) conflictItemIter.next(); + for (final Element element2 : conflictItemContent) { + final Element conflictItemElement = element2; final Element root = getRoot(conflictItemElement); final Item conflictItem = rssParser.parseItem(root, conflictItemElement, locale); conflict.setItem(conflictItem); @@ -176,15 +173,14 @@ public class SSE091Parser implements DelegatingModuleParser { final List filterList = element.getContent(new ContentFilter(name)); Element firstContent = null; if (filterList != null && filterList.size() > 0) { - firstContent = (Element) filterList.get(0); + firstContent = filterList.get(0); } return firstContent; } private void parseUpdates(final Element historyChild, final History history, final Locale locale) { final List updatedChildren = historyChild.getContent(new ContentFilter(Update.NAME)); - for (final Iterator childIter = updatedChildren.iterator(); childIter.hasNext();) { - final Element updateChild = childIter.next(); + for (final Element updateChild : updatedChildren) { final Update update = new Update(); update.setBy(parseStringAttribute(updateChild, Update.BY_ATTRIBUTE)); update.setWhen(parseDateAttribute(updateChild, Update.WHEN_ATTRIBUTE, locale)); diff --git a/src/main/java/org/rometools/feed/module/sse/modules/History.java b/src/main/java/org/rometools/feed/module/sse/modules/History.java index e6ac8ba..6d56395 100644 --- a/src/main/java/org/rometools/feed/module/sse/modules/History.java +++ b/src/main/java/org/rometools/feed/module/sse/modules/History.java @@ -11,13 +11,13 @@ import com.sun.syndication.feed.module.Module; * 

        * 
  *
      - * + * * Element within - * + * * 
        * 
  *
      - * + * * . */ public class History extends SSEModule { @@ -57,7 +57,7 @@ public class History extends SSEModule { *

      * This is the date-time when the most recent modification took place. If this attribute is omitted the value defaults to the earliest time representable in * RFC 822. - * + * * @return the date-time when the most recent modification took place. */ public Date getWhen() { @@ -69,7 +69,7 @@ public class History extends SSEModule { * Set the date-time when the most recent modification took place. *

      * Either or both of the when or by attributes MUST be present; it is invalid to have neither. - * + * * @param when the date-time when the most recent modification took place. */ public void setWhen(final Date when) { @@ -84,7 +84,7 @@ public class History extends SSEModule { * Either or both of the when or by must be present; it is invalid to have neither. *

      * If this attribute is omitted the value defaults to the empty string (which must be less than all other values for purposes of collation). - * + * * @return A text attribute identifying the unique endpoint that made the most recent modification. */ public String getBy() { @@ -95,7 +95,7 @@ public class History extends SSEModule { * Sets the endpoint that made the most recent modification. *

      * Either or both of the when or by attributes MUST be present; it is invalid to have neither. - * + * * @param by the endpoint that made the most recent modification. */ public void setBy(final String by) { @@ -104,7 +104,7 @@ public class History extends SSEModule { /** * Add an update to this history - * + * * @param update an update to add to the list of updates for this history. */ public void addUpdate(final Update update) { @@ -116,7 +116,7 @@ public class History extends SSEModule { /** * Return the list of updates for this history. - * + * * @return the list of updates for this history. */ public List getUpdates() { diff --git a/src/main/java/org/rometools/feed/module/sse/modules/Related.java b/src/main/java/org/rometools/feed/module/sse/modules/Related.java index 0303f8a..17f1d4b 100644 --- a/src/main/java/org/rometools/feed/module/sse/modules/Related.java +++ b/src/main/java/org/rometools/feed/module/sse/modules/Related.java @@ -9,13 +9,13 @@ import com.sun.syndication.feed.module.Module; * 

        * 
  *
      - * + * * Element within - * + * * 
        * 
  *
      - * + * * . */ public class Related extends SSEModule { @@ -62,7 +62,7 @@ public class Related extends SSEModule { /** * link A required, URL attribute. The URL for related feeds. - * + * * @return the URL for related feeds */ // TODO: use a java.net.URL? @@ -72,7 +72,7 @@ public class Related extends SSEModule { /** * Set the URL for related feeds. - * + * * @param link the URL for related feeds. */ public void setLink(final String link) { @@ -81,7 +81,7 @@ public class Related extends SSEModule { /** * title An optional, string attribute. The name or description of the related feed. - * + * * @return The name or description of the related feed. */ public String getTitle() { @@ -90,7 +90,7 @@ public class Related extends SSEModule { /** * Set the name or description of the related feed. - * + * * @param title the name or description of the related feed. */ public void setTitle(final String title) { @@ -103,7 +103,7 @@ public class Related extends SSEModule { * "complete" if the link points to file containing the complete collection of items for this feed. *

      * "aggregated" if the link points to a feed whose contents are being incorporated into this feed by the publisher. - * + * * @return the type of the releated feed. */ public Integer getType() { @@ -112,7 +112,7 @@ public class Related extends SSEModule { /** * Set the type of relationship, complete or aggregated. - * + * * @param type the type of relationship, complete or aggregated. */ public void setType(final Integer type) { @@ -122,7 +122,7 @@ public class Related extends SSEModule { /** * An optional, date-time attribute. This is the starting point of the related feed. If this attribute is omitted or blank, it is assumed that this is a * complete feed. - * + * * @return the starting point of the related feed. */ public Date getSince() { @@ -131,7 +131,7 @@ public class Related extends SSEModule { /** * Set the starting point of the related feed. - * + * * @param since the starting point of the related feed. */ public void setSince(final Date since) { @@ -140,7 +140,7 @@ public class Related extends SSEModule { /** * An optional, date-time attribute. This is the ending point of a feed. - * + * * @return the ending point of the feed, until. */ public Date getUntil() { @@ -149,7 +149,7 @@ public class Related extends SSEModule { /** * Set the ending point of the feed, until. An optional, date-time attribute. - * + * * @param until the ending point of the feed. */ public void setUntil(final Date until) { diff --git a/src/main/java/org/rometools/feed/module/sse/modules/Sharing.java b/src/main/java/org/rometools/feed/module/sse/modules/Sharing.java index 265e79c..8e26d4c 100644 --- a/src/main/java/org/rometools/feed/module/sse/modules/Sharing.java +++ b/src/main/java/org/rometools/feed/module/sse/modules/Sharing.java @@ -9,19 +9,19 @@ import com.sun.syndication.feed.module.Module; * 

        * 
  *
      - * + * * Element within RSS - * + * * 
        * 
  *
      - * + * * or OPML - * + * * 
        * 
  *
      - * + * * . */ public class Sharing extends SSEModule { @@ -64,7 +64,7 @@ public class Sharing extends SSEModule { /** * ordered An optional, Boolean attribute. If present and its value is "true" (lower-case), subscribers MUST treat the item list as an ordered set (see * section 3.2). If this attribute is omitted or blank, it is assumed that this is an unordered feed. - * + * * @return a Boolean indicating if subscribers must treat the item list as an ordered set. */ public Boolean getOrdered() { @@ -73,7 +73,7 @@ public class Sharing extends SSEModule { /** * Set whether subscribers MUST tread the item list as an ordered set. - * + * * @param ordered whether subscribers MUST tread the item list as an ordered set. */ public void setOrdered(final Boolean ordered) { @@ -83,7 +83,7 @@ public class Sharing extends SSEModule { /** * Provides an Integer that expresses the size of the window of change history kept by the publisher. Subscribers MAY use this value to determine the * frequency with which they must read a feed. - * + * * @return an Integer that expresses the size of the window of change history kept by the publisher. */ public Integer getWindow() { @@ -92,7 +92,7 @@ public class Sharing extends SSEModule { /** * Set an Integer that expresses the size of the window of change history kept by the publisher. - * + * * @param window an Integer that expresses the size of the window of change history kept by the publisher. */ public void setWindow(final Integer window) { @@ -102,7 +102,7 @@ public class Sharing extends SSEModule { /** * since An optional date-time attribute. All items updated on or after this date-time are included in the feed. If not present or null, the * "beginning of time" is assumed and the feed contains the node's complete item set as of the until date-time. - * + * * @return An optional date-time attribute. */ public Date getSince() { @@ -111,7 +111,7 @@ public class Sharing extends SSEModule { /** * Sets the optional date-time attribute where all items updated on or after this date-time are included in the feed. - * + * * @param since An optional date-time attribute. */ public void setSince(final Date since) { @@ -122,7 +122,7 @@ public class Sharing extends SSEModule { * until An optional date-time attribute. Items updated after this date are not included in the feed. The publisher must guarantee that the value of until * will increase if any items in the feed are updated. If this attribute is omitted or blank, the subscriber cannot make assumptions about when the feed was * updated. - * + * * @return the date where items updated after this date are not included in the feed. */ public Date getUntil() { @@ -131,7 +131,7 @@ public class Sharing extends SSEModule { /** * Set the date where items updated after this date are not included in the feed. - * + * * @param until the date where items updated after this date are not included in the feed. */ public void setUntil(final Date until) { diff --git a/src/main/java/org/rometools/feed/module/sse/modules/Sync.java b/src/main/java/org/rometools/feed/module/sse/modules/Sync.java index 7a65894..b0ee980 100644 --- a/src/main/java/org/rometools/feed/module/sse/modules/Sync.java +++ b/src/main/java/org/rometools/feed/module/sse/modules/Sync.java @@ -10,19 +10,19 @@ import com.sun.syndication.feed.module.Module; * 
        * 
  *
      - * + * * Element within RSS - * + * * 
        * 
  *
      - * + * * or OPML - * + * * 
        * 
  *
      - * + * * . */ public class Sync extends SSEModule { @@ -74,7 +74,7 @@ public class Sync extends SSEModule { /** * Set the identifier for the item. The ID MUST be globally unique within the feed and it MUST be identical across feeds if an item is being shared or * replicated as part of multiple distinct independent feeds. - * + * * @param id the identifier for the item. */ public void setId(final String id) { @@ -91,7 +91,7 @@ public class Sync extends SSEModule { /** * Set the modification sequence number of the item. - * + * * @param version the modification sequence number of the item. */ public void setVersion(final Integer version) { @@ -108,7 +108,7 @@ public class Sync extends SSEModule { /** * Set an indication of whether this item has been deleted and is a tombstone. - * + * * @param deleted an indication of whether this item has been deleted and is a tombstone. */ public void setDeleted(final Boolean deleted) { @@ -119,7 +119,7 @@ public class Sync extends SSEModule { * Provides access to an optional, Boolean conflict attribute. If present and its value is "true" (lower-case), it indicates there was an update conflict * detected when processing an update of this item, and it should potentially be examined by the user. If not present, or present with value of "false" or * "", Then no conflict has been detected. All other values are invalid. - * + * * @return indicates there was an update conflict detected when processing an update of this item. */ public Boolean isConflict() { @@ -128,7 +128,7 @@ public class Sync extends SSEModule { /** * Set an indication of whether there was an update conflict detected when processing an update of this item. - * + * * @param conflict an indication of whether there was an update conflict detected when processing an update of this item. */ public void setConflict(final Boolean conflict) { @@ -140,7 +140,7 @@ public class Sync extends SSEModule { /** * The history history for this sync object - * + * * @param history the history for this sync object. */ public void setHistory(final History history) { @@ -149,7 +149,7 @@ public class Sync extends SSEModule { /** * Get the history for this sync object - * + * * @return get the history for this sync object. */ public History getHistory() { diff --git a/src/main/java/org/rometools/feed/module/sse/modules/Update.java b/src/main/java/org/rometools/feed/module/sse/modules/Update.java index 0f05239..c6b9d8d 100644 --- a/src/main/java/org/rometools/feed/module/sse/modules/Update.java +++ b/src/main/java/org/rometools/feed/module/sse/modules/Update.java @@ -9,13 +9,13 @@ import com.sun.syndication.feed.module.Module; * 
        * 
  *
      - * + * * Element within - * + * * 
        * 
  *
      - * + * * . */ public class Update extends SSEModule { @@ -45,7 +45,7 @@ public class Update extends SSEModule { /** * Set the date-time when the modification took place. - * + * * @param when the date-time when the modification took place. */ public void setWhen(final Date when) { @@ -56,7 +56,7 @@ public class Update extends SSEModule { * Provides access to a text attribute identifying the unique endpoint that made a modification. This SHOULD be some combination of user and device (so that * a given user can edit a feed on multiple devices). This attribute is used programmatically to break ties in case two changes happened at the same time * (within the same second). Either or both of the when or by must be present; it is invalid to have neither. - * + * * @return access to a text attribute identifying the unique endpoint that made a modification. */ public String getBy() { @@ -65,7 +65,7 @@ public class Update extends SSEModule { /** * Sets a text attribute identifying the unique endpoint that made a modification. - * + * * @param by a text attribute identifying the unique endpoint that made a modification. */ public void setBy(final String by) { diff --git a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherEntryModule.java b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherEntryModule.java index cf5f13c..96f796d 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherEntryModule.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherEntryModule.java @@ -41,35 +41,35 @@ import org.rometools.feed.module.yahooweather.types.Forecast; /** * An interface describing the entry/item level data for Yahoo Weather. - * + * * @version $Id: YWeatherEntryModule.java,v 1.2 2008/01/22 14:50:06 kebernet Exp $ * @author Robert "kebernet" Cooper */ public interface YWeatherEntryModule extends YWeatherModule { /** * The current conditions. - * + * * @return The current conditions. */ public Condition getCondition(); /** * The current conditions. - * + * * @param condition The current conditions. */ public void setCondition(Condition condition); /** * Forecasts for this location. - * + * * @return Forecasts for this location. */ public Forecast[] getForecasts(); /** * Forecasts for this location. - * + * * @param forecasts Forecasts for this location. */ public void setForecasts(Forecast[] forecasts); diff --git a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherFeedModule.java b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherFeedModule.java index a5b1a01..c630dfe 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherFeedModule.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherFeedModule.java @@ -43,77 +43,77 @@ import org.rometools.feed.module.yahooweather.types.Wind; /** * An interface describing feed/channel level data for Yahoo Weather. - * + * * @version $Id: YWeatherFeedModule.java,v 1.3 2008/03/29 16:19:12 kebernet Exp $ * @author Robert "kebernet" Cooper */ public interface YWeatherFeedModule extends YWeatherModule { /** * The location the feed is for. - * + * * @return The location the feed is for. */ public Location getLocation(); /** * The location the feed is for. - * + * * @param location The location the feed is for. */ public void setLocation(Location location); /** * Astronomical information for the location. - * + * * @return Astronomical information for the location. */ public Astronomy getAstronomy(); /** * Astronomical information for the location. - * + * * @param astronomy Astronomical information for the location. */ public void setAstronomy(Astronomy astronomy); /** * Units that data in the feed is provided in. - * + * * @return Units that data in the feed is provided in. */ public Units getUnits(); /** * Units that data in the feed is provided in. - * + * * @param units Units that data in the feed is provided in. */ public void setUnits(Units units); /** * Current wind conditions at the location. - * + * * @return Current wind conditions at the location. */ public Wind getWind(); /** * Current wind conditions at the location. - * + * * @param wind Current wind conditions at the location. */ public void setWind(Wind wind); /** * The current atmospheric conditions. - * + * * @return Atmosphere object. */ public Atmosphere getAtmosphere(); /** * Sets the current atmopheric condictions - * + * * @param value Atmosphere object. */ public void setAtmosphere(Atmosphere value); diff --git a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModule.java b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModule.java index 530345b..b885dd5 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModule.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModule.java @@ -39,7 +39,7 @@ import com.sun.syndication.feed.module.Module; /** * A simple parent interface that defines the feed URI - * + * * @version $Id: YWeatherModule.java,v 1.2 2008/01/22 14:50:06 kebernet Exp $ * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModuleImpl.java b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModuleImpl.java index 893c043..d6e7eb4 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModuleImpl.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/YWeatherModuleImpl.java @@ -49,7 +49,7 @@ import com.sun.syndication.feed.module.ModuleImpl; /** * A Module implementation for entry or feed level information. - * + * * @version $Id: YWeatherModuleImpl.java,v 1.2 2008/01/22 14:50:06 kebernet Exp $ * @author Robert "kebernet" Cooper */ diff --git a/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleGenerator.java b/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleGenerator.java index c8a5d30..6d7201d 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleGenerator.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/io/WeatherModuleGenerator.java @@ -52,7 +52,7 @@ import com.sun.syndication.io.ModuleGenerator; /** * The ModuleGenerator implementation for the Yahoo Weather plug in. - * + * * @version $Revision: 1.3 $ * @author Robert "kebernet" Cooper */ 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 cef27c6..0bd4c21 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 @@ -63,7 +63,7 @@ import com.sun.syndication.io.ModuleParser; /** * ModuleParser implementation for Slash RSS. - * + * * @version $Revision: 1.2 $ * @author Robert "kebernet" Cooper */ @@ -144,7 +144,7 @@ public class WeatherModuleParser implements ModuleParser { try { final Condition c = new Condition(condition.getAttributeValue("text"), ConditionCode.fromCode(Integer.parseInt(condition .getAttributeValue("code"))), Integer.parseInt(condition.getAttributeValue("temp")), LONG_DATE.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) { Logger.getAnonymousLogger().warning("NumberFormatException processing tag."); 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 26c0b18..906881b 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 @@ -49,11 +49,15 @@ import com.sun.syndication.feed.impl.ToStringBean; *
    • 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 $ * @author Robert "kebernet" Cooper */ public class Astronomy implements Serializable, Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private final EqualsBean equals = new EqualsBean(Astronomy.class, this); private final ToStringBean toString = new ToStringBean(Astronomy.class, this); private Date sunrise; @@ -68,7 +72,7 @@ public class Astronomy implements Serializable, Cloneable { /** * Constructs a new Astronomy object - * + * * @param sunrise time of sunrise (from 0ms) * @param sunset time of sunset (from 0ms) */ @@ -99,7 +103,7 @@ public class Astronomy implements Serializable, Cloneable { /** * Time of sunrise - * + * * @return ime of sunrise (from 0ms) */ public Date getSunrise() { @@ -108,7 +112,7 @@ public class Astronomy implements Serializable, Cloneable { /** * Time of sunrise - * + * * @param sunrise ime of sunrise (from 0ms) */ public void setSunrise(final Date sunrise) { @@ -117,7 +121,7 @@ public class Astronomy implements Serializable, Cloneable { /** * Time of sunset - * + * * @return time of sunset (from 0ms) */ public Date getSunset() { @@ -126,7 +130,7 @@ public class Astronomy implements Serializable, Cloneable { /** * Time of sunset - * + * * @param sunset time of sunset (from 0ms) */ public void setSunset(final Date sunset) { 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 92d8865..b10a7d3 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 @@ -52,11 +52,15 @@ import com.sun.syndication.feed.impl.ToStringBean; *
    • 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 $ * @author Robert "kebernet" Cooper */ public class Atmosphere implements Serializable, Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private final EqualsBean equals = new EqualsBean(Atmosphere.class, this); private final ToStringBean toString = new ToStringBean(Atmosphere.class, this); private int humidity; @@ -73,7 +77,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Constructs a new Atmosphere object - * + * * @param humidity humidity, in percent * @param visibility visibility distance (value beyond 1/100ths of a unit will be truncated) * @param pressure barometric pressure @@ -104,7 +108,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Relative humidity - * + * * @return humidity, in percent */ public int getHumidity() { @@ -113,7 +117,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Relative humidity - * + * * @param humidity humidity, in percent */ public void setHumidity(final int humidity) { @@ -122,7 +126,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Visibility distance - * + * * @return distance */ public double getVisibility() { @@ -131,7 +135,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Visibility distance - * + * * @param visibility distance (value beyond 1/100ths of a unit will be truncated) */ public void setVisibility(final double visibility) { @@ -140,7 +144,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Barometric pressure - * + * * @return pressure */ public double getPressure() { @@ -149,7 +153,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Barometric pressure - * + * * @param pressure pressure */ public void setPressure(final double pressure) { @@ -158,7 +162,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Change in pressure - * + * * @return Atmosphere.PressureChange object */ public PressureChange getChange() { @@ -167,7 +171,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * Change in pressure - * + * * @param change PressureChange object */ public void setChange(final PressureChange change) { @@ -180,6 +184,10 @@ public class Atmosphere implements Serializable, Cloneable { } public static class PressureChange implements Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; public static final PressureChange RISING = new PressureChange(1, "rising"); public static final PressureChange STEADY = new PressureChange(0, "steady"); public static final PressureChange FALLING = new PressureChange(2, "falling"); @@ -198,7 +206,7 @@ public class Atmosphere implements Serializable, Cloneable { /** * The integer code for this chage state - * + * * @return int code */ public int getCode() { @@ -207,24 +215,24 @@ public class Atmosphere implements Serializable, Cloneable { /** * Gets a PressureChange instance for this int code. - * + * * @param code int code value * @return PressureChange instance * @throws RuntimeException if no 0, 1, or 2. */ public static PressureChange fromCode(final int code) { switch (code) { - case 0: - return STEADY; + case 0: + return STEADY; - case 1: - return RISING; + case 1: + return RISING; - case 2: - return FALLING; + case 2: + return FALLING; - default: - throw new RuntimeException("Invalid pressure change code."); + default: + throw new RuntimeException("Invalid pressure change code."); } } } 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 8b6e0a9..6512fc6 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 @@ -53,11 +53,15 @@ import com.sun.syndication.feed.impl.ToStringBean; *
    • 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 $ * @author Robert "kebernet" Cooper */ public class Condition implements Serializable, Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private final EqualsBean equals = new EqualsBean(Condition.class, this); private final ToStringBean toString = new ToStringBean(Condition.class, this); private String text; @@ -74,7 +78,7 @@ public class Condition implements Serializable, Cloneable { /** * Constructs a new Condition. - * + * * @param text a textual description of conditions, for example, "Partly Cloudy" * @param code the condition code for this forecast. * @param temperature the current temperature @@ -90,7 +94,7 @@ public class Condition implements Serializable, Cloneable { /** * Description of condition - * + * * @return a textual description of conditions, for example, "Partly Cloudy" */ public String getText() { @@ -99,7 +103,7 @@ public class Condition implements Serializable, Cloneable { /** * Description of condition - * + * * @param text a textual description of conditions, for example, "Partly Cloudy" */ public void setText(final String text) { @@ -108,7 +112,7 @@ public class Condition implements Serializable, Cloneable { /** * Condition code - * + * * @return condition code */ public ConditionCode getCode() { @@ -117,7 +121,7 @@ public class Condition implements Serializable, Cloneable { /** * Condition code - * + * * @param code Condition code */ public void setCode(final ConditionCode code) { @@ -126,7 +130,7 @@ public class Condition implements Serializable, Cloneable { /** * Current Temperature - * + * * @return the current temperature * @see Units */ @@ -136,7 +140,7 @@ public class Condition implements Serializable, Cloneable { /** * Current Temperature - * + * * @param temperature the current temperature * @see Units */ @@ -146,7 +150,7 @@ public class Condition implements Serializable, Cloneable { /** * Date recorded - * + * * @return the current date and time */ public Date getDate() { @@ -155,7 +159,7 @@ public class Condition implements Serializable, Cloneable { /** * Date recorded - * + * * @param date the current date and time */ public void setDate(final Date date) { diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/ConditionCode.java b/src/main/java/org/rometools/feed/module/yahooweather/types/ConditionCode.java index 18d723a..58724cf 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/ConditionCode.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/ConditionCode.java @@ -45,7 +45,7 @@ import com.sun.syndication.feed.impl.EqualsBean; /** *

      Condition Codes

      - * + * *

      * Condition codes are used in the yweather:forecast element to describe the current conditions. *

      @@ -56,7 +56,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * Description * * - * + * * 0 * tornado * @@ -64,7 +64,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * 1 * tropical storm * - * + * * * 2 * hurricane @@ -72,7 +72,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * 3 * severe thunderstorms - * + * * * * 4 @@ -80,7 +80,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * 5 - * + * * mixed rain and snow * * @@ -88,7 +88,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * mixed rain and sleet * * - * + * * 7 * mixed snow and sleet * @@ -96,7 +96,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * 8 * freezing drizzle * - * + * * * 9 * drizzle @@ -104,7 +104,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * 10 * freezing rain - * + * * * * 11 @@ -112,7 +112,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * 12 - * + * * showers * * @@ -120,7 +120,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * snow flurries * * - * + * * 14 * light snow showers * @@ -128,7 +128,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * 15 * blowing snow * - * + * * * 16 * snow @@ -136,7 +136,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * 17 * hail - * + * * * * 18 @@ -144,7 +144,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * 19 - * + * * dust * * @@ -152,7 +152,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * foggy * * - * + * * 21 * haze * @@ -160,7 +160,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * 22 * smoky * - * + * * * 23 * blustery @@ -168,7 +168,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * 24 * windy - * + * * * * 25 @@ -176,7 +176,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * 26 - * + * * cloudy * * @@ -184,7 +184,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * mostly cloudy (night) * * - * + * * 28 * mostly cloudy (day) * @@ -192,7 +192,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * 29 * partly cloudy (night) * - * + * * * 30 * partly cloudy (day) @@ -200,7 +200,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * 31 * clear (night) - * + * * * * 32 @@ -208,7 +208,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * 33 - * + * * fair (night) * * @@ -216,7 +216,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * fair (day) * * - * + * * 35 * mixed rain and hail * @@ -224,7 +224,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * 36 * hot * - * + * * * 37 * isolated thunderstorms @@ -232,7 +232,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * 38 * scattered thunderstorms - * + * * * * 39 @@ -240,7 +240,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * 40 - * + * * scattered showers * * @@ -248,7 +248,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * heavy snow * * - * + * * 42 * scattered snow showers * @@ -256,7 +256,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * 43 * heavy snow * - * + * * * 44 * partly cloudy @@ -264,7 +264,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * 45 * thundershowers - * + * * * * 46 @@ -272,7 +272,7 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * 47 - * + * * isolated thundershowers * * @@ -281,11 +281,15 @@ import com.sun.syndication.feed.impl.EqualsBean; * * * - * + * * @version $Id: ConditionCode.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ * @author Robert "kebernet" Cooper */ public class ConditionCode implements Serializable { + /** + * + */ + private static final long serialVersionUID = 1L; private transient static Map LOOKUP = new HashMap(); /* */ public static final ConditionCode TORNADO = new ConditionCode(0, "tornado"); public static final ConditionCode TROPICAL_STORM = new ConditionCode(1, "tropical storm"); @@ -353,7 +357,7 @@ public class ConditionCode implements Serializable { /** * The integer code for this condition - * + * * @return int code value */ public int getCode() { @@ -362,7 +366,7 @@ public class ConditionCode implements Serializable { /** * Text description of condition (from the table at top of class) - * + * * @return */ public String getDescription() { @@ -371,7 +375,7 @@ public class ConditionCode implements Serializable { /** * Returns a condition code instance for a given integer - * + * * @param code integer code to search for * @return a ConditionCode instance or null */ 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 e58976a..30b085d 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 @@ -51,16 +51,20 @@ import com.sun.syndication.feed.impl.ToStringBean; *
    • 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)
      • * - * + * * @see ConditionCode * @version $Id: Forecast.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ * @author Robert "kebernet" Cooper */ public class Forecast implements Serializable, Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private transient ToStringBean toString = new ToStringBean(Forecast.class, this); private transient EqualsBean equals = new EqualsBean(Forecast.class, this); private String day; @@ -79,7 +83,7 @@ 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 date the date to which this forecast applies * @param low the forecasted low temperature for this day @@ -99,7 +103,7 @@ 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) */ public String getDay() { @@ -108,7 +112,7 @@ 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) */ public void setDay(final String day) { @@ -117,7 +121,7 @@ public class Forecast implements Serializable, Cloneable { /** * For date. - * + * * @return the date to which this forecast applies */ public Date getDate() { @@ -126,7 +130,7 @@ public class Forecast implements Serializable, Cloneable { /** * For date. - * + * * @param date the date to which this forecast applies */ public void setDate(final Date date) { @@ -135,7 +139,7 @@ public class Forecast implements Serializable, Cloneable { /** * Low temperature. - * + * * @return the forecasted low temperature for this day * @see Units */ @@ -145,7 +149,7 @@ public class Forecast implements Serializable, Cloneable { /** * Low temperature - * + * * @param low the forecasted low temperature for this day * @see Units */ @@ -155,7 +159,7 @@ public class Forecast implements Serializable, Cloneable { /** * High temperature - * + * * @return the forecasted high temperature for this day * @see Units */ @@ -165,7 +169,7 @@ public class Forecast implements Serializable, Cloneable { /** * High temperature - * + * * @param high the forecasted high temperature for this day * @see Units */ @@ -175,7 +179,7 @@ public class Forecast implements Serializable, Cloneable { /** * Text summary - * + * * @return a textual description of conditions, for example, "Partly Cloudy" */ public String getText() { @@ -184,7 +188,7 @@ public class Forecast implements Serializable, Cloneable { /** * Text summary - * + * * @param text a textual description of conditions, for example, "Partly Cloudy" */ public void setText(final String text) { @@ -193,7 +197,7 @@ public class Forecast implements Serializable, Cloneable { /** * Condition code - * + * * @return the condition code for this forecast */ public ConditionCode getCode() { @@ -202,7 +206,7 @@ public class Forecast implements Serializable, Cloneable { /** * Condition code - * + * * @param code the condition code for this forecast */ public void setCode(final ConditionCode code) { diff --git a/src/main/java/org/rometools/feed/module/yahooweather/types/Location.java b/src/main/java/org/rometools/feed/module/yahooweather/types/Location.java index 8adbada..a7dde08 100644 --- a/src/main/java/org/rometools/feed/module/yahooweather/types/Location.java +++ b/src/main/java/org/rometools/feed/module/yahooweather/types/Location.java @@ -49,11 +49,15 @@ import com.sun.syndication.feed.impl.ToStringBean; *
    • region: state, territory, or region, if given (string)
      • *
    • country: two-character country code. (string)
      • * - * + * * @version $Id: Location.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $ * @author Robert "kebernet" Cooper */ public class Location implements Serializable, Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private transient ToStringBean toString = new ToStringBean(Location.class, this); private transient EqualsBean equals = new EqualsBean(Location.class, this); private String city; @@ -69,7 +73,7 @@ public class Location implements Serializable, Cloneable { /** * Constructs a new Location object. - * + * * @param city city name * @param region state, territory, or region, if given * @param country two-character country code. @@ -83,7 +87,7 @@ public class Location implements Serializable, Cloneable { /** * City name - * + * * @return city name. */ public String getCity() { @@ -92,7 +96,7 @@ public class Location implements Serializable, Cloneable { /** * City name - * + * * @param city city name */ public void setCity(final String city) { @@ -101,7 +105,7 @@ public class Location implements Serializable, Cloneable { /** * state, territory, or region, if given - * + * * @return state, territory, or region, if given */ public String getRegion() { @@ -110,7 +114,7 @@ public class Location implements Serializable, Cloneable { /** * state, territory, or region, if given - * + * * @param region state, territory, or region, if given */ public void setRegion(final String region) { @@ -119,7 +123,7 @@ public class Location implements Serializable, Cloneable { /** * country two-character country code. - * + * * @return country two-character country code. */ public String getCountry() { @@ -128,7 +132,7 @@ public class Location implements Serializable, Cloneable { /** * country two-character country code. - * + * * @param country country two-character country code. */ public void setCountry(final String country) { 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 bdfb230..4b9bf1c 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 @@ -54,11 +54,15 @@ import com.sun.syndication.feed.impl.ToStringBean; * 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 */ public class Units implements Serializable, Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private transient ToStringBean toString = new ToStringBean(Units.class, this); private transient EqualsBean equals = new EqualsBean(Units.class, this); private String temperature; @@ -75,7 +79,7 @@ public class Units implements Serializable, Cloneable { /** * Constructs a new Units object - * + * * @param temperature units of temp ("f" or "c"); * @param distance units of distance ("mi" or "km") * @param pressure units of pressure ("in" or "mb") @@ -91,7 +95,7 @@ public class Units implements Serializable, Cloneable { /** * Units of Temperature. - * + * * @return temperature units of temp ("f" or "c"); */ public String getTemperature() { @@ -100,7 +104,7 @@ public class Units implements Serializable, Cloneable { /** * Units of Temperature. - * + * * @param temperature units of temp ("f" or "c"); */ public void setTemperature(final String temperature) { @@ -109,7 +113,7 @@ public class Units implements Serializable, Cloneable { /** * Units of distance - * + * * @return distance units of distance ("mi" or "km") */ public String getDistance() { @@ -118,7 +122,7 @@ public class Units implements Serializable, Cloneable { /** * Units of distance - * + * * @param distance units of distance ("mi" or "km") */ public void setDistance(final String distance) { @@ -127,7 +131,7 @@ public class Units implements Serializable, Cloneable { /** * Units of pressure - * + * * @return units of pressure ("in" or "mb") */ public String getPressure() { @@ -136,7 +140,7 @@ public class Units implements Serializable, Cloneable { /** * Units of pressure - * + * * @param pressure units of pressure ("in" or "mb") */ public void setPressure(final String pressure) { @@ -145,7 +149,7 @@ public class Units implements Serializable, Cloneable { /** * Units of speed - * + * * @return units of speed ("mph" or "kph") */ public String getSpeed() { @@ -154,7 +158,7 @@ public class Units implements Serializable, Cloneable { /** * Units of speed - * + * * @param speed units of speed ("mph" or "kph") */ public void setSpeed(final String speed) { 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 78c1c85..e4b7cd2 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 @@ -53,11 +53,15 @@ import com.sun.syndication.feed.impl.ToStringBean; * 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 */ public class Wind implements Serializable, Cloneable { + /** + * + */ + private static final long serialVersionUID = 1L; private transient ToStringBean toString = new ToStringBean(Wind.class, this); private transient EqualsBean equals = new EqualsBean(Wind.class, this); private int chill; @@ -73,7 +77,7 @@ public class Wind implements Serializable, Cloneable { /** * Constructs a new Wind object - * + * * @param chill wind chill adjusted temperature * @param direction direction of wind in degrees * @param speed speed of wind @@ -102,7 +106,7 @@ public class Wind implements Serializable, Cloneable { /** * Wind chill adjusted temperature. - * + * * @return int temperature value * @see Units */ @@ -112,7 +116,7 @@ public class Wind implements Serializable, Cloneable { /** * Wind chill adjusted temperature. - * + * * @param chill int temperature value * @see Units */ @@ -122,7 +126,7 @@ public class Wind implements Serializable, Cloneable { /** * Direction of wind in degrees - * + * * @return int direction of wind. */ public int getDirection() { @@ -131,7 +135,7 @@ public class Wind implements Serializable, Cloneable { /** * Direction of wind in degrees - * + * * @param direction int direction of wind. */ public void setDirection(final int direction) { @@ -140,7 +144,7 @@ public class Wind implements Serializable, Cloneable { /** * Speed of wind - * + * * @return int speed of wind * @see Units */ @@ -150,7 +154,7 @@ public class Wind implements Serializable, Cloneable { /** * Speed of wind - * + * * @param speed int speed of wind * @see Units */ diff --git a/src/test/java/org/rometools/feed/module/AbstractTestCase.java b/src/test/java/org/rometools/feed/module/AbstractTestCase.java index 04d94ed..074a386 100644 --- a/src/test/java/org/rometools/feed/module/AbstractTestCase.java +++ b/src/test/java/org/rometools/feed/module/AbstractTestCase.java @@ -11,7 +11,7 @@ import junit.framework.TestCase; /** * Abstract base class for test cases. - * + * * @author Jason van Zyl */ public abstract class AbstractTestCase extends TestCase { @@ -29,7 +29,7 @@ public abstract class AbstractTestCase extends TestCase { /** * Get test input file. - * + * * @param path Path to test input file. */ public String getTestFile(final String path) { @@ -42,7 +42,7 @@ public abstract class AbstractTestCase extends TestCase { /** * This method takes a JavaBean and generates a standard toString() type result for it. - * + * * @param o JavaBean object to stringinate * @return STRINGIATION! Stringingating the countryside. Stringinating all the peasants. */ diff --git a/src/test/java/org/rometools/feed/module/ITunesGeneratorTest.java b/src/test/java/org/rometools/feed/module/ITunesGeneratorTest.java index 6b397e8..377b3ed 100644 --- a/src/test/java/org/rometools/feed/module/ITunesGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/ITunesGeneratorTest.java @@ -21,7 +21,7 @@ import com.sun.syndication.io.SyndFeedOutput; import com.sun.syndication.io.XmlReader; /** - * + * * @author cooper */ public class ITunesGeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/MediaModuleTest.java b/src/test/java/org/rometools/feed/module/MediaModuleTest.java index c7269e4..06d6f25 100644 --- a/src/test/java/org/rometools/feed/module/MediaModuleTest.java +++ b/src/test/java/org/rometools/feed/module/MediaModuleTest.java @@ -23,7 +23,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author cooper */ public class MediaModuleTest extends AbstractTestCase { @@ -72,51 +72,21 @@ public class MediaModuleTest extends AbstractTestCase { public void xtestOriginal() throws Exception { // /* - * //You can test with blip tv or broadcast machine - * - * String rss = "http://blip.tv/?1=1&&skin=rss";// // String rss = "http://openvision.tv/bm/rss.php?i=4"; // String rss = - * "http://api.search.yahoo.com/VideoSearchService/rss/videoSearch.xml?appid=yahoosearchvideorss&query=surfing&adult_ok=0"; - * - * - * URLConnection uc = new URL(rss).openConnection(); String contentType = uc.getContentEncoding(); - * - * WireFeedInput input = new WireFeedInput(); - * - * XmlReader xmlReader = new XmlReader(uc.getInputStream(), contentType, true); - * - * Channel chnl = (Channel)input.build(xmlReader); - * - * String feedTitle = chnl.getTitle(); String feedDesc = chnl.getDescription(); - * - * - * List items = chnl.getItems(); - * - * ListIterator li = items.listIterator(); Item item = null; Enclosure enc = null; MediaModule mModule = null; - * - * while (li.hasNext()) { - * - * item = (Item)li.next(); enc = (Enclosure)item.getEnclosures().get(0); - * - * mModule = (MediaModule)item.getModule(MediaModule.URI); - * - * List modules = item.getModules(); System.out.println("title: " + item.getTitle()); System.out.println("module count: " + modules.size()); - * - * if (mModule != null) { Thumbnail[] mThumbs = mModule.getMediaThumbnails(); - * - * if (mThumbs != null) { for (int i = 0; i < mThumbs.length; i++) { String imgUrl = mThumbs[i].getUrl(); System.out.println("got MediaModule img " + i - * + ": " + imgUrl); } } - * - * System.out.println("MediaModule title: " + mModule.getTitle()); System.out.println("MediaModule isAdult: " + mModule.isAdult()); /* if + * //You can test with blip tv or broadcast machine String rss = "http://blip.tv/?1=1&&skin=rss";// // String rss = + * "http://openvision.tv/bm/rss.php?i=4"; // String rss = + * "http://api.search.yahoo.com/VideoSearchService/rss/videoSearch.xml?appid=yahoosearchvideorss&query=surfing&adult_ok=0"; URLConnection uc = new + * URL(rss).openConnection(); String contentType = uc.getContentEncoding(); WireFeedInput input = new WireFeedInput(); XmlReader xmlReader = new + * XmlReader(uc.getInputStream(), contentType, true); Channel chnl = (Channel)input.build(xmlReader); String feedTitle = chnl.getTitle(); String + * feedDesc = chnl.getDescription(); List items = chnl.getItems(); ListIterator li = items.listIterator(); Item item = null; Enclosure enc = null; + * MediaModule mModule = null; while (li.hasNext()) { item = (Item)li.next(); enc = (Enclosure)item.getEnclosures().get(0); mModule = + * (MediaModule)item.getModule(MediaModule.URI); List modules = item.getModules(); System.out.println("title: " + item.getTitle()); + * System.out.println("module count: " + modules.size()); if (mModule != null) { Thumbnail[] mThumbs = mModule.getMediaThumbnails(); if (mThumbs != + * null) { for (int i = 0; i < mThumbs.length; i++) { String imgUrl = mThumbs[i].getUrl(); System.out.println("got MediaModule img " + i + ": " + + * imgUrl); } } System.out.println("MediaModule title: " + mModule.getTitle()); System.out.println("MediaModule isAdult: " + mModule.isAdult()); /* if * (mModule.getMediaContent() != null) { for (int i = 0; i < mModule.getMediaContent().length; i++) { MediaContent mc = mModule.getMediaContent()[i]; * mThumbs = mc.getMediaThumbnails(); if (mThumbs != null) { for (int n = 0; n < mThumbs.length; n++) { String imgUrl = mThumbs[n].getUrl(); * System.out.println("got MediaContentImage " + n + " img: " + imgUrl); } } System.out.println("MediaContent title:" + mc.getTitle()); - * System.out.println("MediaContent text:" + mc.getText()); - * - * } - * - * } - * - * } else { System.out.println("no MediaModule!"); } } + * System.out.println("MediaContent text:" + mc.getText()); } } } else { System.out.println("no MediaModule!"); } } */ } } diff --git a/src/test/java/org/rometools/feed/module/activitystreams/types/VerbTest.java b/src/test/java/org/rometools/feed/module/activitystreams/types/VerbTest.java index c2ecf12..621c23c 100644 --- a/src/test/java/org/rometools/feed/module/activitystreams/types/VerbTest.java +++ b/src/test/java/org/rometools/feed/module/activitystreams/types/VerbTest.java @@ -1,12 +1,12 @@ /* * Copyright 2011 robert.cooper. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -20,7 +20,7 @@ package org.rometools.feed.module.activitystreams.types; import junit.framework.TestCase; /** - * + * * @author robert.cooper */ public class VerbTest extends TestCase { diff --git a/src/test/java/org/rometools/feed/module/base/io/CustomTagGeneratorTest.java b/src/test/java/org/rometools/feed/module/base/io/CustomTagGeneratorTest.java index c9c6497..4a42653 100644 --- a/src/test/java/org/rometools/feed/module/base/io/CustomTagGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/base/io/CustomTagGeneratorTest.java @@ -25,7 +25,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author Robert "kebernet" Cooper */ public class CustomTagGeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/base/io/CustomTagParserTest.java b/src/test/java/org/rometools/feed/module/base/io/CustomTagParserTest.java index 1bab1a6..26e1044 100644 --- a/src/test/java/org/rometools/feed/module/base/io/CustomTagParserTest.java +++ b/src/test/java/org/rometools/feed/module/base/io/CustomTagParserTest.java @@ -31,7 +31,7 @@ import com.sun.syndication.feed.synd.SyndFeed; import com.sun.syndication.io.SyndFeedInput; /** - * + * * @author Robert "kebernet" Cooper */ public class CustomTagParserTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/base/io/GoogleBaseGeneratorTest.java b/src/test/java/org/rometools/feed/module/base/io/GoogleBaseGeneratorTest.java index 771cf28..bad1c45 100644 --- a/src/test/java/org/rometools/feed/module/base/io/GoogleBaseGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/base/io/GoogleBaseGeneratorTest.java @@ -30,7 +30,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author rcooper */ public class GoogleBaseGeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/base/io/GoogleBaseParserTest.java b/src/test/java/org/rometools/feed/module/base/io/GoogleBaseParserTest.java index 6e6a631..8ff2c45 100644 --- a/src/test/java/org/rometools/feed/module/base/io/GoogleBaseParserTest.java +++ b/src/test/java/org/rometools/feed/module/base/io/GoogleBaseParserTest.java @@ -42,7 +42,7 @@ import com.sun.syndication.feed.synd.SyndFeed; import com.sun.syndication.io.SyndFeedInput; /** - * + * * @author rcooper */ public class GoogleBaseParserTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/base/types/FloatUnitTest.java b/src/test/java/org/rometools/feed/module/base/types/FloatUnitTest.java index acccf7e..795915d 100644 --- a/src/test/java/org/rometools/feed/module/base/types/FloatUnitTest.java +++ b/src/test/java/org/rometools/feed/module/base/types/FloatUnitTest.java @@ -12,7 +12,7 @@ import junit.framework.TestCase; import junit.framework.TestSuite; /** - * + * * @author rcooper */ public class FloatUnitTest extends TestCase { diff --git a/src/test/java/org/rometools/feed/module/base/types/IntUnitTest.java b/src/test/java/org/rometools/feed/module/base/types/IntUnitTest.java index 9af430c..1cd3ebe 100644 --- a/src/test/java/org/rometools/feed/module/base/types/IntUnitTest.java +++ b/src/test/java/org/rometools/feed/module/base/types/IntUnitTest.java @@ -12,7 +12,7 @@ import junit.framework.TestCase; import junit.framework.TestSuite; /** - * + * * @author rcooper */ public class IntUnitTest extends TestCase { diff --git a/src/test/java/org/rometools/feed/module/cc/io/CCModuleGeneratorTest.java b/src/test/java/org/rometools/feed/module/cc/io/CCModuleGeneratorTest.java index 19aa56a..cb916e4 100644 --- a/src/test/java/org/rometools/feed/module/cc/io/CCModuleGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/cc/io/CCModuleGeneratorTest.java @@ -21,7 +21,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author Robert "kebernet" Cooper */ public class CCModuleGeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/cc/io/ModuleParserTest.java b/src/test/java/org/rometools/feed/module/cc/io/ModuleParserTest.java index 7a8e0f6..00ecc6b 100644 --- a/src/test/java/org/rometools/feed/module/cc/io/ModuleParserTest.java +++ b/src/test/java/org/rometools/feed/module/cc/io/ModuleParserTest.java @@ -21,7 +21,7 @@ import com.sun.syndication.feed.synd.SyndFeed; import com.sun.syndication.io.SyndFeedInput; /** - * + * * @author Robert "kebernet" Cooper */ public class ModuleParserTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/cc/types/LicenseTest.java b/src/test/java/org/rometools/feed/module/cc/types/LicenseTest.java index 46ee8f0..ad8fdc3 100644 --- a/src/test/java/org/rometools/feed/module/cc/types/LicenseTest.java +++ b/src/test/java/org/rometools/feed/module/cc/types/LicenseTest.java @@ -1,13 +1,13 @@ package org.rometools.feed.module.cc.types; -import org.junit.Before; -import org.junit.Test; +import static org.junit.Assert.assertFalse; import java.util.Random; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; -import static org.junit.Assert.assertFalse; +import org.junit.Before; +import org.junit.Test; /** * @author Matthew Buckett @@ -29,37 +29,35 @@ public class LicenseTest { final AtomicBoolean hadException = new AtomicBoolean(false); // This thread keeps on adding new licenses (not very realistic but shows the bug) - Thread addNew = new Thread(){ + final Thread addNew = new Thread() { @Override public void run() { try { - while(run.get()) { - License license = License.findByValue("http://creativecommons.org/licenses/"+ - type.incrementAndGet()+ "/1"); + while (run.get()) { + final License license = License.findByValue("http://creativecommons.org/licenses/" + type.incrementAndGet() + "/1"); if (license == null) { hadProblem.set(true); } } - } catch (Exception e) { + } catch (final Exception e) { hadException.set(true); } } }; // This thread attempts to get ones we know have already been put in. - Thread getExisting = new Thread() { + final Thread getExisting = new Thread() { @Override public void run() { - Random rnd = new Random(); + final Random rnd = new Random(); try { - while(run.get()) { - License license = License.findByValue("http://creativecommons.org/licenses/"+ - rnd.nextInt(type.intValue())+"/1"); + while (run.get()) { + final License license = License.findByValue("http://creativecommons.org/licenses/" + rnd.nextInt(type.intValue()) + "/1"); if (license == null) { hadProblem.set(true); } } - } catch (Exception e) { + } catch (final Exception e) { hadException.set(true); } } diff --git a/src/test/java/org/rometools/feed/module/content/ContentItemTest.java b/src/test/java/org/rometools/feed/module/content/ContentItemTest.java index 41cfb9a..fee37fb 100644 --- a/src/test/java/org/rometools/feed/module/content/ContentItemTest.java +++ b/src/test/java/org/rometools/feed/module/content/ContentItemTest.java @@ -11,7 +11,7 @@ import junit.framework.TestCase; /** * This is all standard property storage testing. - * + * * @author Robert Cooper */ public class ContentItemTest extends TestCase { @@ -114,7 +114,7 @@ public class ContentItemTest extends TestCase { /** * this is a stupid test. - * + * * @todo make better Test of ContentResource method, of class com.totsp.xml.syndication.content.ContentItem. */ public void testEquals() { diff --git a/src/test/java/org/rometools/feed/module/content/ContentModuleGeneratorTest.java b/src/test/java/org/rometools/feed/module/content/ContentModuleGeneratorTest.java index 891e1fc..f48bf56 100644 --- a/src/test/java/org/rometools/feed/module/content/ContentModuleGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/content/ContentModuleGeneratorTest.java @@ -17,7 +17,7 @@ import com.sun.syndication.io.SyndFeedOutput; import com.sun.syndication.io.XmlReader; /** - * + * * @author Robert Cooper */ public class ContentModuleGeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/content/ContentModuleImplTest.java b/src/test/java/org/rometools/feed/module/content/ContentModuleImplTest.java index afef2dd..10ba0b1 100644 --- a/src/test/java/org/rometools/feed/module/content/ContentModuleImplTest.java +++ b/src/test/java/org/rometools/feed/module/content/ContentModuleImplTest.java @@ -13,7 +13,7 @@ import java.util.List; import junit.framework.TestCase; /** - * + * * @author Robert Cooper */ public class ContentModuleImplTest extends TestCase { diff --git a/src/test/java/org/rometools/feed/module/content/ContentModuleParserTest.java b/src/test/java/org/rometools/feed/module/content/ContentModuleParserTest.java index 0d2efdc..70cdec3 100644 --- a/src/test/java/org/rometools/feed/module/content/ContentModuleParserTest.java +++ b/src/test/java/org/rometools/feed/module/content/ContentModuleParserTest.java @@ -17,7 +17,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.XmlReader; /** - * + * * @author Robert Cooper */ public class ContentModuleParserTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/georss/RssTest.java b/src/test/java/org/rometools/feed/module/georss/RssTest.java index 4ca5ca4..2b45c10 100644 --- a/src/test/java/org/rometools/feed/module/georss/RssTest.java +++ b/src/test/java/org/rometools/feed/module/georss/RssTest.java @@ -47,7 +47,7 @@ public class RssTest extends TestCase { /** * compares expected lat/lng values with acutal values read from feed - * + * * @param fileName a file in the src/data directory * @param expectedLat array of expected latitude values * @param expectedLng array of expected longitude values diff --git a/src/test/java/org/rometools/feed/module/itunes/ITunesGeneratorTest.java b/src/test/java/org/rometools/feed/module/itunes/ITunesGeneratorTest.java index a1acc78..be5257c 100644 --- a/src/test/java/org/rometools/feed/module/itunes/ITunesGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/itunes/ITunesGeneratorTest.java @@ -24,7 +24,7 @@ import com.sun.syndication.io.SyndFeedOutput; import com.sun.syndication.io.XmlReader; /** - * + * * @author cooper */ public class ITunesGeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/itunes/ITunesParserTest.java b/src/test/java/org/rometools/feed/module/itunes/ITunesParserTest.java index 7b5b729..0feb617 100644 --- a/src/test/java/org/rometools/feed/module/itunes/ITunesParserTest.java +++ b/src/test/java/org/rometools/feed/module/itunes/ITunesParserTest.java @@ -24,7 +24,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.XmlReader; /** - * + * * @author cooper */ public class ITunesParserTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/itunes/types/DurationTest.java b/src/test/java/org/rometools/feed/module/itunes/types/DurationTest.java index 253ed21..90b1cd5 100644 --- a/src/test/java/org/rometools/feed/module/itunes/types/DurationTest.java +++ b/src/test/java/org/rometools/feed/module/itunes/types/DurationTest.java @@ -26,7 +26,7 @@ import junit.framework.TestCase; import junit.framework.TestSuite; /** - * + * * @author cooper */ public class DurationTest extends TestCase { diff --git a/src/test/java/org/rometools/feed/module/mediarss/GoogleTest.java b/src/test/java/org/rometools/feed/module/mediarss/GoogleTest.java index 7cc14cb..c2d49c0 100644 --- a/src/test/java/org/rometools/feed/module/mediarss/GoogleTest.java +++ b/src/test/java/org/rometools/feed/module/mediarss/GoogleTest.java @@ -20,7 +20,7 @@ import com.sun.syndication.feed.synd.SyndFeed; import com.sun.syndication.io.SyndFeedInput; /** - * + * * @author cooper */ public class GoogleTest extends AbstractTestCase { 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 b74c3d0..be2a880 100644 --- a/src/test/java/org/rometools/feed/module/mediarss/MediaModuleTest.java +++ b/src/test/java/org/rometools/feed/module/mediarss/MediaModuleTest.java @@ -26,7 +26,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author cooper */ public class MediaModuleTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/mediarss/types/TimeTest.java b/src/test/java/org/rometools/feed/module/mediarss/types/TimeTest.java index c08e2dd..030e972 100644 --- a/src/test/java/org/rometools/feed/module/mediarss/types/TimeTest.java +++ b/src/test/java/org/rometools/feed/module/mediarss/types/TimeTest.java @@ -13,7 +13,7 @@ import junit.framework.TestCase; import junit.framework.TestSuite; /** - * + * * @author cooper */ public class TimeTest extends TestCase { diff --git a/src/test/java/org/rometools/feed/module/opensearch/OpenSearchModuleTest.java b/src/test/java/org/rometools/feed/module/opensearch/OpenSearchModuleTest.java index e6021bf..bca6753 100644 --- a/src/test/java/org/rometools/feed/module/opensearch/OpenSearchModuleTest.java +++ b/src/test/java/org/rometools/feed/module/opensearch/OpenSearchModuleTest.java @@ -20,7 +20,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author cooper */ public class OpenSearchModuleTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/photocast/io/GeneratorTest.java b/src/test/java/org/rometools/feed/module/photocast/io/GeneratorTest.java index f5ecc17..11f8f18 100644 --- a/src/test/java/org/rometools/feed/module/photocast/io/GeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/photocast/io/GeneratorTest.java @@ -22,7 +22,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author cooper */ public class GeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/sle/GroupAndSortTest.java b/src/test/java/org/rometools/feed/module/sle/GroupAndSortTest.java index 9dcaf8b..3db7bf7 100644 --- a/src/test/java/org/rometools/feed/module/sle/GroupAndSortTest.java +++ b/src/test/java/org/rometools/feed/module/sle/GroupAndSortTest.java @@ -20,7 +20,7 @@ import com.sun.syndication.feed.synd.SyndFeed; import com.sun.syndication.io.SyndFeedInput; /** - * + * * @author cooper */ public class GroupAndSortTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/sle/io/ModuleGeneratorTest.java b/src/test/java/org/rometools/feed/module/sle/io/ModuleGeneratorTest.java index 1512f77..7d94006 100644 --- a/src/test/java/org/rometools/feed/module/sle/io/ModuleGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/sle/io/ModuleGeneratorTest.java @@ -12,7 +12,7 @@ import junit.framework.TestCase; import junit.framework.TestSuite; /** - * + * * @author cooper */ public class ModuleGeneratorTest extends TestCase { diff --git a/src/test/java/org/rometools/feed/module/sle/io/ModuleParserTest.java b/src/test/java/org/rometools/feed/module/sle/io/ModuleParserTest.java index 1eabbd9..a06fc43 100644 --- a/src/test/java/org/rometools/feed/module/sle/io/ModuleParserTest.java +++ b/src/test/java/org/rometools/feed/module/sle/io/ModuleParserTest.java @@ -24,7 +24,7 @@ import com.sun.syndication.feed.synd.SyndFeed; import com.sun.syndication.io.SyndFeedInput; /** - * + * * @author cooper */ public class ModuleParserTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/sse/SSEParserTest.java b/src/test/java/org/rometools/feed/module/sse/SSEParserTest.java index 9c7c677..aef24c2 100644 --- a/src/test/java/org/rometools/feed/module/sse/SSEParserTest.java +++ b/src/test/java/org/rometools/feed/module/sse/SSEParserTest.java @@ -227,7 +227,7 @@ public class SSEParserTest extends AbstractTestCase { /** * Assure v5 file parsed correctly. - * + * * @throws Exception */ public void xtestV5() throws Exception { diff --git a/src/test/java/org/rometools/feed/module/yahooweather/io/WeahterGeneratorTest.java b/src/test/java/org/rometools/feed/module/yahooweather/io/WeahterGeneratorTest.java index cefcfeb..ca25768 100644 --- a/src/test/java/org/rometools/feed/module/yahooweather/io/WeahterGeneratorTest.java +++ b/src/test/java/org/rometools/feed/module/yahooweather/io/WeahterGeneratorTest.java @@ -22,7 +22,7 @@ import com.sun.syndication.io.SyndFeedInput; import com.sun.syndication.io.SyndFeedOutput; /** - * + * * @author Robert "kebernet" Cooper */ public class WeahterGeneratorTest extends AbstractTestCase { diff --git a/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParserTest.java b/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParserTest.java index 4b81cda..3d006e1 100644 --- a/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParserTest.java +++ b/src/test/java/org/rometools/feed/module/yahooweather/io/WeatherModuleParserTest.java @@ -23,7 +23,7 @@ import com.sun.syndication.feed.synd.SyndFeed; import com.sun.syndication.io.SyndFeedInput; /** - * + * * @author Robert "kebernet" Cooper */ public class WeatherModuleParserTest extends AbstractTestCase {