Atom module support (#347)

Author: w3stling

src/main/java/com/apptasticsoftware/rssreader/FeedChannel.java

@@ -1,5 +1,6 @@
 package com.apptasticsoftware.rssreader;
 
+import com.apptasticsoftware.rssreader.module.atom.AtomChannel;
 import com.apptasticsoftware.rssreader.module.dc.DcChannel;
 import com.apptasticsoftware.rssreader.module.georss.GeoRssChannel;
 import com.apptasticsoftware.rssreader.module.itunes.ItunesChannel;
@@ -12,5 +13,5 @@
 import com.apptasticsoftware.rssreader.module.wfw.WfwChannel;
 import com.apptasticsoftware.rssreader.module.youtube.YoutubeChannel;
 
-public interface FeedChannel extends Channel, DcChannel, GeoRssChannel, ItunesChannel, MediaRssChannel, OpenSearchChannel, PodcastChannel, PscChannel, SlashChannel, SpotifyChannel, WfwChannel, YoutubeChannel {
+public interface FeedChannel extends Channel, AtomChannel, DcChannel, GeoRssChannel, ItunesChannel, MediaRssChannel, OpenSearchChannel, PodcastChannel, PscChannel, SlashChannel, SpotifyChannel, WfwChannel, YoutubeChannel {
 }

src/main/java/com/apptasticsoftware/rssreader/FeedItem.java

@@ -1,5 +1,6 @@
 package com.apptasticsoftware.rssreader;
 
+import com.apptasticsoftware.rssreader.module.atom.AtomItem;
 import com.apptasticsoftware.rssreader.module.dc.DcItem;
 import com.apptasticsoftware.rssreader.module.georss.GeoRssItem;
 import com.apptasticsoftware.rssreader.module.itunes.ItunesItem;
@@ -12,6 +13,6 @@
 import com.apptasticsoftware.rssreader.module.wfw.WfwItem;
 import com.apptasticsoftware.rssreader.module.youtube.YoutubeItem;
 
-public interface FeedItem extends Item, DcItem, GeoRssItem, ItunesItem, MediaRssItem, OpenSearchItem, PodcastItem, PscItem, SlashItem, SpotifyItem, WfwItem, YoutubeItem {
+public interface FeedItem extends Item, AtomItem, DcItem, GeoRssItem, ItunesItem, MediaRssItem, OpenSearchItem, PodcastItem, PscItem, SlashItem, SpotifyItem, WfwItem, YoutubeItem {
 
 }

src/main/java/com/apptasticsoftware/rssreader/FeedReader.java

@@ -2,6 +2,7 @@
 
 import com.apptasticsoftware.rssreader.internal.FeedChannelImpl;
 import com.apptasticsoftware.rssreader.internal.FeedItemImpl;
+import com.apptasticsoftware.rssreader.module.atom.AtomExtensions;
 import com.apptasticsoftware.rssreader.module.dc.DcExtensions;
 import com.apptasticsoftware.rssreader.module.georss.GeoRssExtensions;
 import com.apptasticsoftware.rssreader.module.itunes.ItunesExtensions;
@@ -30,6 +31,7 @@ protected FeedItem createItem(DateTimeParser dateTimeParser) {
     protected void registerChannelTags() {
         super.registerChannelTags();
         var registry = getFeedExtensionRegistry();
+        AtomExtensions.register(registry);
         DcExtensions.register(registry);
         GeoRssExtensions.register(registry);
         ItunesExtensions.register(registry);

src/main/java/com/apptasticsoftware/rssreader/internal/FeedChannelImpl.java

@@ -2,6 +2,8 @@
 
 import com.apptasticsoftware.rssreader.DateTimeParser;
 import com.apptasticsoftware.rssreader.FeedChannel;
+import com.apptasticsoftware.rssreader.module.atom.AtomChannelData;
+import com.apptasticsoftware.rssreader.module.atom.internal.AtomChannelDataImpl;
 import com.apptasticsoftware.rssreader.module.dc.DcChannelData;
 import com.apptasticsoftware.rssreader.module.dc.internal.DcChannelDataImpl;
 import com.apptasticsoftware.rssreader.module.georss.GeoRssChannelData;
@@ -22,6 +24,7 @@
 import java.util.Objects;
 
 public class FeedChannelImpl extends ChannelImpl implements FeedChannel {
+    private final AtomChannelData atomChannelData = new AtomChannelDataImpl();
     private final DcChannelData dcChannelData = new DcChannelDataImpl();
     private final GeoRssChannelData geoRssChannelData = new GeoRssChannelDataImpl();
     private final ItunesChannelData itunesChannelData = new ItunesChannelDataImpl();
@@ -40,6 +43,11 @@ public FeedChannelImpl(DateTimeParser dateTimeParser) {
         super(dateTimeParser);
     }
 
+    @Override
+    public AtomChannelData getAtomChannelData() {
+        return atomChannelData;
+    }
+
     @Override
     public DcChannelData getDcChannelData() {
         return dcChannelData;

src/main/java/com/apptasticsoftware/rssreader/internal/FeedItemImpl.java

@@ -2,6 +2,8 @@
 
 import com.apptasticsoftware.rssreader.DateTimeParser;
 import com.apptasticsoftware.rssreader.FeedItem;
+import com.apptasticsoftware.rssreader.module.atom.AtomItemData;
+import com.apptasticsoftware.rssreader.module.atom.internal.AtomItemDataImpl;
 import com.apptasticsoftware.rssreader.module.dc.DcItemData;
 import com.apptasticsoftware.rssreader.module.dc.internal.DcItemDataImpl;
 import com.apptasticsoftware.rssreader.module.georss.GeoRssItemData;
@@ -24,7 +26,8 @@
 import java.util.Objects;
 
 public class FeedItemImpl extends ItemImpl implements FeedItem {
-    private final DcItemData dcChannelData = new DcItemDataImpl();
+    private final AtomItemData atomItemData = new AtomItemDataImpl();
+    private final DcItemData dcItemData = new DcItemDataImpl();
     private final GeoRssItemData geoRssItemData = new GeoRssItemDataImpl();
     private final ItunesItemData itunesItemData = new ItunesItemDataImpl();
     private final MediaRssItemData mediaRssItemData = new MediaRssItemDataImpl();
@@ -44,9 +47,14 @@ public FeedItemImpl(DateTimeParser dateTimeParser) {
         podcastItemData = new PodcastItemDataImpl(dateTimeParser);
     }
 
+    @Override
+    public AtomItemData getAtomItemData() {
+        return atomItemData;
+    }
+
     @Override
     public DcItemData getDcItemData() {
-        return dcChannelData;
+        return dcItemData;
     }
 
     @Override

src/main/java/com/apptasticsoftware/rssreader/module/atom/AtomAuthor.java

@@ -0,0 +1,66 @@
+package com.apptasticsoftware.rssreader.module.atom;
+
+/**
+ * Represents an Atom author element describing a person, corporation, or similar entity.
+ * Contains one required element (name) and two optional elements (uri, email).
+ */
+public class AtomAuthor {
+    String name;
+    String uri;
+    String email;
+
+    /**
+     * Gets the human-readable name for the person.
+     *
+     * @return the name
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the human-readable name for the person.
+     *
+     * @param name the name
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * Gets the home page for the person.
+     *
+     * @return the URI
+     */
+    public String getUri() {
+        return uri;
+    }
+
+    /**
+     * Sets the home page for the person.
+     *
+     * @param uri the URI
+     */
+    public void setUri(String uri) {
+        this.uri = uri;
+    }
+
+    /**
+     * Gets the email address for the person.
+     *
+     * @return the email address
+     */
+    public String getEmail() {
+        return email;
+    }
+
+    /**
+     * Sets the email address for the person.
+     *
+     * @param email the email address
+     */
+    public void setEmail(String email) {
+        this.email = email;
+    }
+
+}

src/main/java/com/apptasticsoftware/rssreader/module/atom/AtomChannel.java

@@ -0,0 +1,16 @@
+package com.apptasticsoftware.rssreader.module.atom;
+
+import com.apptasticsoftware.rssreader.Channel;
+
+/**
+ * Represents an Atom feed channel, combining standard RSS channel fields with Atom-specific data.
+ */
+public interface AtomChannel extends Channel, AtomChannelData {
+
+    /**
+     * Returns the Atom channel data.
+     *
+     * @return the Atom channel data
+     */
+    AtomChannelData getAtomChannelData();
+}

src/main/java/com/apptasticsoftware/rssreader/module/atom/AtomChannelData.java

@@ -0,0 +1,63 @@
+package com.apptasticsoftware.rssreader.module.atom;
+
+import java.util.List;
+
+/**
+ * Provides access to Atom-specific data for a feed channel, including links, authors, and contributors.
+ */
+public interface AtomChannelData {
+
+    /**
+     * Returns the underlying Atom channel data.
+     * @return the Atom channel data
+     */
+    AtomChannelData getAtomChannelData();
+
+    /**
+     * Returns the list of Atom links.
+     * @return the list of Atom links
+     */
+    default List<AtomLink> getAtomLinks() {
+        return getAtomChannelData().getAtomLinks();
+    }
+
+    /**
+     * Adds an Atom link.
+     * @param atomLink the Atom link to add
+     */
+    default void addAtomLink(AtomLink atomLink) {
+        getAtomChannelData().addAtomLink(atomLink);
+    }
+
+    /**
+     * Returns the list of Atom authors.
+     * @return the list of Atom authors
+     */
+    default List<AtomAuthor> getAtomAuthors() {
+        return getAtomChannelData().getAtomAuthors();
+    }
+
+    /**
+     * Adds an Atom author.
+     * @param atomAuthor the Atom author to add
+     */
+    default void addAtomAuthor(AtomAuthor atomAuthor) {
+        getAtomChannelData().addAtomAuthor(atomAuthor);
+    }
+
+    /**
+     * Returns the list of Atom contributors.
+     * @return the list of Atom contributors
+     */
+    default List<AtomContributor> getAtomContributors() {
+        return getAtomChannelData().getAtomContributors();
+    }
+
+    /**
+     * Adds an Atom contributor.
+     * @param atomContributor the Atom contributor to add
+     */
+    default void addAtomContributor(AtomContributor atomContributor) {
+        getAtomChannelData().addAtomContributor(atomContributor);
+    }
+}

src/main/java/com/apptasticsoftware/rssreader/module/atom/AtomContributor.java

@@ -0,0 +1,66 @@
+package com.apptasticsoftware.rssreader.module.atom;
+
+/**
+ * Represents an Atom author element describing a person, corporation, or similar entity.
+ * Contains one required element (name) and two optional elements (uri, email).
+ */
+public class AtomContributor {
+    String name;
+    String uri;
+    String email;
+
+    /**
+     * Gets the human-readable name for the person.
+     *
+     * @return the name
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the human-readable name for the person.
+     *
+     * @param name the name
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * Gets the home page for the person.
+     *
+     * @return the URI
+     */
+    public String getUri() {
+        return uri;
+    }
+
+    /**
+     * Sets the home page for the person.
+     *
+     * @param uri the URI
+     */
+    public void setUri(String uri) {
+        this.uri = uri;
+    }
+
+    /**
+     * Gets the email address for the person.
+     *
+     * @return the email address
+     */
+    public String getEmail() {
+        return email;
+    }
+
+    /**
+     * Sets the email address for the person.
+     *
+     * @param email the email address
+     */
+    public void setEmail(String email) {
+        this.email = email;
+    }
+
+}