com.rometools.rome.feed.atom.Entry Maven / Gradle / Ivy
Show all versions of rome Show documentation
/*
* Copyright 2004 Sun Microsystems, Inc.
* Copyright 2011 ROME Team
* 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.
*
*/
package com.rometools.rome.feed.atom;
import java.io.Serializable;
import java.util.Date;
import java.util.List;
import org.jdom2.Element;
import com.rometools.rome.feed.impl.ObjectBean;
import com.rometools.rome.feed.module.Extendable;
import com.rometools.rome.feed.module.Module;
import com.rometools.rome.feed.module.impl.ModuleUtils;
import com.rometools.rome.feed.synd.SyndPerson;
import com.rometools.utils.Dates;
import com.rometools.utils.Lists;
/**
* Bean for entry elements of Atom feeds.
*
*
* @author Alejandro Abdelnur
* @author Dave Johnson (updated for Atom 1.0)
*/
public class Entry implements Cloneable, Serializable, Extendable {
private static final long serialVersionUID = 1L;
private Content summary;
private Content title;
private Date created; // Atom 0.3 only
private Date published; // AKA issued
private Date updated; // AKA modified
private Feed source;
private List alternateLinks;
private List authors;
private List categories;
private List contents;
private List contributors;
private List foreignMarkup;
private List modules;
private List otherLinks;
private final ObjectBean objBean;
private String id;
private String rights;
private String xmlBase;
/**
* Default constructor. All properties are set to null.
*
*
*/
public Entry() {
objBean = new ObjectBean(this.getClass(), this);
}
/**
* Sets the entry alternate links.
*
*
* @param alternateLinks the list of Link elements with the entry alternate links to set, an
* empty list or null if none.
*/
public void setAlternateLinks(final List alternateLinks) {
this.alternateLinks = alternateLinks;
}
/**
* Returns the entry alternate links.
*
*
* @return a list of Link elements with the entry alternate links, an empty list if none.
*/
public List getAlternateLinks() {
return alternateLinks = Lists.createWhenNull(alternateLinks);
}
/**
* Sets the author of the entry.
*
*
* @param authors the author of the entry, null if none.
*
*/
public void setAuthors(final List authors) {
this.authors = authors;
}
/**
* Returns the entry author.
*
*
* @return the entry author, null if none.
*
*/
public List getAuthors() {
return authors = Lists.createWhenNull(authors);
}
/**
* Set the categories
*
*
* @param categories The categories to set.
* @since Atom 1.0
*/
public void setCategories(final List categories) {
this.categories = categories;
}
/**
* Returns the categories
*
*
* @return Returns the categories.
* @since Atom 1.0
*/
public List getCategories() {
return categories = Lists.createWhenNull(categories);
}
/**
* Sets the entry contents.
*
*
* @param contents the list of Content elements with the entry contents to set, an empty list or
* null if none.
*/
public void setContents(final List contents) {
this.contents = contents;
}
/**
* Returns the entry contents.
*
*
* @return a list of Content elements with the entry contents, an empty list if none.
*/
public List getContents() {
return contents = Lists.createWhenNull(contents);
}
/**
* Sets the entry contributors.
*
*
* @param contributors the list of Person elements with the entry contributors to set, an empty
* list or null if none.
*
*/
public void setContributors(final List contributors) {
this.contributors = contributors;
}
/**
* Returns the entry contributors.
*
*
* @return a list of Person elements with the entry contributors, an empty list if none.
*
*/
public List getContributors() {
return contributors = Lists.createWhenNull(contributors);
}
/**
* Sets the entry created date (Atom 0.3 only)
*
*
* @param created the entry created date, null if none.
*/
public void setCreated(final Date created) {
this.created = Dates.copy(created);
}
/**
* Returns the entry created date (Atom 0.3 only)
*
*
* @return the entry created date, null if none.
*/
public Date getCreated() {
return Dates.copy(created);
}
/**
* Sets foreign markup found at entry level.
*
*
* @param foreignMarkup Opaque object to discourage use
*
*/
public void setForeignMarkup(final List foreignMarkup) {
this.foreignMarkup = foreignMarkup;
}
/**
* Returns foreign markup found at entry level.
*
*
* @return list of Opaque object to discourage use
*
*/
public List getForeignMarkup() {
return foreignMarkup = Lists.createWhenNull(foreignMarkup);
}
/**
* Sets the entry ID.
*
*
* @param id the entry ID, null if none.
*
*/
public void setId(final String id) {
this.id = id;
}
/**
* Returns the entry ID.
*
*
* @return the entry ID, null if none.
*
*/
public String getId() {
return id;
}
/**
* Sets the entry issued date (Atom 0.3, maps to {@link #setPublished(java.util.Date)}).
*
*
* @param issued the entry issued date, null if none.
*/
public void setIssued(final Date issued) {
published = Dates.copy(issued);
}
/**
* Returns the entry issued date (Atom 0.3, maps to {@link #getPublished()} ).
*
*
* @return the entry issued date, null if none.
*/
public Date getIssued() {
return Dates.copy(published);
}
/**
* Returns true if entry is a media entry, i.e. has rel="edit-media".
*
* @return true if entry is a media entry
*/
public boolean isMediaEntry() {
boolean mediaEntry = false;
final List links = getOtherLinks();
for (final Link link : links) {
if ("edit-media".equals(link.getRel())) {
mediaEntry = true;
break;
}
}
return mediaEntry;
}
/**
* Sets the entry modified date (Atom 0.3, maps to {@link #setUpdated(java.util.Date)}).
*
*
* @param modified the entry modified date, null if none.
*/
public void setModified(final Date modified) {
updated = Dates.copy(modified);
}
/**
* Returns the entry modified date (Atom 0.3, maps to {@link #getUpdated()} ).
*
*
* @return the entry modified date, null if none.
*/
public Date getModified() {
return Dates.copy(updated);
}
/**
* Returns the module identified by a given URI.
*
*
* @param uri the URI of the ModuleImpl.
* @return The module with the given URI, null if none.
*/
@Override
public Module getModule(final String uri) {
return ModuleUtils.getModule(modules, uri);
}
/**
* Sets the entry modules.
*
*
* @param modules the list of ModuleImpl elements with the entry modules to set, an empty list
* or null if none.
*
*/
@Override
public void setModules(final List modules) {
this.modules = modules;
}
/**
* Returns the entry modules.
*
*
* @return a list of ModuleImpl elements with the entry modules, an emtpy list if none.
*
*/
@Override
public List getModules() {
return modules = Lists.createWhenNull(modules);
}
/**
* Sets the entry non-alternate links.
*
*
* @param otherLinks the list Link elements with the entry non-alternate links to set, an empty
* list or null if none.
*/
public void setOtherLinks(final List otherLinks) {
this.otherLinks = otherLinks;
}
/**
* Returns the entry non-alternate links.
*
*
* @return the list of Link elements with the entry non-alternate links to set, an empty list if
* none.
*/
public List getOtherLinks() {
return otherLinks = Lists.createWhenNull(otherLinks);
}
/**
* Set the published
*
*
* @param published The published to set.
* @since Atom 1.0
*/
public void setPublished(final Date published) {
this.published = Dates.copy(published);
}
/**
* Returns the published
*
*
* @return Returns the published.
* @since Atom 1.0
*/
public Date getPublished() {
return Dates.copy(published);
}
/**
* Set the rights
*
*
* @param rights The rights to set.
* @since Atom 1.0
*/
public void setRights(final String rights) {
this.rights = rights;
}
/**
* Returns the rights
*
*
* @return Returns the rights.
* @since Atom 1.0
*/
public String getRights() {
return rights;
}
/**
* Set the source
*
*
* @param source The source to set.
*/
public void setSource(final Feed source) {
this.source = source;
}
/**
* Returns the source
*
*
* @return Returns the source.
*/
public Feed getSource() {
return source;
}
/**
* Sets the entry summary.
*
*
* @param summary the entry summary, null if none.
*
*/
public void setSummary(final Content summary) {
this.summary = summary;
}
/**
* Returns the entry summary.
*
*
* @return the entry summary, null if none.
*
*/
public Content getSummary() {
return summary;
}
/**
* Sets the entry title.
*
*
* @param title the entry title, null if none.
*
*/
public void setTitle(final String title) {
if (this.title == null) {
this.title = new Content();
}
this.title.setValue(title);
}
/**
* Returns the entry title.
*
*
* @return the entry title, null if none.
*
*/
public String getTitle() {
if (title != null) {
return title.getValue();
}
return null;
}
/**
* Sets the entry title as a text construct.
*
*
* @param title the entry title, null if none.
*
*/
public void setTitleEx(final Content title) {
this.title = title;
}
/**
* Returns the entry title as a text construct.
*
*
* @return the entry title, null if none.
*
*/
public Content getTitleEx() {
return title;
}
/**
* Set the updated
*
*
* @param updated The updated to set.
* @since Atom 1.0
*/
public void setUpdated(final Date updated) {
this.updated = Dates.copy(updated);
}
/**
* Returns the updated
*
*
* @return Returns the updated.
* @since Atom 1.0
*/
public Date getUpdated() {
return Dates.copy(updated);
}
/**
* Set the xmlBase
*
*
* @param xmlBase The xmlBase to set.
* @since Atom 1.0
*/
public void setXmlBase(final String xmlBase) {
this.xmlBase = xmlBase;
}
/**
* Returns the xmlBase
*
*
* @return Returns the xmlBase.
* @since Atom 1.0
*/
public String getXmlBase() {
return xmlBase;
}
/**
* 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 {
return objBean.clone();
}
/**
* 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) {
if (other == null) {
return false;
}
if (!(other instanceof Entry)) {
return false;
}
// can't use foreign markup in equals, due to JDOM equals impl
final List fm = getForeignMarkup();
setForeignMarkup(((Entry) other).getForeignMarkup());
final boolean ret = objBean.equals(other);
// restore foreign markup
setForeignMarkup(fm);
return ret;
}
/**
* Returns a hashcode value for the object.
*
* It follows the contract defined by the Object hashCode() method.
*
*
* @return the hashcode of the bean object.
*
*/
@Override
public int hashCode() {
return objBean.hashCode();
}
/**
* Returns the String representation for the object.
*
*
* @return String representation for the object.
*
*/
@Override
public String toString() {
return objBean.toString();
}
public Link findRelatedLink(final String relation) {
for (final Link link : otherLinks) {
if (relation.equals(link.getRel())) {
return link;
}
}
return null;
}
}