Package org.apache.juneau.bean.atom

Class CommonEntry

java.lang.Object
org.apache.juneau.bean.atom.Common
org.apache.juneau.bean.atom.CommonEntry
Direct Known Subclasses:
Entry, Feed, Source
public class CommonEntry extends Common
Base class for feed-level and entry-level Atom elements.

This abstract class contains properties common to Feed, Entry, and Source elements. These elements share a common set of metadata properties including authors, contributors, categories, links, and timestamps.

Common properties include:

  • id (required) - Permanent, unique identifier
  • title (required) - Human-readable title
  • updated (required) - Last modification timestamp
  • authors - Author information
  • categories - Classification/tagging information
  • contributors - Contributor information
  • links - Related resources
  • rights - Copyright/rights information

This class extends Common, inheriting the xml:base and xml:lang attributes.

See Also:

  • Constructor Details

    • CommonEntry

      public CommonEntry(Id id, Text title, Calendar updated)
      Normal constructor.
      Parameters:
      id - The ID of this object.
      title - The title of this object.
      updated - The updated timestamp of this object.

    • CommonEntry

      public CommonEntry(String id, String title, String updated)
      Normal constructor.
      Parameters:
      id - The ID of this object.
      title - The title of this object.
      updated - The updated timestamp of this object.

    • CommonEntry

      public CommonEntry()
      Bean constructor.

  • Method Details

    • getAuthors

      @Xml(format=COLLAPSED, childName="author") public Person[] getAuthors()
      Bean property getter: authors.

      The list of authors for this object.

      Returns:
      The property value, or null if it is not set.

    • setAuthors

      public CommonEntry setAuthors(Person... value)
      Bean property setter: authors.

      The list of authors for this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getCategories

      @Xml(format=COLLAPSED, childName="category") public Category[] getCategories()
      Bean property getter: categories.

      The list of categories of this object.

      Returns:
      The property value, or null if it is not set.

    • setCategories

      public CommonEntry setCategories(Category... value)
      Bean property setter: categories.

      The list of categories of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getContributors

      @Xml(format=COLLAPSED, childName="contributor") public Person[] getContributors()
      Bean property getter: contributors.

      The list of contributors of this object.

      Returns:
      The property value, or null if it is not set.

    • setContributors

      public CommonEntry setContributors(Person... value)
      Bean property setter: contributors.

      The list of contributors of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getId

      public Id getId()
      Bean property getter: id.

      The ID of this object.

      Returns:
      The property value, or null if it is not set.

    • setId

      public CommonEntry setId(Id value)
      Bean property setter: id.

      The ID of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setId

      public CommonEntry setId(String value)
      Bean property fluent setter: id.

      The ID of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getLinks

      @Xml(format=COLLAPSED) public Link[] getLinks()
      Bean property getter: links.

      The list of links of this object.

      Returns:
      The property value, or null if it is not set.

    • setLinks

      public CommonEntry setLinks(Link... value)
      Bean property setter: links.

      The list of links of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getRights

      public Text getRights()
      Bean property getter: rights.

      The rights statement of this object.

      Returns:
      The property value, or null if it is not set.

    • setRights

      public CommonEntry setRights(Text value)
      Bean property setter: rights.

      The rights statement of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setRights

      public CommonEntry setRights(String value)
      Bean property fluent setter: rights.

      The rights statement of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getTitle

      public Text getTitle()
      Bean property getter: title.

      The title of this object.

      Returns:
      The property value, or null if it is not set.

    • setTitle

      public CommonEntry setTitle(Text value)
      Bean property setter: title.

      The title of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setTitle

      public CommonEntry setTitle(String value)
      Bean property fluent setter: title.

      The title of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getUpdated

      public Calendar getUpdated()
      Bean property getter: updated.

      The update timestamp of this object.

      Returns:
      The property value, or null if it is not set.

    • setUpdated

      public CommonEntry setUpdated(Calendar value)
      Bean property setter: updated.

      The update timestamp of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setUpdated

      public CommonEntry setUpdated(String value)
      Bean property fluent setter: updated.

      The update timestamp of this object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • setBase

      public CommonEntry setBase(Object value)
      Description copied from class: Common
      Bean property setter: base.

      Sets the base URI for resolving relative URI references (xml:base attribute).

      The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.

      Example:

      Feed feed = new Feed(...) .setBase("http://example.org/");

      Overrides:
      setBase in class Common
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • setLang

      public CommonEntry setLang(String value)
      Description copied from class: Common
      Bean property setter: lang.

      Sets the natural language of the element's content (xml:lang attribute).

      Example:

      Text title = new Text("text") .setText("Mon Blog") .setLang("fr");

      Overrides:
      setLang in class Common
      Parameters:
      value - The new value for this property (e.g., "en", "fr", "de", "en-US").
      Can be null to unset the property.
      Returns:
      This object.