PatchesAndForks/rome
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Formatted and cleaned up sources

Browse source
This commit is contained in:
Patrick Gotthard 2014-05-13 19:28:08 +02:00
parent 6eca421a93
commit ed8691df13
93 changed files with 1089 additions and 1055 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/main/java/com/sun/syndication/feed/CopyFrom.java
View file

@ -28,7 +28,7 @@ public interface CopyFrom {
* This is useful when dealing with properties that may have multiple implementations. For
* example, Module.
* <p>
*
*
* @return the interface the copyFrom works on.
*/
public Class<? extends CopyFrom> getInterface();
@ -41,9 +41,9 @@ public interface CopyFrom {
* 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.
* <p>
*
*
* @param obj the instance to copy properties from.
*
*
*/
public void copyFrom(CopyFrom obj);

50
src/main/java/com/sun/syndication/feed/atom/Generator.java
View file

@ -23,14 +23,14 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for the generator element of Atom feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Generator implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
private final ObjectBean objBean;
private String url;
private String version;
@ -39,7 +39,7 @@ public class Generator implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Generator() {
objBean = new ObjectBean(this.getClass(), this);
@ -48,10 +48,10 @@ public class Generator implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -62,10 +62,10 @@ public class Generator implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -80,9 +80,9 @@ public class Generator implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -92,9 +92,9 @@ public class Generator implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -104,9 +104,9 @@ public class Generator implements Cloneable, Serializable {
/**
* Returns the generator URL.
* <p>
*
*
* @return the generator URL, <b>null</b> if none.
*
*
*/
public String getUrl() {
return url;
@ -115,9 +115,9 @@ public class Generator implements Cloneable, Serializable {
/**
* Sets the generator URL.
* <p>
*
*
* @param url the generator URL, <b>null</b> if none.
*
*
*/
public void setUrl(final String url) {
this.url = url;
@ -126,9 +126,9 @@ public class Generator implements Cloneable, Serializable {
/**
* Returns the generator version.
* <p>
*
*
* @return the generator version, <b>null</b> if none.
*
*
*/
public String getVersion() {
return version;
@ -137,9 +137,9 @@ public class Generator implements Cloneable, Serializable {
/**
* Sets the generator version.
* <p>
*
*
* @param version the generator version, <b>null</b> if none.
*
*
*/
public void setVersion(final String version) {
this.version = version;
@ -148,9 +148,9 @@ public class Generator implements Cloneable, Serializable {
/**
* Returns the generator value.
* <p>
*
*
* @return the generator value, <b>null</b> if none.
*
*
*/
public String getValue() {
return value;
@ -159,9 +159,9 @@ public class Generator implements Cloneable, Serializable {
/**
* Sets the generator value.
* <p>
*
*
* @param value the generator value, <b>null</b> if none.
*
*
*/
public void setValue(final String value) {
this.value = value;

10
src/main/java/com/sun/syndication/feed/impl/BeanIntrospector.java
View file

@ -33,9 +33,9 @@ import java.util.Set;
* <p>
* The java.beans.Introspector does not process the interfaces hierarchy chain, this one does.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class BeanIntrospector {
@ -47,7 +47,7 @@ public class BeanIntrospector {
/**
* Extract all {@link PropertyDescriptor}s for properties with getters and setters for the given
* class.
*
*
* @param clazz The class to extract the desired {@link PropertyDescriptor}s from
* @return All {@link PropertyDescriptor} for properties with getters and setters for the given
* class.
@ -66,7 +66,7 @@ public class BeanIntrospector {
/**
* Extract all {@link PropertyDescriptor}s for properties with a getter that does not come from
* {@link Object} and does not accept parameters.
*
*
* @param clazz The class to extract the desired {@link PropertyDescriptor}s from
* @return All {@link PropertyDescriptor}s for properties with a getter that does not come from
* {@link Object} and does not accept parameters.
@ -105,7 +105,7 @@ public class BeanIntrospector {
/**
* Extract all {@link PropertyDescriptor}s for properties with a getter (that does not come from
* {@link Object} and does not accept parameters) and a setter.
*
*
* @param clazz The class to extract the desired {@link PropertyDescriptor}s from
* @return All {@link PropertyDescriptor}s for properties with a getter (that does not come from
* {@link Object} and does not accept parameters) and a setter.

6
src/main/java/com/sun/syndication/feed/impl/CloneableBean.java
View file

@ -85,15 +85,15 @@ public class CloneableBean implements Serializable, Cloneable {
* <code>
* public class Foo implements Cloneable {
* private CloneableBean cloneableBean;
*
*
* public Foo() {
* cloneableBean = new CloneableBean(this);
* }
*
*
* public Object clone() throws CloneNotSupportedException {
* return cloneableBean.beanClone();
* }
*
*
* }
* </code>
* <p>

8
src/main/java/com/sun/syndication/feed/impl/ConfigurableClassLoader.java
View file

@ -5,9 +5,9 @@ package com.sun.syndication.feed.impl;
* problems, simply override the default ClassLoader by calling the
* {@link #setClassLoader(ClassLoader)} method before calling any ROME code. Unfortunately I don't
* know whether this works because I have absolutely no experience with OSGi.
*
*
* @author Patrick Gotthard
*
*
*/
public enum ConfigurableClassLoader {
@ -17,7 +17,7 @@ public enum ConfigurableClassLoader {
/**
* Get the configured ClassLoader. Returns
*
*
* @return The configured ClassLoader. Returns the ClassLoader of this enum when the ClassLoader
* was not overridden.
*/
@ -30,7 +30,7 @@ public enum ConfigurableClassLoader {
/**
* Overrides the default ClassLoader (the ClassLoader of this enum).
*
*
* @param classLoader The ClassLoader to set.
*/
public void setClassLoader(final ClassLoader classLoader) {

28
src/main/java/com/sun/syndication/feed/impl/EqualsBean.java
View file

@ -30,9 +30,9 @@ import java.util.List;
* <p>
* The hashcode is calculated by getting the hashcode of the Bean String representation.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class EqualsBean implements Serializable {
@ -48,9 +48,9 @@ public class EqualsBean implements Serializable {
* <p>
* To be used by classes extending EqualsBean only.
* <p>
*
*
* @param beanClass the class/interface to be used for property scanning.
*
*
*/
protected EqualsBean(final Class<?> beanClass) {
this.beanClass = beanClass;
@ -81,10 +81,10 @@ public class EqualsBean implements Serializable {
* }
* </code>
* <p>
*
*
* @param beanClass the class/interface to be used for property scanning.
* @param obj object bean to test equality.
*
*
*/
public EqualsBean(final Class<?> beanClass, final Object obj) {
if (!beanClass.isInstance(obj)) {
@ -100,12 +100,12 @@ public class EqualsBean implements Serializable {
* <p>
* To be used by classes extending EqualsBean. Although it works also for classes using
* EqualsBean in a delegation pattern, for correctness those classes should use the
*
*
* @see #beanEquals(Object) beanEquals method.
* <p>
* @param obj he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object obj) {
@ -117,12 +117,12 @@ public class EqualsBean implements Serializable {
* defined by the Object equals() method.
* <p>
* To be used by classes using EqualsBean in a delegation pattern,
*
*
* @see #EqualsBean(Class,Object) constructor.
* <p>
* @param obj he reference object with which to compare.
* @return <b>true</b> if the object passed in the constructor is equal to the 'obj' object.
*
*
*/
public boolean beanEquals(final Object obj) {
@ -174,11 +174,11 @@ public class EqualsBean implements Serializable {
* <p>
* To be used by classes extending EqualsBean. Although it works also for classes using
* EqualsBean in a delegation pattern, for correctness those classes should use the
*
*
* @see #beanHashCode() beanHashCode method.
* <p>
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -193,11 +193,11 @@ public class EqualsBean implements Serializable {
* The hashcode is calculated by getting the hashcode of the Bean String representation.
* <p>
* To be used by classes using EqualsBean in a delegation pattern,
*
*
* @see #EqualsBean(Class,Object) constructor.
* <p>
* @return the hashcode of the bean object.
*
*
*/
public int beanHashCode() {
return obj.toString().hashCode();

28
src/main/java/com/sun/syndication/feed/impl/ObjectBean.java
View file

@ -36,9 +36,9 @@ import java.util.Set;
* <P>
* All ObjectBean subclasses properties should be live references.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class ObjectBean implements Serializable, Cloneable {
@ -51,9 +51,9 @@ public class ObjectBean implements Serializable, Cloneable {
/**
* Constructor.
* <p>
*
*
* @param beanClass the class/interface to be used for property scanning.
*
*
*/
public ObjectBean(final Class<?> beanClass, final Object obj) {
this(beanClass, obj, null);
@ -68,10 +68,10 @@ public class ObjectBean implements Serializable, Cloneable {
* and SyndEntry beans have convenience properties, publishedDate, author, copyright and
* categories all of them mapped to properties in the DC Module.
* <p>
*
*
* @param beanClass the class/interface to be used for property scanning.
* @param ignoreProperties properties to ignore when cloning.
*
*
*/
public ObjectBean(final Class<?> beanClass, final Object obj, final Set<String> ignoreProperties) {
equalsBean = new EqualsBean(beanClass, obj);
@ -82,10 +82,10 @@ public class ObjectBean implements Serializable, Cloneable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -96,10 +96,10 @@ public class ObjectBean implements Serializable, Cloneable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -111,9 +111,9 @@ public class ObjectBean implements Serializable, Cloneable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -123,9 +123,9 @@ public class ObjectBean implements Serializable, Cloneable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {

20
src/main/java/com/sun/syndication/feed/impl/ToStringBean.java
View file

@ -36,9 +36,9 @@ import org.slf4j.LoggerFactory;
* It works on all read/write properties, recursively. It support all primitive types, Strings,
* Collections, ToString objects and multi-dimensional arrays of any of them.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class ToStringBean implements Serializable {
@ -67,9 +67,9 @@ public class ToStringBean implements Serializable {
* <p>
* To be used by classes extending ToStringBean only.
* <p>
*
*
* @param beanClass indicates the class to scan for properties, normally an interface class.
*
*
*/
protected ToStringBean(final Class<?> beanClass) {
this.beanClass = beanClass;
@ -96,10 +96,10 @@ public class ToStringBean implements Serializable {
* }
* </code>
* <p>
*
*
* @param beanClass indicates the class to scan for properties, normally an interface class.
* @param obj object bean to create String representation.
*
*
*/
public ToStringBean(final Class<?> beanClass, final Object obj) {
this.beanClass = beanClass;
@ -111,9 +111,9 @@ public class ToStringBean implements Serializable {
* <p>
* It uses the Class name as the prefix.
* <p>
*
*
* @return bean object String representation.
*
*
*/
@Override
public String toString() {
@ -138,10 +138,10 @@ public class ToStringBean implements Serializable {
/**
* Returns the String representation of the bean given in the constructor.
* <p>
*
*
* @param prefix to use for bean properties.
* @return bean object String representation.
*
*
*/
private String toString(final String prefix) {

216
src/main/java/com/sun/syndication/feed/module/DCModule.java
View file

@ -22,35 +22,35 @@ import java.util.List;
/**
* Dublin Core Module.
* <p>
*
*
* @see <a href="http://web.resource.org/rss/1.0/modules/dc/">Dublin Core module</a>.
* @author Alejandro Abdelnur
*
*
*/
public interface DCModule extends Module {
/**
* URI of the Dublin Core Module (http://purl.org/dc/elements/1.1/).
*
*
*/
String URI = "http://purl.org/dc/elements/1.1/";
/**
* Returns the DublinCore module titles.
* <p>
*
*
* @return a list of Strings representing the DublinCore module title, an empty list if none.
*
*
*/
List<String> getTitles();
/**
* Sets the DublinCore module titles.
* <p>
*
*
* @param titles the list of String representing the DublinCore module titles to set, an empty
* list or <b>null</b> if none.
*
*
*/
void setTitles(List<String> titles);
@ -58,7 +58,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module title. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module title, <b>null</b> if none.
*/
String getTitle();
@ -67,28 +67,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module title. Convenience method that can be used when there is only one
* title to set.
* <p>
*
*
* @param title the DublinCore module title to set, <b>null</b> if none.
*
*
*/
void setTitle(String title);
/**
* Returns the DublinCore module creator.
* <p>
*
*
* @return a list of Strings representing the DublinCore module creator, an empty list if none.
*
*
*/
List<String> getCreators();
/**
* Sets the DublinCore module creators.
* <p>
*
*
* @param creators the list of String representing the DublinCore module creators to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setCreators(List<String> creators);
@ -96,7 +96,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module creator. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module creator, <b>null</b> if none.
*/
String getCreator();
@ -105,29 +105,29 @@ public interface DCModule extends Module {
* Sets the DublinCore module creator. Convenience method that can be used when there is only
* one creator to set.
* <p>
*
*
* @param creator the DublinCore module creator to set, <b>null</b> if none.
*
*
*/
void setCreator(String creator);
/**
* Returns the DublinCore module subjects.
* <p>
*
*
* @return a list of DCSubject elements with the DublinCore module subjects, an empty list if
* none.
*
*
*/
List<DCSubject> getSubjects();
/**
* Sets the DublinCore module subjects.
* <p>
*
*
* @param subjects the list of DCSubject elements with the DublinCore module subjects to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setSubjects(List<DCSubject> subjects);
@ -135,7 +135,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module subject. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module subject, <b>null</b> if none.
*/
DCSubject getSubject();
@ -144,29 +144,29 @@ public interface DCModule extends Module {
* Sets the DCSubject element. Convenience method that can be used when there is only one
* subject to set.
* <p>
*
*
* @param subject the DublinCore module subject to set, <b>null</b> if none.
*
*
*/
void setSubject(DCSubject subject);
/**
* Returns the DublinCore module description.
* <p>
*
*
* @return a list of Strings representing the DublinCore module description, an empty list if
* none.
*
*
*/
List<String> getDescriptions();
/**
* Sets the DublinCore module descriptions.
* <p>
*
*
* @param descriptions the list of String representing the DublinCore module descriptions to
* set, an empty list or <b>null</b> if none.
*
*
*/
void setDescriptions(List<String> descriptions);
@ -174,7 +174,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module description. Convenience method that can be used to obtain the
* first item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module description, <b>null</b> if none.
*/
String getDescription();
@ -183,29 +183,29 @@ public interface DCModule extends Module {
* Sets the DublinCore module description. Convenience method that can be used when there is
* only one description to set.
* <p>
*
*
* @param description the DublinCore module description to set, <b>null</b> if none.
*
*
*/
void setDescription(String description);
/**
* Returns the DublinCore module publisher.
* <p>
*
*
* @return a list of Strings representing the DublinCore module publisher, an empty list if
* none.
*
*
*/
List<String> getPublishers();
/**
* Sets the DublinCore module publishers.
* <p>
*
*
* @param publishers the list of String representing the DublinCore module publishers to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setPublishers(List<String> publishers);
@ -213,7 +213,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module publisher. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module publisher, <b>null</b> if none.
*/
String getPublisher();
@ -222,29 +222,29 @@ public interface DCModule extends Module {
* Sets the DublinCore module publisher. Convenience method that can be used when there is only
* one publisher to set.
* <p>
*
*
* @param publisher the DublinCore module publisher to set, <b>null</b> if none.
*
*
*/
void setPublisher(String publisher);
/**
* Returns the DublinCore module contributor.
* <p>
*
*
* @return a list of Strings representing the DublinCore module contributor, an empty list if
* none.
*
*
*/
List<String> getContributors();
/**
* Sets the DublinCore module contributors.
* <p>
*
*
* @param contributors the list of String representing the DublinCore module contributors to
* set, an empty list or <b>null</b> if none.
*
*
*/
void setContributors(List<String> contributors);
@ -252,7 +252,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module contributor. Convenience method that can be used to obtain the
* first item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module contributor, <b>null</b> if none.
*/
String getContributor();
@ -261,28 +261,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module contributor. Convenience method that can be used when there is
* only one contributor to set.
* <p>
*
*
* @param contributor the DublinCore module contributor to set, <b>null</b> if none.
*
*
*/
void setContributor(String contributor);
/**
* Returns the DublinCore module date.
* <p>
*
*
* @return a list of Strings representing the DublinCore module date, an empty list if none.
*
*
*/
List<Date> getDates();
/**
* Sets the DublinCore module dates.
* <p>
*
*
* @param dates the list of Date representing the DublinCore module dates to set, an empty list
* or <b>null</b> if none.
*
*
*/
void setDates(List<Date> dates);
@ -290,7 +290,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module date. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module date, <b>null</b> if none.
*/
Date getDate();
@ -299,28 +299,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module date. Convenience method that can be used when there is only one
* date to set.
* <p>
*
*
* @param date the DublinCore module date to set, <b>null</b> if none.
*
*
*/
void setDate(Date date);
/**
* Returns the DublinCore module type.
* <p>
*
*
* @return a list of Strings representing the DublinCore module type, an empty list if none.
*
*
*/
List<String> getTypes();
/**
* Sets the DublinCore module types.
* <p>
*
*
* @param types the list of String representing the DublinCore module types to set, an empty
* list or <b>null</b> if none.
*
*
*/
void setTypes(List<String> types);
@ -328,7 +328,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module type. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module type, <b>null</b> if none.
*/
String getType();
@ -337,28 +337,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module type. Convenience method that can be used when there is only one
* type to set.
* <p>
*
*
* @param type the DublinCore module type to set, <b>null</b> if none.
*
*
*/
void setType(String type);
/**
* Returns the DublinCore module format.
* <p>
*
*
* @return a list of Strings representing the DublinCore module format, an empty list if none.
*
*
*/
List<String> getFormats();
/**
* Sets the DublinCore module formats.
* <p>
*
*
* @param formats the list of String representing the DublinCore module formats to set, an empty
* list or <b>null</b> if none.
*
*
*/
void setFormats(List<String> formats);
@ -366,7 +366,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module format. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module format, <b>null</b> if none.
*/
String getFormat();
@ -375,29 +375,29 @@ public interface DCModule extends Module {
* Sets the DublinCore module format. Convenience method that can be used when there is only one
* format to set.
* <p>
*
*
* @param format the DublinCore module format to set, <b>null</b> if none.
*
*
*/
void setFormat(String format);
/**
* Returns the DublinCore module identifier.
* <p>
*
*
* @return a list of Strings representing the DublinCore module identifier, an empty list if
* none.
*
*
*/
List<String> getIdentifiers();
/**
* Sets the DublinCore module identifiers.
* <p>
*
*
* @param identifiers the list of String representing the DublinCore module identifiers to set,
* an empty list or <b>null</b> if none.
*
*
*/
void setIdentifiers(List<String> identifiers);
@ -405,7 +405,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module identifier. Convenience method that can be used to obtain the
* first item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module identifier, <b>null</b> if none.
*/
String getIdentifier();
@ -414,28 +414,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module identifier. Convenience method that can be used when there is only
* one identifier to set.
* <p>
*
*
* @param identifier the DublinCore module identifier to set, <b>null</b> if none.
*
*
*/
void setIdentifier(String identifier);
/**
* Returns the DublinCore module source.
* <p>
*
*
* @return a list of Strings representing the DublinCore module source, an empty list if none.
*
*
*/
List<String> getSources();
/**
* Sets the DublinCore module sources.
* <p>
*
*
* @param sources the list of String representing the DublinCore module sources to set, an empty
* list or <b>null</b> if none.
*
*
*/
void setSources(List<String> sources);
@ -443,7 +443,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module subject. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module creator, <b>null</b> if none.
*/
String getSource();
@ -452,28 +452,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module source. Convenience method that can be used when there is only one
* source to set.
* <p>
*
*
* @param source the DublinCore module source to set, <b>null</b> if none.
*
*
*/
void setSource(String source);
/**
* Returns the DublinCore module language.
* <p>
*
*
* @return a list of Strings representing the DublinCore module language, an empty list if none.
*
*
*/
List<String> getLanguages();
/**
* Sets the DublinCore module languages.
* <p>
*
*
* @param languages the list of String representing the DublinCore module languages to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setLanguages(List<String> languages);
@ -481,7 +481,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module language. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module language, <b>null</b> if none.
*/
String getLanguage();
@ -490,28 +490,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module language. Convenience method that can be used when there is only
* one language to set.
* <p>
*
*
* @param language the DublinCore module language to set, <b>null</b> if none.
*
*
*/
void setLanguage(String language);
/**
* Returns the DublinCore module relation.
* <p>
*
*
* @return a list of Strings representing the DublinCore module relation, an empty list if none.
*
*
*/
List<String> getRelations();
/**
* Sets the DublinCore module relations.
* <p>
*
*
* @param relations the list of String representing the DublinCore module relations to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setRelations(List<String> relations);
@ -519,7 +519,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module relation. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module relation, <b>null</b> if none.
*/
String getRelation();
@ -528,28 +528,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module relation. Convenience method that can be used when there is only
* one relation to set.
* <p>
*
*
* @param relation the DublinCore module relation to set, <b>null</b> if none.
*
*
*/
void setRelation(String relation);
/**
* Returns the DublinCore module coverage.
* <p>
*
*
* @return a list of Strings representing the DublinCore module coverage, an empty list if none.
*
*
*/
List<String> getCoverages();
/**
* Sets the DublinCore module coverages.
* <p>
*
*
* @param coverages the list of String representing the DublinCore module coverages to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setCoverages(List<String> coverages);
@ -557,7 +557,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module coverage. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module coverage, <b>null</b> if none.
*/
String getCoverage();
@ -566,28 +566,28 @@ public interface DCModule extends Module {
* Sets the DublinCore module coverage. Convenience method that can be used when there is only
* one coverage to set.
* <p>
*
*
* @param coverage the DublinCore module coverage to set, <b>null</b> if none.
*
*
*/
void setCoverage(String coverage);
/**
* Returns the DublinCore module rights.
* <p>
*
*
* @return a list of Strings representing the DublinCore module rights, an empty list if none.
*
*
*/
List<String> getRightsList();
/**
* Sets the DublinCore module rightss.
* <p>
*
*
* @param rights the list of String representing the DublinCore module rights to set, an empty
* list or <b>null</b> if none.
*
*
*/
void setRightsList(List<String> rights);
@ -595,7 +595,7 @@ public interface DCModule extends Module {
* Gets the DublinCore module right. Convenience method that can be used to obtain the first
* item, <b>null</b> if none.
* <p>
*
*
* @return the first DublinCore module right, <b>null</b> if none.
*/
String getRights();
@ -604,9 +604,9 @@ public interface DCModule extends Module {
* Sets the DublinCore module rights. Convenience method that can be used when there is only one
* rights to set.
* <p>
*
*
* @param rights the DublinCore module rights to set, <b>null</b> if none.
*
*
*/
void setRights(String rights);
}

24
src/main/java/com/sun/syndication/feed/module/DCSubject.java
View file

@ -21,55 +21,55 @@ import com.sun.syndication.feed.CopyFrom;
/**
* Subject of the Dublin Core ModuleImpl.
* <p>
*
*
* @see <a href="http://web.resource.org/rss/1.0/modules/dc/">Dublin Core module</a>.
* @author Alejandro Abdelnur
*
*
*/
public interface DCSubject extends Cloneable, CopyFrom {
/**
* Returns the DublinCore subject taxonomy URI.
* <p>
*
*
* @return the DublinCore subject taxonomy URI, <b>null</b> if none.
*
*
*/
String getTaxonomyUri();
/**
* Sets the DublinCore subject taxonomy URI.
* <p>
*
*
* @param taxonomyUri the DublinCore subject taxonomy URI to set, <b>null</b> if none.
*
*
*/
void setTaxonomyUri(String taxonomyUri);
/**
* Returns the DublinCore subject value.
* <p>
*
*
* @return the DublinCore subject value, <b>null</b> if none.
*
*
*/
String getValue();
/**
* Sets the DublinCore subject value.
* <p>
*
*
* @param value the DublinCore subject value to set, <b>null</b> if none.
*
*
*/
void setValue(String value);
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;

12
src/main/java/com/sun/syndication/feed/module/Extendable.java
View file

@ -21,7 +21,7 @@ import java.util.List;
/**
* Objects that can have modules are Extendable.
*
*
* @author Dave Johnson
*/
public interface Extendable {
@ -29,7 +29,7 @@ public interface Extendable {
/**
* Returns the module identified by a given URI.
* <p>
*
*
* @param uri the URI of the ModuleImpl.
* @return The module with the given URI, <b>null</b> if none.
*/
@ -38,19 +38,19 @@ public interface Extendable {
/**
* Returns the entry modules.
* <p>
*
*
* @return a list of ModuleImpl elements with the entry modules, an empty list if none.
*
*
*/
List<Module> getModules();
/**
* Sets the entry modules.
* <p>
*
*
* @param modules the list of ModuleImpl elements with the entry modules to set, an empty list
* or <b>null</b> if none.
*
*
*/
void setModules(List<Module> modules);
}

12
src/main/java/com/sun/syndication/feed/module/Module.java
View file

@ -24,28 +24,28 @@ import com.sun.syndication.feed.CopyFrom;
* Base class for modules describing Metadata of feeds. Examples of such modules are the Dublin Core
* and Syndication modules.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface Module extends Cloneable, CopyFrom, Serializable {
/**
* Returns the URI of the module.
* <p>
*
*
* @return URI of the module.
*
*
*/
String getUri();
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;

28
src/main/java/com/sun/syndication/feed/module/ModuleImpl.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
* Base class for modules describing Metadata of feeds, default implementations. Examples of such
* modules are the Dublin Core and Syndication modules.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public abstract class ModuleImpl implements Cloneable, Serializable, Module {
private static final long serialVersionUID = 1L;
@ -36,9 +36,9 @@ public abstract class ModuleImpl implements Cloneable, Serializable, Module {
/**
* Constructor.
* <p>
*
*
* @param uri URI of the module.
*
*
*/
protected ModuleImpl(final Class<?> beanClass, final String uri) {
objBean = new ObjectBean(beanClass, this);
@ -48,10 +48,10 @@ public abstract class ModuleImpl implements Cloneable, Serializable, Module {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -62,10 +62,10 @@ public abstract class ModuleImpl implements Cloneable, Serializable, Module {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -80,9 +80,9 @@ public abstract class ModuleImpl implements Cloneable, Serializable, Module {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -92,9 +92,9 @@ public abstract class ModuleImpl implements Cloneable, Serializable, Module {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -104,9 +104,9 @@ public abstract class ModuleImpl implements Cloneable, Serializable, Module {
/**
* Returns the URI of the module.
* <p>
*
*
* @return URI of the module.
*
*
*/
@Override
public String getUri() {

30
src/main/java/com/sun/syndication/feed/module/SyModule.java
View file

@ -21,16 +21,16 @@ import java.util.Date;
/**
* Syndication ModuleImpl.
* <p>
*
*
* @see <a href="http://web.resource.org/rss/1.0/modules/syndication/">Syndication module</a>.
* @author Alejandro Abdelnur
*
*
*/
public interface SyModule extends Module {
/**
* URI of the Syndication ModuleImpl (http://purl.org/rss/1.0/modules/syndication/).
*
*
*/
static final String URI = "http://purl.org/rss/1.0/modules/syndication/";
@ -43,54 +43,54 @@ public interface SyModule extends Module {
/**
* Returns the Syndication module update period.
* <p>
*
*
* @return the Syndication module update period, <b>null</b> if none.
*
*
*/
String getUpdatePeriod();
/**
* Sets the Syndication module update period.
* <p>
*
*
* @param updatePeriod the Syndication module update period to set, <b>null</b> if none.
*
*
*/
void setUpdatePeriod(String updatePeriod);
/**
* Returns the Syndication module update frequency.
* <p>
*
*
* @return the Syndication module update frequency, <b>null</b> if none.
*
*
*/
int getUpdateFrequency();
/**
* Sets the Syndication module update frequency.
* <p>
*
*
* @param updateFrequency the Syndication module update frequency to set, <b>null</b> if none.
*
*
*/
void setUpdateFrequency(int updateFrequency);
/**
* Returns the Syndication module update base date.
* <p>
*
*
* @return the Syndication module update base date, <b>null</b> if none.
*
*
*/
Date getUpdateBase();
/**
* Sets the Syndication module update base date.
* <p>
*
*
* @param updateBase the Syndication module update base date to set, <b>null</b> if none.
*
*
*/
void setUpdateBase(Date updateBase);

6
src/main/java/com/sun/syndication/feed/module/impl/ModuleUtils.java
View file

@ -49,10 +49,10 @@ public class ModuleUtils {
}
/**
*
*
*
*
* @since 1.5 Changed to return the first, not the last.
*
*
* @param modules
* @param uri
* @return

38
src/main/java/com/sun/syndication/feed/rss/Category.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for categories of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Category implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -37,7 +37,7 @@ public class Category implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Category() {
objBean = new ObjectBean(this.getClass(), this);
@ -46,10 +46,10 @@ public class Category implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -60,10 +60,10 @@ public class Category implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -78,9 +78,9 @@ public class Category implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -90,9 +90,9 @@ public class Category implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -102,9 +102,9 @@ public class Category implements Cloneable, Serializable {
/**
* Returns the category domain.
* <p>
*
*
* @return the category domain, <b>null</b> if none.
*
*
*/
public String getDomain() {
return domain;
@ -113,9 +113,9 @@ public class Category implements Cloneable, Serializable {
/**
* Sets the category domain.
* <p>
*
*
* @param domain the category domain to set, <b>null</b> if none.
*
*
*/
public void setDomain(final String domain) {
this.domain = domain;
@ -124,9 +124,9 @@ public class Category implements Cloneable, Serializable {
/**
* Returns the category value.
* <p>
*
*
* @return the category value, <b>null</b> if none.
*
*
*/
public String getValue() {
return value;
@ -135,9 +135,9 @@ public class Category implements Cloneable, Serializable {
/**
* Sets the category value.
* <p>
*
*
* @param value the category value to set, <b>null</b> if none.
*
*
*/
public void setValue(final String value) {
this.value = value;

62
src/main/java/com/sun/syndication/feed/rss/Cloud.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for clouds of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Cloud implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -40,7 +40,7 @@ public class Cloud implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Cloud() {
objBean = new ObjectBean(this.getClass(), this);
@ -49,10 +49,10 @@ public class Cloud implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -63,10 +63,10 @@ public class Cloud implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -78,9 +78,9 @@ public class Cloud implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -90,9 +90,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -102,9 +102,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Returns the cloud domain.
* <p>
*
*
* @return the cloud domain, <b>null</b> if none.
*
*
*/
public String getDomain() {
return domain;
@ -113,9 +113,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Sets the cloud domain.
* <p>
*
*
* @param domain the cloud domain to set, <b>null</b> if none.
*
*
*/
public void setDomain(final String domain) {
this.domain = domain;
@ -124,9 +124,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Returns the cloud port.
* <p>
*
*
* @return the cloud port, <b>null</b> if none.
*
*
*/
public int getPort() {
return port;
@ -135,9 +135,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Sets the cloud port.
* <p>
*
*
* @param port the cloud port to set, <b>null</b> if none.
*
*
*/
public void setPort(final int port) {
this.port = port;
@ -146,9 +146,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Returns the cloud path.
* <p>
*
*
* @return the cloud path, <b>null</b> if none.
*
*
*/
public String getPath() {
return path;
@ -157,9 +157,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Sets the cloud path.
* <p>
*
*
* @param path the cloud path to set, <b>null</b> if none.
*
*
*/
public void setPath(final String path) {
this.path = path;
@ -168,9 +168,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Returns the cloud register procedure.
* <p>
*
*
* @return the cloud register procedure, <b>null</b> if none.
*
*
*/
public String getRegisterProcedure() {
return registerProcedure;
@ -179,9 +179,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Sets the cloud register procedure.
* <p>
*
*
* @param registerProcedure the cloud register procedure to set, <b>null</b> if none.
*
*
*/
public void setRegisterProcedure(final String registerProcedure) {
this.registerProcedure = registerProcedure;
@ -190,9 +190,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Returns the cloud protocol.
* <p>
*
*
* @return the cloud protocol, <b>null</b> if none.
*
*
*/
public String getProtocol() {
return protocol;
@ -201,9 +201,9 @@ public class Cloud implements Cloneable, Serializable {
/**
* Sets the cloud protocol.
* <p>
*
*
* @param protocol the cloud protocol to set, <b>null</b> if none.
*
*
*/
public void setProtocol(final String protocol) {
this.protocol = protocol;

38
src/main/java/com/sun/syndication/feed/rss/Content.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for item descriptions of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Content implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -39,7 +39,7 @@ public class Content implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Content() {
objBean = new ObjectBean(this.getClass(), this);
@ -48,9 +48,9 @@ public class Content implements Cloneable, Serializable {
/**
* Sets the description type.
* <p>
*
*
* @param type the description type to set, <b>null</b> if none.
*
*
*/
public void setType(final String type) {
this.type = type;
@ -59,9 +59,9 @@ public class Content implements Cloneable, Serializable {
/**
* Returns the description type.
* <p>
*
*
* @return the description type, <b>null</b> if none.
*
*
*/
public String getType() {
return type;
@ -70,9 +70,9 @@ public class Content implements Cloneable, Serializable {
/**
* Sets the description value.
* <p>
*
*
* @param value the description value to set, <b>null</b> if none.
*
*
*/
public void setValue(final String value) {
this.value = value;
@ -81,9 +81,9 @@ public class Content implements Cloneable, Serializable {
/**
* Returns the description value.
* <p>
*
*
* @return the description value, <b>null</b> if none.
*
*
*/
public String getValue() {
return value;
@ -92,10 +92,10 @@ public class Content implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -106,10 +106,10 @@ public class Content implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -125,9 +125,9 @@ public class Content implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -137,9 +137,9 @@ public class Content implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {

38
src/main/java/com/sun/syndication/feed/rss/Description.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for item descriptions of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Description implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -37,7 +37,7 @@ public class Description implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Description() {
objBean = new ObjectBean(this.getClass(), this);
@ -46,10 +46,10 @@ public class Description implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -60,10 +60,10 @@ public class Description implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -78,9 +78,9 @@ public class Description implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -90,9 +90,9 @@ public class Description implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -102,9 +102,9 @@ public class Description implements Cloneable, Serializable {
/**
* Returns the description type.
* <p>
*
*
* @return the description type, <b>null</b> if none.
*
*
*/
public String getType() {
return type;
@ -113,9 +113,9 @@ public class Description implements Cloneable, Serializable {
/**
* Sets the description type.
* <p>
*
*
* @param type the description type to set, <b>null</b> if none.
*
*
*/
public void setType(final String type) {
this.type = type;
@ -124,9 +124,9 @@ public class Description implements Cloneable, Serializable {
/**
* Returns the description value.
* <p>
*
*
* @return the description value, <b>null</b> if none.
*
*
*/
public String getValue() {
return value;
@ -135,9 +135,9 @@ public class Description implements Cloneable, Serializable {
/**
* Sets the description value.
* <p>
*
*
* @param value the description value to set, <b>null</b> if none.
*
*
*/
public void setValue(final String value) {
this.value = value;

46
src/main/java/com/sun/syndication/feed/rss/Enclosure.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for item enclosures of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Enclosure implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -38,7 +38,7 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Enclosure() {
objBean = new ObjectBean(this.getClass(), this);
@ -47,10 +47,10 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -61,10 +61,10 @@ public class Enclosure implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -79,9 +79,9 @@ public class Enclosure implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -91,9 +91,9 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -103,9 +103,9 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Returns the enclosure URL.
* <p>
*
*
* @return the enclosure URL, <b>null</b> if none.
*
*
*/
public String getUrl() {
return url;
@ -114,9 +114,9 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Sets the enclosure URL.
* <p>
*
*
* @param url the enclosure URL to set, <b>null</b> if none.
*
*
*/
public void setUrl(final String url) {
this.url = url;
@ -125,9 +125,9 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Returns the enclosure length.
* <p>
*
*
* @return the enclosure length, <b>0</b> if none.
*
*
*/
public long getLength() {
return length;
@ -136,9 +136,9 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Sets the enclosure length.
* <p>
*
*
* @param length the enclosure length to set, <b>0</b> if none.
*
*
*/
public void setLength(final long length) {
this.length = length;
@ -147,9 +147,9 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Returns the enclosure type.
* <p>
*
*
* @return the enclosure type, <b>null</b> if none.
*
*
*/
public String getType() {
return type;
@ -158,9 +158,9 @@ public class Enclosure implements Cloneable, Serializable {
/**
* Sets the enclosure type.
* <p>
*
*
* @param type the enclosure type to set, <b>null</b> if none.
*
*
*/
public void setType(final String type) {
this.type = type;

38
src/main/java/com/sun/syndication/feed/rss/Guid.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for item GUIDs of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Guid implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -37,7 +37,7 @@ public class Guid implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Guid() {
objBean = new ObjectBean(this.getClass(), this);
@ -46,10 +46,10 @@ public class Guid implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -60,10 +60,10 @@ public class Guid implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -78,9 +78,9 @@ public class Guid implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -90,9 +90,9 @@ public class Guid implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -102,9 +102,9 @@ public class Guid implements Cloneable, Serializable {
/**
* Returns the guid perma link.
* <p>
*
*
* @return the guid perma link, <b>null</b> if none.
*
*
*/
public boolean isPermaLink() {
return permaLink;
@ -113,9 +113,9 @@ public class Guid implements Cloneable, Serializable {
/**
* Sets the guid perma link.
* <p>
*
*
* @param permaLink the guid perma link to set, <b>null</b> if none.
*
*
*/
public void setPermaLink(final boolean permaLink) {
this.permaLink = permaLink;
@ -124,9 +124,9 @@ public class Guid implements Cloneable, Serializable {
/**
* Returns the guid value.
* <p>
*
*
* @return the guid value, <b>null</b> if none.
*
*
*/
public String getValue() {
return value;
@ -135,9 +135,9 @@ public class Guid implements Cloneable, Serializable {
/**
* Sets the guid value.
* <p>
*
*
* @param value the guid value to set, <b>null</b> if none.
*
*
*/
public void setValue(final String value) {
this.value = value;

70
src/main/java/com/sun/syndication/feed/rss/Image.java
View file

@ -23,9 +23,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for images of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Image implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -40,7 +40,7 @@ public class Image implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Image() {
objBean = new ObjectBean(this.getClass(), this);
@ -49,10 +49,10 @@ public class Image implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -63,10 +63,10 @@ public class Image implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -81,9 +81,9 @@ public class Image implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -93,9 +93,9 @@ public class Image implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -105,9 +105,9 @@ public class Image implements Cloneable, Serializable {
/**
* Returns the image title.
* <p>
*
*
* @return the image title, <b>null</b> if none.
*
*
*/
public String getTitle() {
return title;
@ -116,9 +116,9 @@ public class Image implements Cloneable, Serializable {
/**
* Sets the image title.
* <p>
*
*
* @param title the image title to set, <b>null</b> if none.
*
*
*/
public void setTitle(final String title) {
this.title = title;
@ -127,9 +127,9 @@ public class Image implements Cloneable, Serializable {
/**
* Returns the image URL.
* <p>
*
*
* @return the image URL, <b>null</b> if none.
*
*
*/
public String getUrl() {
return url;
@ -138,9 +138,9 @@ public class Image implements Cloneable, Serializable {
/**
* Sets the image URL.
* <p>
*
*
* @param url the image URL to set, <b>null</b> if none.
*
*
*/
public void setUrl(final String url) {
this.url = url;
@ -149,9 +149,9 @@ public class Image implements Cloneable, Serializable {
/**
* Returns the image link.
* <p>
*
*
* @return the image link, <b>null</b> if none.
*
*
*/
public String getLink() {
return link;
@ -160,9 +160,9 @@ public class Image implements Cloneable, Serializable {
/**
* Sets the image link.
* <p>
*
*
* @param link the image link to set, <b>null</b> if none.
*
*
*/
public void setLink(final String link) {
this.link = link;
@ -171,9 +171,9 @@ public class Image implements Cloneable, Serializable {
/**
* Returns the image width.
* <p>
*
*
* @return the image width, <b>null</b> if none.
*
*
*/
public Integer getWidth() {
return width;
@ -182,9 +182,9 @@ public class Image implements Cloneable, Serializable {
/**
* Sets the image width.
* <p>
*
*
* @param width the image width to set, <b>null</b> if none.
*
*
*/
public void setWidth(final Integer width) {
this.width = width;
@ -193,9 +193,9 @@ public class Image implements Cloneable, Serializable {
/**
* Returns the image height.
* <p>
*
*
* @return the image height, <b>null</b> if none.
*
*
*/
public Integer getHeight() {
return height;
@ -204,9 +204,9 @@ public class Image implements Cloneable, Serializable {
/**
* Sets the image height.
* <p>
*
*
* @param height the image height to set, <b>null</b> if none.
*
*
*/
public void setHeight(final Integer height) {
this.height = height;
@ -215,9 +215,9 @@ public class Image implements Cloneable, Serializable {
/**
* Returns the image description.
* <p>
*
*
* @return the image description, <b>null</b> if none.
*
*
*/
public String getDescription() {
return description;
@ -226,9 +226,9 @@ public class Image implements Cloneable, Serializable {
/**
* Sets the image description.
* <p>
*
*
* @param description the image description to set, <b>null</b> if none.
*
*
*/
public void setDescription(final String description) {
this.description = description;

38
src/main/java/com/sun/syndication/feed/rss/Source.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for item sources of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Source implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -37,7 +37,7 @@ public class Source implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public Source() {
objBean = new ObjectBean(this.getClass(), this);
@ -46,10 +46,10 @@ public class Source implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -60,10 +60,10 @@ public class Source implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -78,9 +78,9 @@ public class Source implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -90,9 +90,9 @@ public class Source implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -102,9 +102,9 @@ public class Source implements Cloneable, Serializable {
/**
* Returns the source URL.
* <p>
*
*
* @return the source URL, <b>null</b> if none.
*
*
*/
public String getUrl() {
return url;
@ -113,9 +113,9 @@ public class Source implements Cloneable, Serializable {
/**
* Sets the source URL.
* <p>
*
*
* @param url the source URL to set, <b>null</b> if none.
*
*
*/
public void setUrl(final String url) {
this.url = url;
@ -124,9 +124,9 @@ public class Source implements Cloneable, Serializable {
/**
* Returns the source value.
* <p>
*
*
* @return the source value, <b>null</b> if none.
*
*
*/
public String getValue() {
return value;
@ -135,9 +135,9 @@ public class Source implements Cloneable, Serializable {
/**
* Sets the source value.
* <p>
*
*
* @param value the source value to set, <b>null</b> if none.
*
*
*/
public void setValue(final String value) {
this.value = value;

54
src/main/java/com/sun/syndication/feed/rss/TextInput.java
View file

@ -24,9 +24,9 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Bean for text input of RSS feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TextInput implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -39,7 +39,7 @@ public class TextInput implements Cloneable, Serializable {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public TextInput() {
objBean = new ObjectBean(this.getClass(), this);
@ -48,10 +48,10 @@ public class TextInput implements Cloneable, Serializable {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -62,10 +62,10 @@ public class TextInput implements Cloneable, Serializable {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -80,9 +80,9 @@ public class TextInput implements Cloneable, Serializable {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -92,9 +92,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -104,9 +104,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Returns the text input title.
* <p>
*
*
* @return the text input title, <b>null</b> if none.
*
*
*/
public String getTitle() {
return title;
@ -115,9 +115,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Sets the text input title.
* <p>
*
*
* @param title the text input title to set, <b>null</b> if none.
*
*
*/
public void setTitle(final String title) {
this.title = title;
@ -126,9 +126,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Returns the text input description.
* <p>
*
*
* @return the text input description, <b>null</b> if none.
*
*
*/
public String getDescription() {
return description;
@ -137,9 +137,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Sets the text input description.
* <p>
*
*
* @param description the text input description to set, <b>null</b> if none.
*
*
*/
public void setDescription(final String description) {
this.description = description;
@ -148,9 +148,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Returns the text input name.
* <p>
*
*
* @return the text input name, <b>null</b> if none.
*
*
*/
public String getName() {
return name;
@ -159,9 +159,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Sets the text input name.
* <p>
*
*
* @param name the text input name to set, <b>null</b> if none.
*
*
*/
public void setName(final String name) {
this.name = name;
@ -170,9 +170,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Returns the text input link.
* <p>
*
*
* @return the text input link, <b>null</b> if none.
*
*
*/
public String getLink() {
return link;
@ -181,9 +181,9 @@ public class TextInput implements Cloneable, Serializable {
/**
* Sets the text input link.
* <p>
*
*
* @param link the text input link to set, <b>null</b> if none.
*
*
*/
public void setLink(final String link) {
this.link = link;

16
src/main/java/com/sun/syndication/feed/synd/Converter.java
View file

@ -28,20 +28,20 @@ import com.sun.syndication.feed.WireFeed;
* <p>
* TODO: explain how developers can plugin their own implementations.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface Converter {
/**
* Returns the type (version) of the real feed this converter handles.
* <p>
*
*
* @see WireFeed for details on the format of this string.
* <p>
* @return the real feed type.
*
*
*/
public String getType();
@ -50,21 +50,21 @@ public interface Converter {
* <p>
* It assumes the given SyndFeedImpl has no properties set.
* <p>
*
*
* @param feed real feed to copy/convert.
* @param syndFeed the SyndFeedImpl that will contain the copied/converted values of the real
* feed.
*
*
*/
public void copyInto(WireFeed feed, SyndFeed syndFeed);
/**
* Creates real feed with a deep copy/conversion of the values of a SyndFeedImpl.
* <p>
*
*
* @param syndFeed SyndFeedImpl to copy/convert value from.
* @return a real feed with copied/converted values of the SyndFeedImpl.
*
*
*/
public WireFeed createRealFeed(SyndFeed syndFeed);

24
src/main/java/com/sun/syndication/feed/synd/SyndCategory.java
View file

@ -22,54 +22,54 @@ import com.sun.syndication.feed.CopyFrom;
/**
* Bean interface for categories of SyndFeedImpl feeds and entries.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface SyndCategory extends Cloneable, CopyFrom {
/**
* Returns the category name.
* <p>
*
*
* @return the category name, <b>null</b> if none.
*
*
*/
String getName();
/**
* Sets the category name.
* <p>
*
*
* @param name the category name to set, <b>null</b> if none.
*
*
*/
void setName(String name);
/**
* Returns the category taxonomy URI.
* <p>
*
*
* @return the category taxonomy URI, <b>null</b> if none.
*
*
*/
String getTaxonomyUri();
/**
* Sets the category taxonomy URI.
* <p>
*
*
* @param taxonomyUri the category taxonomy URI to set, <b>null</b> if none.
*
*
*/
void setTaxonomyUri(String taxonomyUri);
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;

32
src/main/java/com/sun/syndication/feed/synd/SyndContent.java
View file

@ -21,9 +21,9 @@ import com.sun.syndication.feed.CopyFrom;
/**
* Bean interface for content of SyndFeedImpl entries.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface SyndContent extends Cloneable, CopyFrom {
/**
@ -31,9 +31,9 @@ public interface SyndContent extends Cloneable, CopyFrom {
* <p>
* When used for the description of an entry, if <b>null</b> 'text/plain' must be assumed.
* <p>
*
*
* @return the content type, <b>null</b> if none.
*
*
*/
String getType();
@ -42,53 +42,53 @@ public interface SyndContent extends Cloneable, CopyFrom {
* <p>
* When used for the description of an entry, if <b>null</b> 'text/plain' must be assumed.
* <p>
*
*
* @param type the content type to set, <b>null</b> if none.
*
*
*/
void setType(String type);
/**
* Gets the content mode (needed for Atom 0.3 support).
*
*
* @return type the content, <b>null</b> if none.
*
*
*/
String getMode();
/**
* Sets the content mode (needed for Atom 0.3 support).
*
*
* @param mode the content mode to set, <b>null</b> if none.
*
*
*/
void setMode(String mode);
/**
* Returns the content value.
* <p>
*
*
* @return the content value, <b>null</b> if none.
*
*
*/
String getValue();
/**
* Sets the content value.
* <p>
*
*
* @param value the content value to set, <b>null</b> if none.
*
*
*/
void setValue(String value);
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;

24
src/main/java/com/sun/syndication/feed/synd/SyndEnclosure.java
View file

@ -9,54 +9,54 @@ public interface SyndEnclosure extends Cloneable, CopyFrom {
/**
* Returns the enclosure URL.
* <p>
*
*
* @return the enclosure URL, <b>null</b> if none.
*
*
*/
public String getUrl();
/**
* Sets the enclosure URL.
* <p>
*
*
* @param url the enclosure URL to set, <b>null</b> if none.
*
*
*/
public void setUrl(String url);
/**
* Returns the enclosure length.
* <p>
*
*
* @return the enclosure length, <b>0</b> if none.
*
*
*/
public long getLength();
/**
* Sets the enclosure length.
* <p>
*
*
* @param length the enclosure length to set, <b>0</b> if none.
*
*
*/
public void setLength(long length);
/**
* Returns the enclosure type.
* <p>
*
*
* @return the enclosure type, <b>null</b> if none.
*
*
*/
public String getType();
/**
* Sets the enclosure type.
* <p>
*
*
* @param type the enclosure type to set, <b>null</b> if none.
*
*
*/
public void setType(String type);

154
src/main/java/com/sun/syndication/feed/synd/SyndEntry.java
View file

@ -28,9 +28,9 @@ import com.sun.syndication.feed.module.Module;
/**
* Bean interface for entries of SyndFeedImpl feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
@ -44,9 +44,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* The returned URI is a normalized URI as specified in RFC 2396bis.
* <p>
*
*
* @return the entry URI, <b>null</b> if none.
*
*
*/
String getUri();
@ -58,137 +58,137 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* href="http://wiki.java.net/bin/edit/Javawsxml/Rome04URIMapping">Feed and entry URI
* mapping</a>.
* <p>
*
*
* @param uri the entry URI to set, <b>null</b> if none.
*
*
*/
void setUri(String uri);
/**
* Returns the entry title.
* <p>
*
*
* @return the entry title, <b>null</b> if none.
*
*
*/
String getTitle();
/**
* Sets the entry title.
* <p>
*
*
* @param title the entry title to set, <b>null</b> if none.
*
*
*/
void setTitle(String title);
/**
* Returns the entry title as a text construct.
* <p>
*
*
* @return the entry title, <b>null</b> if none.
*
*
*/
SyndContent getTitleEx();
/**
* Sets the entry title as a text construct.
* <p>
*
*
* @param title the entry title to set, <b>null</b> if none.
*
*
*/
void setTitleEx(SyndContent title);
/**
* Returns the entry link.
* <p>
*
*
* @return the entry link, <b>null</b> if none.
*
*
*/
String getLink();
/**
* Sets the entry link.
* <p>
*
*
* @param link the entry link to set, <b>null</b> if none.
*
*
*/
void setLink(String link);
/**
* Returns the entry links
* <p>
*
*
* @return the entry links, <b>null</b> if none.
*
*
*/
List<SyndLink> getLinks();
/**
* Sets the entry links.
* <p>
*
*
* @param links the entry links to set, <b>null</b> if none.
*
*
*/
void setLinks(List<SyndLink> links);
/**
* Returns the entry description.
* <p>
*
*
* @return the entry description, <b>null</b> if none.
*
*
*/
SyndContent getDescription();
/**
* Sets the entry description.
* <p>
*
*
* @param description the entry description to set, <b>null</b> if none.
*
*
*/
void setDescription(SyndContent description);
/**
* Returns the entry contents.
* <p>
*
*
* @return a list of SyndContentImpl elements with the entry contents, an empty list if none.
*
*
*/
List<SyndContent> getContents();
/**
* Sets the entry contents.
* <p>
*
*
* @param contents the list of SyndContentImpl elements with the entry contents to set, an empty
* list or <b>null</b> if none.
*
*
*/
void setContents(List<SyndContent> contents);
/**
* Returns the entry enclosures.
* <p>
*
*
* @return a list of SyndEnclosure elements with the entry enclosures, an empty list if none.
*
*
*/
public List<SyndEnclosure> getEnclosures();
/**
* Sets the entry enclosures.
* <p>
*
*
* @param enclosures the list of SyndEnclosure elements with the entry enclosures to set, an
* empty list or <b>null</b> if none.
*
*
*/
public void setEnclosures(List<SyndEnclosure> enclosures);
@ -197,9 +197,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module date.
* <p>
*
*
* @return the entry published date, <b>null</b> if none.
*
*
*/
Date getPublishedDate();
@ -208,27 +208,27 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module date.
* <p>
*
*
* @param publishedDate the entry published date to set, <b>null</b> if none.
*
*
*/
void setPublishedDate(Date publishedDate);
/**
* Returns the entry updated date.
* <p>
*
*
* @return the entry updated date, <b>null</b> if none.
*
*
*/
Date getUpdatedDate();
/**
* Sets the entry updated date.
* <p>
*
*
* @param updatedDate the entry updated date to set, <b>null</b> if none.
*
*
*/
void setUpdatedDate(Date updatedDate);
@ -238,9 +238,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this
* method is a convenience method, it maps to the Dublin Core module creator.
* <p>
*
*
* @return the feed author, <b>null</b> if none.
*
*
*/
List<SyndPerson> getAuthors();
@ -250,9 +250,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this sets the authors as a list of SyndPerson objects, for RSS feeds this
* method is a convenience method, it maps to the Dublin Core module creator.
* <p>
*
*
* @param authors the feed author to set, <b>null</b> if none.
*
*
*/
void setAuthors(List<SyndPerson> authors);
@ -262,9 +262,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this
* method is a convenience method, it maps to the Dublin Core module creator.
* <p>
*
*
* @return the feed author, <b>null</b> if none.
*
*
*/
String getAuthor();
@ -274,7 +274,7 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this sets the feed author's name, for RSS feeds this method is a convenience
* method, it maps to the Dublin Core module creator.
* <p>
*
*
* @param author the feed author to set, <b>null</b> if none.
*/
void setAuthor(String author);
@ -284,9 +284,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* For Atom feeds, this returns the contributors as a list of SyndPerson objects
* <p>
*
*
* @return the feed author, <b>null</b> if none.
*
*
*/
List<SyndPerson> getContributors();
@ -295,9 +295,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* Returns contributors as a list of SyndPerson objects.
* <p>
*
*
* @param contributors the feed contributors to set, <b>null</b> if none.
*
*
*/
void setContributors(List<SyndPerson> contributors);
@ -306,9 +306,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module subjects.
* <p>
*
*
* @return a list of SyndCategoryImpl elements with the entry categories, an empty list if none.
*
*
*/
List<SyndCategory> getCategories();
@ -317,10 +317,10 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module subjects.
* <p>
*
*
* @param categories the list of SyndCategoryImpl elements with the entry categories to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setCategories(List<SyndCategory> categories);
@ -329,18 +329,18 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* <p>
* This returns the entry source as a SyndFeed
* <p>
*
*
* @return the SyndFeed to which this entry is attributed
*
*
*/
SyndFeed getSource();
/**
* Sets the entry source feed (for use if different from containing feed)
* <p>
*
*
* @param source the original SyndFeed that contained this article
*
*
*/
void setSource(SyndFeed source);
@ -350,7 +350,7 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
* com.sun.syndication.feed.atom.Entry, while RSS will return
* com.sun.syndication.feed.rss.Item.java. If this entry was not generated from a WireFeed, or
* the SyndFeed was not set to preserve the WireFeed then it will return null
*
*
* @return the WireFeed Item or Entry this Entry is generated from, or null
*/
Object getWireEntry();
@ -358,7 +358,7 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
/**
* Returns the module identified by a given URI.
* <p>
*
*
* @param uri the URI of the ModuleImpl.
* @return The module with the given URI, <b>null</b> if none.
*/
@ -368,9 +368,9 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
/**
* Returns the entry modules.
* <p>
*
*
* @return a list of ModuleImpl elements with the entry modules, an empty list if none.
*
*
*/
@Override
List<Module> getModules();
@ -378,10 +378,10 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
/**
* Sets the entry modules.
* <p>
*
*
* @param modules the list of ModuleImpl elements with the entry modules to set, an empty list
* or <b>null</b> if none.
*
*
*/
@Override
void setModules(List<Module> modules);
@ -389,33 +389,33 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
/**
* Returns foreign markup found at channel level.
* <p>
*
*
* @return Opaque object to discourage use
*
*
*/
public List<Element> getForeignMarkup();
/**
* Sets foreign markup found at channel level.
* <p>
*
*
* @param foreignMarkup Opaque object to discourage use
*
*
*/
public void setForeignMarkup(List<Element> foreignMarkup);
/**
* URL of a page for comments relating to the item.
*
*
* @since 2.0.0
* @return comments URL or {@code null}.
*
*
*/
String getComments();
/**
* URL of a page for comments relating to the item.
*
*
* @since 2.0.0
* @param comments URL
*/
@ -424,16 +424,16 @@ public interface SyndEntry extends Cloneable, CopyFrom, Extendable {
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;
/**
* Returns the first instance of a SyndLink with the specified relation, or null
*
*
*/
public SyndLink findRelatedLink(String relation);

206
src/main/java/com/sun/syndication/feed/synd/SyndFeed.java
View file

@ -31,16 +31,16 @@ import com.sun.syndication.feed.module.Module;
* <p>
* It handles all RSS versions and Atom 0.3, it normalizes all info, it may lose information.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* Returns the real feed types the SyndFeedImpl supports when converting from and to.
* <p>
*
*
* @return the real feed type supported.
*/
List<String> getSupportedFeedTypes();
@ -50,33 +50,33 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* The feed type of the created WireFeed is taken from the SyndFeedImpl feedType property.
* <p>
*
*
* @return the real feed.
*
*
*/
WireFeed createWireFeed();
/**
* Creates a real feed containing the information of the SyndFeedImpl.
* <p>
*
*
* @param feedType the feed type for the WireFeed to be created.
* @return the real feed.
*
*
*/
WireFeed createWireFeed(String feedType);
/**
* Returns the WireFeed this SyndFeed was created from. Will return null if the original feed is
* not stored or if this SyndFeed was not created from a WireFeed
*
*
* @return The WireFeed this was created from, or null
*
*
*/
WireFeed originalWireFeed();
/**
*
*
* @return true if this SyndFeed preserves the WireFeed it was created from
*/
boolean isPreservingWireFeed();
@ -84,36 +84,36 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* Returns the wire feed type the feed had/will-have when converted from/to a WireFeed.
* <p>
*
*
* @return the feed type, <b>null</b> if none.
*
*
*/
String getFeedType();
/**
* Sets the wire feed type the feed will-have when coverted to a WireFeed.
* <p>
*
*
* @param feedType the feed type to set, <b>null</b> if none.
*
*
*/
void setFeedType(String feedType);
/**
* Returns the charset encoding of a the feed. This is not set by Rome parsers.
* <p>
*
*
* @return the charset encoding of the feed.
*
*
*/
public String getEncoding();
/**
* Sets the charset encoding of a the feed. This is not set by Rome parsers.
* <p>
*
*
* @param encoding the charset encoding of the feed.
*
*
*/
public void setEncoding(String encoding);
@ -137,9 +137,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI
* reference.
* <p>
*
*
* @return the feed URI, <b>null</b> if none.
*
*
*/
String getUri();
@ -161,45 +161,45 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI
* reference.
* <p>
*
*
* @param uri the feed URI to set, <b>null</b> if none.
*
*
*/
void setUri(String uri);
/**
* Returns the feed title.
* <p>
*
*
* @return the feed title, <b>null</b> if none.
*
*
*/
String getTitle();
/**
* Sets the feed title.
* <p>
*
*
* @param title the feed title to set, <b>null</b> if none.
*
*
*/
void setTitle(String title);
/**
* Returns the feed title.
* <p>
*
*
* @return the feed title, <b>null</b> if none.
*
*
*/
SyndContent getTitleEx();
/**
* Sets the feed title.
* <p>
*
*
* @param title the feed title to set, <b>null</b> if none.
*
*
*/
void setTitleEx(SyndContent title);
@ -216,9 +216,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI
* reference.
* <p>
*
*
* @return the feed link, <b>null</b> if none.
*
*
*/
String getLink();
@ -235,63 +235,63 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI
* reference.
* <p>
*
*
* @param link the feed link to set, <b>null</b> if none.
*
*
*/
void setLink(String link);
/**
* Returns the entry links
* <p>
*
*
* @return the entry links, <b>null</b> if none.
*
*
*/
List<SyndLink> getLinks();
/**
* Sets the entry links.
* <p>
*
*
* @param links the entry links to set, <b>null</b> if none.
*
*
*/
void setLinks(List<SyndLink> links);
/**
* Returns the feed description.
* <p>
*
*
* @return the feed description, <b>null</b> if none.
*
*
*/
String getDescription();
/**
* Sets the feed description.
* <p>
*
*
* @param description the feed description to set, <b>null</b> if none.
*
*
*/
void setDescription(String description);
/**
* Returns the feed description as a text construct.
* <p>
*
*
* @return the feed description, <b>null</b> if none.
*
*
*/
SyndContent getDescriptionEx();
/**
* Sets the feed description as a text construct.
* <p>
*
*
* @param description the feed description to set, <b>null</b> if none.
*
*
*/
void setDescriptionEx(SyndContent description);
@ -300,9 +300,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module date.
* <p>
*
*
* @return the feed published date, <b>null</b> if none.
*
*
*/
Date getPublishedDate();
@ -311,9 +311,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module date.
* <p>
*
*
* @param publishedDate the feed published date to set, <b>null</b> if none.
*
*
*/
void setPublishedDate(Date publishedDate);
@ -323,9 +323,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this
* method is a convenience method, it maps to the Dublin Core module creator.
* <p>
*
*
* @return the feed authors, <b>null</b> if none.
*
*
*/
List<SyndPerson> getAuthors();
@ -335,9 +335,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this sets the authors as a list of SyndPerson objects, for RSS feeds this
* method is a convenience method, it maps to the Dublin Core module creator.
* <p>
*
*
* @param authors the feed authors to set, <b>null</b> if none.
*
*
*/
void setAuthors(List<SyndPerson> authors);
@ -347,9 +347,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this
* method is a convenience method, it maps to the Dublin Core module creator.
* <p>
*
*
* @return the feed author, <b>null</b> if none.
*
*
*/
String getAuthor();
@ -359,9 +359,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* For Atom feeds, this sets the feed author's name, for RSS feeds this method is a convenience
* method, it maps to the Dublin Core module creator.
* <p>
*
*
* @param author the feed author to set, <b>null</b> if none.
*
*
*/
void setAuthor(String author);
@ -370,9 +370,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* For Atom feeds, this returns the contributors as a list of SyndPerson objects
* <p>
*
*
* @return the feed author, <b>null</b> if none.
*
*
*/
public List<SyndPerson> getContributors();
@ -381,9 +381,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* Returns contributors as a list of SyndPerson objects.
* <p>
*
*
* @param contributors the feed contributors to set, <b>null</b> if none.
*
*
*/
void setContributors(List<SyndPerson> contributors);
@ -392,9 +392,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module rights.
* <p>
*
*
* @return the feed copyright, <b>null</b> if none.
*
*
*/
String getCopyright();
@ -403,27 +403,27 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module rights.
* <p>
*
*
* @param copyright the feed copyright to set, <b>null</b> if none.
*
*
*/
void setCopyright(String copyright);
/**
* Returns the feed image.
* <p>
*
*
* @return the feed image, <b>null</b> if none.
*
*
*/
SyndImage getImage();
/**
* Sets the feed image.
* <p>
*
*
* @param image the feed image to set, <b>null</b> if none.
*
*
*/
void setImage(SyndImage image);
@ -432,9 +432,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module subjects.
* <p>
*
*
* @return a list of SyndCategoryImpl elements with the feed categories, an empty list if none.
*
*
*/
List<SyndCategory> getCategories();
@ -443,29 +443,29 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module subjects.
* <p>
*
*
* @param categories the list of SyndCategoryImpl elements with the feed categories to set, an
* empty list or <b>null</b> if none.
*
*
*/
void setCategories(List<SyndCategory> categories);
/**
* Returns the feed entries.
* <p>
*
*
* @return a list of SyndEntry elements with the feed entries, an empty list if none.
*
*
*/
List<SyndEntry> getEntries();
/**
* Sets the feed entries.
* <p>
*
*
* @param entries the list of SyndEntryImpl elements with the feed entries to set, an empty list
* or <b>null</b> if none.
*
*
*/
void setEntries(List<SyndEntry> entries);
@ -474,9 +474,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module language.
* <p>
*
*
* @return the feed language, <b>null</b> if none.
*
*
*/
String getLanguage();
@ -485,16 +485,16 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
* <p>
* This method is a convenience method, it maps to the Dublin Core module language.
* <p>
*
*
* @param language the feed language to set, <b>null</b> if none.
*
*
*/
void setLanguage(String language);
/**
* Returns the module identified by a given URI.
* <p>
*
*
* @param uri the URI of the ModuleImpl.
* @return The module with the given URI, <b>null</b> if none.
*/
@ -504,9 +504,9 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* Returns the feed modules.
* <p>
*
*
* @return a list of ModuleImpl elements with the feed modules, an empty list if none.
*
*
*/
@Override
List<Module> getModules();
@ -514,10 +514,10 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* Sets the feed modules.
* <p>
*
*
* @param modules the list of ModuleImpl elements with the feed modules to set, an empty list or
* <b>null</b> if none.
*
*
*/
@Override
void setModules(List<Module> modules);
@ -525,24 +525,24 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* Returns foreign markup found at channel level.
* <p>
*
*
* @return Opaque object to discourage use
*
*
*/
public List<Element> getForeignMarkup();
/**
* Sets foreign markup found at channel level.
* <p>
*
*
* @param foreignMarkup Opaque object to discourage use
*
*
*/
public void setForeignMarkup(List<Element> foreignMarkup);
/**
* This tag should contain a URL that references a description of the channel.
*
*
* @since 2.0.0
* @return channel description URL or {@code null}
*/
@ -550,7 +550,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* This tag should contain a URL that references a description of the channel.
*
*
* @since 2.0.0
* @param channel description URL
*/
@ -558,7 +558,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* A string indicating the program used to generate the channel.
*
*
* @since 2.0.0
* @return string indicating the program or {@code null}
*/
@ -566,7 +566,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* A string indicating the program used to generate the channel.
*
*
* @since 2.0.0
* @param string indicating the program
*/
@ -575,7 +575,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* The email address of the managing editor of the site, the person to contact for editorial
* inquiries.
*
*
* @since 2.0.0
* @return email address of the managing editor or {@code null}
*/
@ -584,7 +584,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* The email address of the managing editor of the site, the person to contact for editorial
* inquiries.
*
*
* @since 2.0.0
* @param managingEditor email address of the managing editor
*/
@ -593,7 +593,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* The email address of the webmaster for the site, the person to contact if there are technical
* problems with the channel.
*
*
* @since 2.0.0
* @return email address of the webmaster or {@code null}
*/
@ -602,7 +602,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* The email address of the webmaster for the site, the person to contact if there are technical
* problems with the channel.
*
*
* @since 2.0.0
* @param webMaster email address of the webmaster
*/
@ -610,7 +610,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* URL of XSL-Stylesheet.
*
*
* @since 2.0.0
* @return styleSheet URL or {@code null}
*/
@ -618,7 +618,7 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* URL of XSL-Stylesheet.
*
*
* @since 2.0.0
* @param styleSheet URL or {@code null}
*/
@ -627,10 +627,10 @@ public interface SyndFeed extends Cloneable, CopyFrom, Extendable {
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;

40
src/main/java/com/sun/syndication/feed/synd/SyndImage.java
View file

@ -22,90 +22,90 @@ import com.sun.syndication.feed.CopyFrom;
/**
* Bean interface for images of SyndFeedImpl feeds.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface SyndImage extends Cloneable, CopyFrom {
/**
* Returns the image title.
* <p>
*
*
* @return the image title, <b>null</b> if none.
*
*
*/
String getTitle();
/**
* Sets the image title.
* <p>
*
*
* @param title the image title to set, <b>null</b> if none.
*
*
*/
void setTitle(String title);
/**
* Returns the image URL.
* <p>
*
*
* @return the image URL, <b>null</b> if none.
*
*
*/
String getUrl();
/**
* Sets the image URL.
* <p>
*
*
* @param url the image URL to set, <b>null</b> if none.
*
*
*/
void setUrl(String url);
/**
* Returns the image link.
* <p>
*
*
* @return the image link, <b>null</b> if none.
*
*
*/
String getLink();
/**
* Sets the image link.
* <p>
*
*
* @param link the image link to set, <b>null</b> if none.
*
*
*/
void setLink(String link);
/**
* Returns the image description.
* <p>
*
*
* @return the image description, <b>null</b> if none.
*
*
*/
String getDescription();
/**
* Sets the image description.
* <p>
*
*
* @param description the image description to set, <b>null</b> if none.
*
*
*/
void setDescription(String description);
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;

58
src/main/java/com/sun/syndication/feed/synd/SyndLink.java
View file

@ -19,17 +19,17 @@ package com.sun.syndication.feed.synd;
/**
* Represents a link or enclosure associated with entry.
*
*
* @author Dave Johnson
*/
public interface SyndLink {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public abstract Object clone() throws CloneNotSupportedException;
@ -37,10 +37,10 @@ public interface SyndLink {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public abstract boolean equals(Object other);
@ -50,9 +50,9 @@ public interface SyndLink {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public abstract int hashCode();
@ -60,9 +60,9 @@ public interface SyndLink {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public abstract String toString();
@ -70,79 +70,79 @@ public interface SyndLink {
/**
* Returns the link rel.
* <p>
*
*
* @return the link rel, <b>null</b> if none.
*
*
*/
public abstract String getRel();
/**
* Sets the link rel.
* <p>
*
*
* @param rel the link rel,, <b>null</b> if none.
*
*
*/
public abstract void setRel(String rel);
/**
* Returns the link type.
* <p>
*
*
* @return the link type, <b>null</b> if none.
*
*
*/
public abstract String getType();
/**
* Sets the link type.
* <p>
*
*
* @param type the link type, <b>null</b> if none.
*
*
*/
public abstract void setType(String type);
/**
* Returns the link href.
* <p>
*
*
* @return the link href, <b>null</b> if none.
*
*
*/
public abstract String getHref();
/**
* Sets the link href.
* <p>
*
*
* @param href the link href, <b>null</b> if none.
*
*
*/
public abstract void setHref(String href);
/**
* Returns the link title.
* <p>
*
*
* @return the link title, <b>null</b> if none.
*
*
*/
public abstract String getTitle();
/**
* Sets the link title.
* <p>
*
*
* @param title the link title, <b>null</b> if none.
*
*
*/
public abstract void setTitle(String title);
/**
* Returns the hreflang
* <p>
*
*
* @return Returns the hreflang.
*/
public abstract String getHreflang();
@ -150,7 +150,7 @@ public interface SyndLink {
/**
* Set the hreflang
* <p>
*
*
* @param hreflang The hreflang to set.
*/
public abstract void setHreflang(String hreflang);
@ -158,7 +158,7 @@ public interface SyndLink {
/**
* Returns the length
* <p>
*
*
* @return Returns the length.
*/
public abstract long getLength();
@ -166,7 +166,7 @@ public interface SyndLink {
/**
* Set the length
* <p>
*
*
* @param length The length to set.
*/
public abstract void setLength(long length);

60
src/main/java/com/sun/syndication/feed/synd/SyndLinkImpl.java
View file

@ -24,7 +24,7 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* Represents a link or an enclosure.
* <p>
*
*
* @author Alejandro Abdelnur
* @author Dave Johnson (updated for Atom 1.0)
*/
@ -43,7 +43,7 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Default constructor. All properties are set to <b>null</b>.
* <p>
*
*
*/
public SyndLinkImpl() {
objBean = new ObjectBean(this.getClass(), this);
@ -52,10 +52,10 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Creates a deep 'bean' clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
@ -66,10 +66,10 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
*
* @param other he reference object with which to compare.
* @return <b>true</b> if 'this' object is equal to the 'other' object.
*
*
*/
@Override
public boolean equals(final Object other) {
@ -84,9 +84,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
* <p>
* It follows the contract defined by the Object hashCode() method.
* <p>
*
*
* @return the hashcode of the bean object.
*
*
*/
@Override
public int hashCode() {
@ -96,9 +96,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Returns the String representation for the object.
* <p>
*
*
* @return String representation for the object.
*
*
*/
@Override
public String toString() {
@ -108,9 +108,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Returns the link rel.
* <p>
*
*
* @return the link rel, <b>null</b> if none.
*
*
*/
@Override
public String getRel() {
@ -120,9 +120,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Sets the link rel.
* <p>
*
*
* @param rel the link rel,, <b>null</b> if none.
*
*
*/
@Override
public void setRel(final String rel) {
@ -133,9 +133,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Returns the link type.
* <p>
*
*
* @return the link type, <b>null</b> if none.
*
*
*/
@Override
public String getType() {
@ -145,9 +145,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Sets the link type.
* <p>
*
*
* @param type the link type, <b>null</b> if none.
*
*
*/
@Override
public void setType(final String type) {
@ -157,9 +157,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Returns the link href.
* <p>
*
*
* @return the link href, <b>null</b> if none.
*
*
*/
@Override
public String getHref() {
@ -169,9 +169,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Sets the link href.
* <p>
*
*
* @param href the link href, <b>null</b> if none.
*
*
*/
@Override
public void setHref(final String href) {
@ -181,9 +181,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Returns the link title.
* <p>
*
*
* @return the link title, <b>null</b> if none.
*
*
*/
@Override
public String getTitle() {
@ -193,9 +193,9 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Sets the link title.
* <p>
*
*
* @param title the link title, <b>null</b> if none.
*
*
*/
@Override
public void setTitle(final String title) {
@ -205,7 +205,7 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Returns the hreflang
* <p>
*
*
* @return Returns the hreflang.
*/
@Override
@ -216,7 +216,7 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Set the hreflang
* <p>
*
*
* @param hreflang The hreflang to set.
*/
@Override
@ -227,7 +227,7 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Returns the length
* <p>
*
*
* @return Returns the length.
*/
@Override
@ -238,7 +238,7 @@ public class SyndLinkImpl implements Cloneable, Serializable, SyndLink {
/**
* Set the length
* <p>
*
*
* @param length The length to set.
*/
@Override

8
src/main/java/com/sun/syndication/feed/synd/SyndPerson.java
View file

@ -22,9 +22,9 @@ import com.sun.syndication.feed.module.Extendable;
/**
* Bean interface for authors and contributors of SyndFeedImpl feeds and entries.
* <p>
*
*
* @author Dave Johnson
*
*
*/
public interface SyndPerson extends Cloneable, Extendable {
@ -61,10 +61,10 @@ public interface SyndPerson extends Cloneable, Extendable {
/**
* Creates a deep clone of the object.
* <p>
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*
*/
public Object clone() throws CloneNotSupportedException;

2
src/main/java/com/sun/syndication/feed/synd/impl/Converters.java
View file

@ -29,7 +29,7 @@ public class Converters extends PluginManager<Converter> {
/**
* Converter.classes= [className] ...
*
*
*/
public static final String CONVERTERS_KEY = "Converter.classes";

4
src/main/java/com/sun/syndication/feed/synd/impl/URINormalizer.java
View file

@ -3,7 +3,7 @@ package com.sun.syndication.feed.synd.impl;
/**
* Utility class for normalizing an URI as specified in RFC 2396bis.
* <p>
*
*
* @author Alejandro Abdelnur
*/
public class URINormalizer {
@ -11,7 +11,7 @@ public class URINormalizer {
/**
* Normalizes an URI as specified in RFC 2396bis.
* <p>
*
*
* @param uri to normalize.
* @return the normalized value of the given URI, or <b>null</b> if the given URI was
* <b>null</b>.

2
src/main/java/com/sun/syndication/io/DelegatingModuleGenerator.java
View file

@ -8,7 +8,7 @@ package com.sun.syndication.io;
public interface DelegatingModuleGenerator extends ModuleGenerator {
/**
* Provides a parent wirefeed reference to this ModuleParser, or "plugin-in".
*
*
* @param feedGenerator the parent wirefeed generator for this plugin.
*/
void setFeedGenerator(WireFeedGenerator feedGenerator);

2
src/main/java/com/sun/syndication/io/DelegatingModuleParser.java
View file

@ -8,7 +8,7 @@ package com.sun.syndication.io;
public interface DelegatingModuleParser extends ModuleParser {
/**
* Provides a parent wirefeed reference to this ModuleParser, or "plugin-in".
*
*
* @param feedParser the parent wirefeed parser for this plugin.
*/
void setFeedParser(WireFeedParser feedParser);

12
src/main/java/com/sun/syndication/io/ModuleGenerator.java
View file

@ -30,18 +30,18 @@ import com.sun.syndication.feed.module.Module;
* <p>
* TODO: explain how developers can plugin their own implementations.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface ModuleGenerator {
/**
* Returns the namespace URI this generator handles.
* <p>
*
*
* @return the namespace URI.
*
*
*/
public String getNamespaceUri();
@ -51,7 +51,7 @@ public interface 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).
* <p/>
*
*
* @return a set with all the URIs (JDOM Namespace elements) this module generator uses.
*/
public Set<Namespace> getNamespaces();
@ -59,7 +59,7 @@ public interface ModuleGenerator {
/**
* Generates and injects module metadata into an XML node (JDOM element).
* <p>
*
*
* @param module the module to inject into the XML node (JDOM element).
* @param element the XML node into which module meta-data will be injected.
*/

12
src/main/java/com/sun/syndication/io/ModuleParser.java
View file

@ -29,28 +29,28 @@ import com.sun.syndication.feed.module.Module;
* <p>
* TODO: explain how developers can plugin their own implementations.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface ModuleParser {
/**
* Returns the namespace URI this parser handles.
* <p>
*
*
* @return the namespace URI.
*
*
*/
public String getNamespaceUri();
/**
* Parses the XML node (JDOM element) extracting module information.
* <p>
*
*
* @param element the XML node (JDOM element) to extract module information from.
* @return a module instance, <b>null</b> if the element did not have module information.
*
*
*/
public Module parse(Element element, Locale locale);
}

10
src/main/java/com/sun/syndication/io/SAXBuilder.java
View file

@ -7,14 +7,14 @@ import org.xml.sax.XMLReader;
/*
* This code is needed to fix the security problem outlined in http://www.securityfocus.com/archive/1/297714
*
*
* Unfortunately there isn't an easy way to check if an XML parser supports a particular feature, so
* we need to set it and catch the exception if it fails. We also need to subclass the JDom SAXBuilder
* we need to set it and catch the exception if it fails. We also need to subclass the JDom SAXBuilder
* class in order to get access to the underlying SAX parser - otherwise the features don't get set until
* we are already building the document, by which time it's too late to fix the problem.
*
*
* Crimson is one parser which is known not to support these features.
*
*
*/
public class SAXBuilder extends org.jdom2.input.SAXBuilder {
@ -23,7 +23,7 @@ public class SAXBuilder extends org.jdom2.input.SAXBuilder {
}
/**
*
*
* @deprecated use SAXBuilder(XMLReaderJDOMFactory) with either XMLReaders.DTDVALIDATING or
* XMLReaders.NONVALIDATING
* @param validate

42
src/main/java/com/sun/syndication/io/SyndFeedInput.java
View file

@ -34,9 +34,9 @@ import com.sun.syndication.feed.synd.SyndFeedImpl;
* <p>
* It delegates to a WireFeedInput to handle all feed types.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class SyndFeedInput {
private final WireFeedInput feedInput;
@ -45,7 +45,7 @@ public class SyndFeedInput {
/**
* Creates a SyndFeedInput instance with input validation turned off.
* <p>
*
*
*/
public SyndFeedInput() {
this(false, Locale.US);
@ -54,10 +54,10 @@ public class SyndFeedInput {
/**
* Creates a SyndFeedInput instance.
* <p>
*
*
* @param validate indicates if the input should be validated. NOT IMPLEMENTED YET (validation
* does not happen)
*
*
*/
public SyndFeedInput(final boolean validate, final Locale locale) {
feedInput = new WireFeedInput(validate, locale);
@ -74,9 +74,9 @@ public class SyndFeedInput {
* <p>
* By default is TRUE.
* <p>
*
*
* @param heals TRUE enables stream healing, FALSE disables it.
*
*
*/
public void setXmlHealerOn(final boolean heals) {
feedInput.setXmlHealerOn(heals);
@ -93,9 +93,9 @@ public class SyndFeedInput {
* <p>
* By default is TRUE.
* <p>
*
*
* @return TRUE if healing is enabled, FALSE if not.
*
*
*/
public boolean getXmlHealerOn() {
return feedInput.getXmlHealerOn();
@ -104,7 +104,7 @@ public class SyndFeedInput {
/**
* Builds SyndFeedImpl from a file.
* <p>
*
*
* @param file file to read to create the SyndFeedImpl.
* @return the SyndFeedImpl read from the file.
* @throws FileNotFoundException thrown if the file could not be found.
@ -112,7 +112,7 @@ public class SyndFeedInput {
* @throws IllegalArgumentException thrown if feed type could not be understood by any of the
* underlying parsers.
* @throws FeedException if the feed could not be parsed
*
*
*/
public SyndFeed build(final File file) throws FileNotFoundException, IOException, IllegalArgumentException, FeedException {
return new SyndFeedImpl(feedInput.build(file), preserveWireFeed);
@ -121,13 +121,13 @@ public class SyndFeedInput {
/**
* Builds SyndFeedImpl from an Reader.
* <p>
*
*
* @param reader Reader to read to create the SyndFeedImpl.
* @return the SyndFeedImpl read from the Reader.
* @throws IllegalArgumentException thrown if feed type could not be understood by any of the
* underlying parsers.
* @throws FeedException if the feed could not be parsed
*
*
*/
public SyndFeed build(final Reader reader) throws IllegalArgumentException, FeedException {
return new SyndFeedImpl(feedInput.build(reader), preserveWireFeed);
@ -136,13 +136,13 @@ public class SyndFeedInput {
/**
* Builds SyndFeedImpl from an W3C SAX InputSource.
* <p>
*
*
* @param is W3C SAX InputSource to read to create the SyndFeedImpl.
* @return the SyndFeedImpl read from the W3C SAX InputSource.
* @throws IllegalArgumentException thrown if feed type could not be understood by any of the
* underlying parsers.
* @throws FeedException if the feed could not be parsed
*
*
*/
public SyndFeed build(final InputSource is) throws IllegalArgumentException, FeedException {
return new SyndFeedImpl(feedInput.build(is), preserveWireFeed);
@ -151,13 +151,13 @@ public class SyndFeedInput {
/**
* Builds SyndFeedImpl from an W3C DOM document.
* <p>
*
*
* @param document W3C DOM document to read to create the SyndFeedImpl.
* @return the SyndFeedImpl read from the W3C DOM document.
* @throws IllegalArgumentException thrown if feed type could not be understood by any of the
* underlying parsers.
* @throws FeedException if the feed could not be parsed
*
*
*/
public SyndFeed build(final org.w3c.dom.Document document) throws IllegalArgumentException, FeedException {
return new SyndFeedImpl(feedInput.build(document), preserveWireFeed);
@ -166,20 +166,20 @@ public class SyndFeedInput {
/**
* Builds SyndFeedImpl from an JDOM document.
* <p>
*
*
* @param document JDOM document to read to create the SyndFeedImpl.
* @return the SyndFeedImpl read from the JDOM document.
* @throws IllegalArgumentException thrown if feed type could not be understood by any of the
* underlying parsers.
* @throws FeedException if the feed could not be parsed
*
*
*/
public SyndFeed build(final Document document) throws IllegalArgumentException, FeedException {
return new SyndFeedImpl(feedInput.build(document), preserveWireFeed);
}
/**
*
*
* @return true if the WireFeed is made available in the SyndFeed. False by default.
*/
public boolean isPreserveWireFeed() {
@ -187,7 +187,7 @@ public class SyndFeedInput {
}
/**
*
*
* @param preserveWireFeed set to true to make the WireFeed is made available in the SyndFeed.
* False by default.
*/

12
src/main/java/com/sun/syndication/io/WireFeedGenerator.java
View file

@ -27,33 +27,33 @@ import com.sun.syndication.feed.WireFeed;
* <p>
* TODO: explain how developers can plugin their own implementations.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface WireFeedGenerator {
/**
* Returns the type of feed the generator creates.
* <p>
*
*
* @see WireFeed for details on the format of this string.
* <p>
* @return the type of feed the generator creates.
*
*
*/
public String getType();
/**
* Creates an XML document (JDOM) for the given feed bean.
* <p>
*
*
* @param feed the feed bean to generate the XML document from.
* @return the generated XML document (JDOM).
* @throws IllegalArgumentException thrown if the type of the given feed bean does not match
* with the type of the WireFeedGenerator.
* @throws FeedException thrown if the XML Document could not be created.
*
*
*/
public Document generate(WireFeed feed) throws IllegalArgumentException, FeedException;

42
src/main/java/com/sun/syndication/io/WireFeedOutput.java
View file

@ -41,9 +41,9 @@ import com.sun.syndication.io.impl.FeedGenerators;
* It generates all flavors of RSS (0.90, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0) and Atom 0.3 feeds.
* Generators are plugable (they must implement the ModuleParser interface).
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class WireFeedOutput {
private static Map<ClassLoader, FeedGenerators> clMap = new WeakHashMap<ClassLoader, FeedGenerators>();
@ -63,11 +63,11 @@ public class WireFeedOutput {
/**
* Returns the list of supported output feed types.
* <p>
*
*
* @see WireFeed for details on the format of these strings.
* <p>
* @return a list of String elements with the supported output feed types.
*
*
*/
public static List<String> getSupportedFeedTypes() {
return getFeedGenerators().getSupportedFeedTypes();
@ -76,7 +76,7 @@ public class WireFeedOutput {
/**
* Creates a FeedOuput instance.
* <p>
*
*
*/
public WireFeedOutput() {
}
@ -90,14 +90,14 @@ public class WireFeedOutput {
* <p>
* NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
* <p>
*
*
* @param feed Abstract feed to create XML representation from. The type of the WireFeed must
* match the type given to the FeedOuptut constructor.
* @return a String with the XML representation for the given WireFeed.
* @throws IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed
* don't match.
* @throws FeedException thrown if the XML representation for the feed could not be created.
*
*
*/
public String outputString(final WireFeed feed) throws IllegalArgumentException, FeedException {
return this.outputString(feed, true);
@ -112,7 +112,7 @@ public class WireFeedOutput {
* <p>
* NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
* <p>
*
*
* @param feed Abstract feed to create XML representation from. The type of the WireFeed must
* match the type given to the FeedOuptut constructor.
* @param prettyPrint pretty-print XML (true) oder collapsed
@ -120,7 +120,7 @@ public class WireFeedOutput {
* @throws IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed
* don't match.
* @throws FeedException thrown if the XML representation for the feed could not be created.
*
*
*/
public String outputString(final WireFeed feed, final boolean prettyPrint) throws IllegalArgumentException, FeedException {
final Document doc = outputJDom(feed);
@ -148,7 +148,7 @@ public class WireFeedOutput {
* <p>
* NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
* <p>
*
*
* @param feed Abstract feed to create XML representation from. The type of the WireFeed must
* match the type given to the FeedOuptut constructor.
* @param file the file where to write the XML representation for the given WireFeed.
@ -156,7 +156,7 @@ public class WireFeedOutput {
* don't match.
* @throws IOException thrown if there was some problem writing to the File.
* @throws FeedException thrown if the XML representation for the feed could not be created.
*
*
*/
public void output(final WireFeed feed, final File file) throws IllegalArgumentException, IOException, FeedException {
this.output(feed, file, true);
@ -172,7 +172,7 @@ public class WireFeedOutput {
* <p>
* NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
* <p>
*
*
* @param feed Abstract feed to create XML representation from. The type of the WireFeed must
* match the type given to the FeedOuptut constructor.
* @param file the file where to write the XML representation for the given WireFeed.
@ -181,7 +181,7 @@ public class WireFeedOutput {
* don't match.
* @throws IOException thrown if there was some problem writing to the File.
* @throws FeedException thrown if the XML representation for the feed could not be created.
*
*
*/
public void output(final WireFeed feed, final File file, final boolean prettyPrint) throws IllegalArgumentException, IOException, FeedException {
final Writer writer = new FileWriter(file);
@ -198,7 +198,7 @@ public class WireFeedOutput {
* <p>
* NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
* <p>
*
*
* @param feed Abstract feed to create XML representation from. The type of the WireFeed must
* match the type given to the FeedOuptut constructor.
* @param writer Writer to write the XML representation for the given WireFeed.
@ -206,7 +206,7 @@ public class WireFeedOutput {
* don't match.
* @throws IOException thrown if there was some problem writing to the Writer.
* @throws FeedException thrown if the XML representation for the feed could not be created.
*
*
*/
public void output(final WireFeed feed, final Writer writer) throws IllegalArgumentException, IOException, FeedException {
this.output(feed, writer, true);
@ -221,7 +221,7 @@ public class WireFeedOutput {
* <p>
* NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
* <p>
*
*
* @param feed Abstract feed to create XML representation from. The type of the WireFeed must
* match the type given to the FeedOuptut constructor.
* @param writer Writer to write the XML representation for the given WireFeed.
@ -230,7 +230,7 @@ public class WireFeedOutput {
* don't match.
* @throws IOException thrown if there was some problem writing to the Writer.
* @throws FeedException thrown if the XML representation for the feed could not be created.
*
*
*/
public void output(final WireFeed feed, final Writer writer, final boolean prettyPrint) throws IllegalArgumentException, IOException, FeedException {
final Document doc = outputJDom(feed);
@ -255,14 +255,14 @@ public class WireFeedOutput {
* <p>
* NOTE: This method delages to the 'Document WireFeedOutput#outputJDom(WireFeed)'.
* <p>
*
*
* @param feed Abstract feed to create W3C DOM document from. The type of the WireFeed must
* match the type given to the FeedOuptut constructor.
* @return the W3C DOM document for the given WireFeed.
* @throws IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed
* don't match.
* @throws FeedException thrown if the W3C DOM document for the feed could not be created.
*
*
*/
public org.w3c.dom.Document outputW3CDom(final WireFeed feed) throws IllegalArgumentException, FeedException {
final Document doc = outputJDom(feed);
@ -281,14 +281,14 @@ public class WireFeedOutput {
* <p>
* NOTE: All other output methods delegate to this method.
* <p>
*
*
* @param feed Abstract feed to create JDOM document from. The type of the WireFeed must match
* the type given to the FeedOuptut constructor.
* @return the JDOM document for the given WireFeed.
* @throws IllegalArgumentException thrown if the feed type of the WireFeedOutput and WireFeed
* don't match.
* @throws FeedException thrown if the JDOM document for the feed could not be created.
*
*
*/
public Document outputJDom(final WireFeed feed) throws IllegalArgumentException, FeedException {
final String type = feed.getFeedType();

16
src/main/java/com/sun/syndication/io/WireFeedParser.java
View file

@ -29,20 +29,20 @@ import com.sun.syndication.feed.WireFeed;
* <p>
* TODO: explain how developers can plugin their own implementations.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public interface WireFeedParser {
/**
* Returns the type of feed the parser handles.
* <p>
*
*
* @see WireFeed for details on the format of this string.
* <p>
* @return the type of feed the parser handles.
*
*
*/
public String getType();
@ -51,23 +51,23 @@ public interface WireFeedParser {
* <p>
* It checks if the given document if the type of feeds the parser understands.
* <p>
*
*
* @param document XML Document (JDOM) to check if it can be parsed by this parser.
* @return <b>true</b> if the parser know how to parser this feed, <b>false</b> otherwise.
*
*
*/
public boolean isMyType(Document document);
/**
* Parses an XML document (JDOM Document) into a feed bean.
* <p>
*
*
* @param document XML document (JDOM) to parse.
* @param validate indicates if the feed should be strictly validated (NOT YET IMPLEMENTED).
* @return the resulting feed bean.
* @throws IllegalArgumentException thrown if the parser cannot handle the given feed type.
* @throws FeedException thrown if a feed bean cannot be created out of the XML document (JDOM).
*
*
*/
public WireFeed parse(Document document, boolean validate, final Locale locale) throws IllegalArgumentException, FeedException;

166
src/main/java/com/sun/syndication/io/XmlReader.java
View file

@ -34,22 +34,29 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Character stream that handles (or at least attemtps to) all the necessary Voodo to figure out the charset encoding of the XML document within the stream.
* Character stream that handles (or at least attemtps to) all the necessary Voodo to figure out the
* charset encoding of the XML document within the stream.
* <p>
* IMPORTANT: This class is not related in any way to the org.xml.sax.XMLReader. This one IS a character stream.
* IMPORTANT: This class is not related in any way to the org.xml.sax.XMLReader. This one IS a
* character stream.
* <p>
* All this has to be done without consuming characters from the stream, if not the XML parser will not recognized the document as a valid XML. This is not 100%
* true, but it's close enough (UTF-8 BOM is not handled by all parsers right now, XmlReader handles it and things work in all parsers).
* All this has to be done without consuming characters from the stream, if not the XML parser will
* not recognized the document as a valid XML. This is not 100% true, but it's close enough (UTF-8
* BOM is not handled by all parsers right now, XmlReader handles it and things work in all
* parsers).
* <p>
* The XmlReader class handles the charset encoding of XML documents in Files, raw streams and HTTP streams by offering a wide set of constructors.
* The XmlReader class handles the charset encoding of XML documents in Files, raw streams and HTTP
* streams by offering a wide set of constructors.
* <P>
* By default the charset encoding detection is lenient, the constructor with the lenient flag can be used for an script (following HTTP MIME and XML
* specifications). All this is nicely explained by Mark Pilgrim in his blog, <a href="http://diveintomark.org/archives/2004/02/13/xml-media-types"> Determining
* the character encoding of a feed</a>.
* By default the charset encoding detection is lenient, the constructor with the lenient flag can
* be used for an script (following HTTP MIME and XML specifications). All this is nicely explained
* by Mark Pilgrim in his blog, <a
* href="http://diveintomark.org/archives/2004/02/13/xml-media-types"> Determining the character
* encoding of a feed</a>.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class XmlReader extends Reader {
@ -80,14 +87,16 @@ public class XmlReader extends Reader {
/**
* Creates a Reader for a File.
* <p>
* It looks for the UTF-8 BOM first, if none sniffs the XML prolog charset, if this is also missing defaults to UTF-8.
* It looks for the UTF-8 BOM first, if none sniffs the XML prolog charset, if this is also
* missing defaults to UTF-8.
* <p>
* It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
* It does a lenient charset encoding detection, check the constructor with the lenient
* parameter for details.
* <p>
*
*
* @param file File to create a Reader from.
* @throws IOException thrown if there is a problem reading the file.
*
*
*/
public XmlReader(final File file) throws IOException {
this(new FileInputStream(file));
@ -98,25 +107,29 @@ public class XmlReader extends Reader {
* <p>
* It follows the same logic used for files.
* <p>
* It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
* It does a lenient charset encoding detection, check the constructor with the lenient
* parameter for details.
* <p>
*
*
* @param is InputStream to create a Reader from.
* @throws IOException thrown if there is a problem reading the stream.
*
*
*/
public XmlReader(final InputStream is) throws IOException {
this(is, true);
}
/**
* Creates a Reader for a raw InputStream and uses the provided default encoding if none is determined.
* Creates a Reader for a raw InputStream and uses the provided default encoding if none is
* determined.
* <p>
* It follows the same logic used for files.
* <p>
* If lenient detection is indicated and the detection above fails as per specifications it then attempts the following:
* If lenient detection is indicated and the detection above fails as per specifications it then
* attempts the following:
* <p>
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection
* again.
* <p>
* Else if the XML prolog had a charset encoding that encoding is used.
* <p>
@ -126,13 +139,14 @@ public class XmlReader extends Reader {
* <p>
* If lenient detection is indicated an XmlReaderException is never thrown.
* <p>
*
*
* @param is InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection should be relaxed.
* @param defaultEncoding default encoding to use if one cannot be detected.
* @throws IOException thrown if there is a problem reading the stream.
* @throws XmlReaderException thrown if the charset encoding could not be determined according to the specs.
*
* @throws XmlReaderException thrown if the charset encoding could not be determined according
* to the specs.
*
*/
public XmlReader(final InputStream is, final boolean lenient, final String defaultEncoding) throws IOException, XmlReaderException {
if (defaultEncoding == null) {
@ -156,9 +170,11 @@ public class XmlReader extends Reader {
* <p>
* It follows the same logic used for files.
* <p>
* If lenient detection is indicated and the detection above fails as per specifications it then attempts the following:
* If lenient detection is indicated and the detection above fails as per specifications it then
* attempts the following:
* <p>
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection
* again.
* <p>
* Else if the XML prolog had a charset encoding that encoding is used.
* <p>
@ -168,12 +184,13 @@ public class XmlReader extends Reader {
* <p>
* If lenient detection is indicated an XmlReaderException is never thrown.
* <p>
*
*
* @param is InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection should be relaxed.
* @throws IOException thrown if there is a problem reading the stream.
* @throws XmlReaderException thrown if the charset encoding could not be determined according to the specs.
*
* @throws XmlReaderException thrown if the charset encoding could not be determined according
* to the specs.
*
*/
public XmlReader(final InputStream is, final boolean lenient) throws IOException, XmlReaderException {
this(is, lenient, null);
@ -182,16 +199,19 @@ public class XmlReader extends Reader {
/**
* Creates a Reader using the InputStream of a URL.
* <p>
* If the URL is not of type HTTP and there is not 'content-type' header in the fetched data it uses the same logic used for Files.
* If the URL is not of type HTTP and there is not 'content-type' header in the fetched data it
* uses the same logic used for Files.
* <p>
* If the URL is a HTTP Url or there is a 'content-type' header in the fetched data it uses the same logic used for an InputStream with content-type.
* If the URL is a HTTP Url or there is a 'content-type' header in the fetched data it uses the
* same logic used for an InputStream with content-type.
* <p>
* It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
* It does a lenient charset encoding detection, check the constructor with the lenient
* parameter for details.
* <p>
*
*
* @param url URL to create a Reader from.
* @throws IOException thrown if there is a problem reading the stream of the URL.
*
*
*/
public XmlReader(final URL url) throws IOException {
this(url.openConnection());
@ -200,17 +220,19 @@ public class XmlReader extends Reader {
/**
* Creates a Reader using the InputStream of a URLConnection.
* <p>
* If the URLConnection is not of type HttpURLConnection and there is not 'content-type' header in the fetched data it uses the same logic used for files.
* If the URLConnection is not of type HttpURLConnection and there is not 'content-type' header
* in the fetched data it uses the same logic used for files.
* <p>
* If the URLConnection is a HTTP Url or there is a 'content-type' header in the fetched data it uses the same logic used for an InputStream with
* content-type.
* If the URLConnection is a HTTP Url or there is a 'content-type' header in the fetched data it
* uses the same logic used for an InputStream with content-type.
* <p>
* It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
* It does a lenient charset encoding detection, check the constructor with the lenient
* parameter for details.
* <p>
*
*
* @param conn URLConnection to create a Reader from.
* @throws IOException thrown if there is a problem reading the stream of the URLConnection.
*
*
*/
public XmlReader(final URLConnection conn) throws IOException {
defaultEncoding = staticDefaultEncoding;
@ -245,16 +267,18 @@ public class XmlReader extends Reader {
/**
* Creates a Reader using an InputStream and the associated content-type header.
* <p>
* First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not content-type encoding checks the XML prolog
* encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type.
* First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
* If there is not content-type encoding checks the XML prolog encoding. If there is not XML
* prolog encoding uses the default encoding mandated by the content-type MIME type.
* <p>
* It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
* It does a lenient charset encoding detection, check the constructor with the lenient
* parameter for details.
* <p>
*
*
* @param is InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of the charset encoding.
* @throws IOException thrown if there is a problem reading the file.
*
*
*/
public XmlReader(final InputStream is, final String httpContentType) throws IOException {
this(is, httpContentType, true);
@ -263,12 +287,15 @@ public class XmlReader extends Reader {
/**
* Creates a Reader using an InputStream and the associated content-type header.
* <p>
* First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not content-type encoding checks the XML prolog
* encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type.
* First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
* If there is not content-type encoding checks the XML prolog encoding. If there is not XML
* prolog encoding uses the default encoding mandated by the content-type MIME type.
* <p>
* If lenient detection is indicated and the detection above fails as per specifications it then attempts the following:
* If lenient detection is indicated and the detection above fails as per specifications it then
* attempts the following:
* <p>
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection
* again.
* <p>
* Else if the XML prolog had a charset encoding that encoding is used.
* <p>
@ -278,14 +305,15 @@ public class XmlReader extends Reader {
* <p>
* If lenient detection is indicated and XmlReaderException is never thrown.
* <p>
*
*
* @param is InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of the charset encoding.
* @param lenient indicates if the charset encoding detection should be relaxed.
* @param defaultEncoding default encoding to use if one cannot be detected.
* @throws IOException thrown if there is a problem reading the file.
* @throws XmlReaderException thrown if the charset encoding could not be determined according to the specs.
*
* @throws XmlReaderException thrown if the charset encoding could not be determined according
* to the specs.
*
*/
public XmlReader(final InputStream is, final String httpContentType, final boolean lenient, final String defaultEncoding) throws IOException,
XmlReaderException {
@ -308,12 +336,15 @@ public class XmlReader extends Reader {
/**
* Creates a Reader using an InputStream and the associated content-type header.
* <p>
* First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not content-type encoding checks the XML prolog
* encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type.
* First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
* If there is not content-type encoding checks the XML prolog encoding. If there is not XML
* prolog encoding uses the default encoding mandated by the content-type MIME type.
* <p>
* If lenient detection is indicated and the detection above fails as per specifications it then attempts the following:
* If lenient detection is indicated and the detection above fails as per specifications it then
* attempts the following:
* <p>
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
* If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection
* again.
* <p>
* Else if the XML prolog had a charset encoding that encoding is used.
* <p>
@ -323,24 +354,26 @@ public class XmlReader extends Reader {
* <p>
* If lenient detection is indicated and XmlReaderException is never thrown.
* <p>
*
*
* @param is InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of the charset encoding.
* @param lenient indicates if the charset encoding detection should be relaxed.
* @throws IOException thrown if there is a problem reading the file.
* @throws XmlReaderException thrown if the charset encoding could not be determined according to the specs.
*
* @throws XmlReaderException thrown if the charset encoding could not be determined according
* to the specs.
*
*/
public XmlReader(final InputStream is, final String httpContentType, final boolean lenient) throws IOException, XmlReaderException {
this(is, httpContentType, lenient, null);
}
/**
* Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.
* Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the
* rules based on content-type are not adequate.
* <p/>
* If it is NULL the content-type based rules are used.
* <p/>
*
*
* @return the default encoding to use.
*/
public static String getDefaultEncoding() {
@ -348,13 +381,14 @@ public class XmlReader extends Reader {
}
/**
* Sets the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.
* Sets the default encoding to use if none is set in HTTP content-type, XML prolog and the
* rules based on content-type are not adequate.
* <p/>
* If it is set to NULL the content-type based rules are used.
* <p/>
* By default it is NULL.
* <p/>
*
*
* @param encoding charset encoding to default to.
*/
public static void setDefaultEncoding(final String encoding) {
@ -364,9 +398,9 @@ public class XmlReader extends Reader {
/**
* Returns the charset encoding of the XmlReader.
* <p>
*
*
* @return charset encoding.
*
*
*/
public String getEncoding() {
return encoding;
@ -409,9 +443,9 @@ public class XmlReader extends Reader {
/**
* Closes the XmlReader stream.
* <p>
*
*
* @throws IOException thrown if there was a problem closing the stream.
*
*
*/
@Override
public void close() throws IOException {

36
src/main/java/com/sun/syndication/io/XmlReaderException.java
View file

@ -11,9 +11,9 @@ import java.io.InputStream;
* processing with the stream. Note that the original InputStream given to the XmlReader cannot be
* used as that one has been already read.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class XmlReaderException extends IOException {
private static final long serialVersionUID = 1L;
@ -29,13 +29,13 @@ public class XmlReaderException extends IOException {
* <p>
* Instances of this exception are thrown by the XmlReader.
* <p>
*
*
* @param msg message describing the reason for the exception.
* @param bomEnc BOM encoding.
* @param xmlGuessEnc XML guess encoding.
* @param xmlEnc XML prolog encoding.
* @param is the unconsumed InputStream.
*
*
*/
public XmlReaderException(final String msg, final String bomEnc, final String xmlGuessEnc, final String xmlEnc, final InputStream is) {
this(msg, null, null, bomEnc, xmlGuessEnc, xmlEnc, is);
@ -46,7 +46,7 @@ public class XmlReaderException extends IOException {
* <p>
* Instances of this exception are thrown by the XmlReader.
* <p>
*
*
* @param msg message describing the reason for the exception.
* @param ctMime MIME type in the content-type.
* @param ctEnc encoding in the content-type.
@ -54,7 +54,7 @@ public class XmlReaderException extends IOException {
* @param xmlGuessEnc XML guess encoding.
* @param xmlEnc XML prolog encoding.
* @param is the unconsumed InputStream.
*
*
*/
public XmlReaderException(final String msg, final String ctMime, final String ctEnc, final String bomEnc, final String xmlGuessEnc, final String xmlEnc,
final InputStream is) {
@ -70,9 +70,9 @@ public class XmlReaderException extends IOException {
/**
* Returns the BOM encoding found in the InputStream.
* <p>
*
*
* @return the BOM encoding, null if none.
*
*
*/
public String getBomEncoding() {
return bomEncoding;
@ -81,9 +81,9 @@ public class XmlReaderException extends IOException {
/**
* Returns the encoding guess based on the first bytes of the InputStream.
* <p>
*
*
* @return the encoding guess, null if it couldn't be guessed.
*
*
*/
public String getXmlGuessEncoding() {
return xmlGuessEncoding;
@ -92,9 +92,9 @@ public class XmlReaderException extends IOException {
/**
* Returns the encoding found in the XML prolog of the InputStream.
* <p>
*
*
* @return the encoding of the XML prolog, null if none.
*
*
*/
public String getXmlEncoding() {
return xmlEncoding;
@ -103,10 +103,10 @@ public class XmlReaderException extends IOException {
/**
* Returns the MIME type in the content-type used to attempt determining the encoding.
* <p>
*
*
* @return the MIME type in the content-type, null if there was not content-type or the encoding
* detection did not involve HTTP.
*
*
*/
public String getContentTypeMime() {
return contentTypeMime;
@ -115,10 +115,10 @@ public class XmlReaderException extends IOException {
/**
* Returns the encoding in the content-type used to attempt determining the encoding.
* <p>
*
*
* @return the encoding in the content-type, null if there was not content-type, no encoding in
* it or the encoding detection did not involve HTTP.
*
*
*/
public String getContentTypeEncoding() {
return contentTypeEncoding;
@ -128,9 +128,9 @@ public class XmlReaderException extends IOException {
* Returns the unconsumed InputStream to allow the application to do an alternate encoding
* detection on the InputStream.
* <p>
*
*
* @return the unconsumed InputStream.
*
*
*/
public InputStream getInputStream() {
return is;

2
src/main/java/com/sun/syndication/io/impl/Atom10Parser.java
View file

@ -689,7 +689,7 @@ public class Atom10Parser extends BaseWireFeedParser {
* Parse entry from reader.
*/
public static Entry parseEntry(final Reader rd, final String baseURI, final Locale locale) throws JDOMException, IOException, IllegalArgumentException,
FeedException {
FeedException {
// Parse entry into JDOM tree
final SAXBuilder builder = new SAXBuilder();

20
src/main/java/com/sun/syndication/io/impl/Base64.java
View file

@ -20,19 +20,19 @@ package com.sun.syndication.io.impl;
/**
* Encodes/decodes byte arrays and Strings into/from a base 64 String.
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class Base64 {
/**
* Encodes a String into a base 64 String. The resulting encoding is chunked at 76 bytes.
* <p>
*
*
* @param s String to encode.
* @return encoded string.
*
*
*/
public static String encode(String s) {
byte[] sBytes = s.getBytes();
@ -44,12 +44,12 @@ public class Base64 {
/**
* Decodes a base 64 String into a String.
* <p>
*
*
* @param s String to decode.
* @return encoded string.
* @throws java.lang.IllegalArgumentException thrown if the given byte array was not valid
* com.sun.syndication.io.impl.Base64 encoding.
*
*
*/
public static String decode(String s) throws IllegalArgumentException {
s = s.replaceAll("\n", "");
@ -72,10 +72,10 @@ public class Base64 {
/**
* Encodes a byte array into a base 64 byte array.
* <p>
*
*
* @param dData byte array to encode.
* @return encoded byte array.
*
*
*/
public static byte[] encode(final byte[] dData) {
if (dData == null) {
@ -142,12 +142,12 @@ public class Base64 {
/**
* Dencodes a com.sun.syndication.io.impl.Base64 byte array.
* <p>
*
*
* @param eData byte array to decode.
* @return decoded byte array.
* @throws java.lang.IllegalArgumentException thrown if the given byte array was not valid
* com.sun.syndication.io.impl.Base64 encoding.
*
*
*/
public static byte[] decode(final byte[] eData) {
if (eData == null) {

38
src/main/java/com/sun/syndication/io/impl/DateParser.java
View file

@ -48,17 +48,17 @@ public class DateParser {
// parse a valid date out of a substring of the full string given the mask so we have to check
// the most complete format first, then it fails with exception
private static final String[] W3CDATETIME_MASKS = { "yyyy-MM-dd'T'HH:mm:ss.SSSz", "yyyy-MM-dd't'HH:mm:ss.SSSz", "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"yyyy-MM-dd't'HH:mm:ss.SSS'z'", "yyyy-MM-dd'T'HH:mm:ssz", "yyyy-MM-dd't'HH:mm:ssz", "yyyy-MM-dd'T'HH:mm:ssZ", "yyyy-MM-dd't'HH:mm:ssZ",
"yyyy-MM-dd'T'HH:mm:ss'Z'", "yyyy-MM-dd't'HH:mm:ss'z'", "yyyy-MM-dd'T'HH:mmz", // together
// with
// logic
// in
// the
// parseW3CDateTime
// they
"yyyy-MM'T'HH:mmz", // handle W3C dates without time forcing them to
// be GMT
"yyyy'T'HH:mmz", "yyyy-MM-dd't'HH:mmz", "yyyy-MM-dd'T'HH:mm'Z'", "yyyy-MM-dd't'HH:mm'z'", "yyyy-MM-dd", "yyyy-MM", "yyyy" };
"yyyy-MM-dd't'HH:mm:ss.SSS'z'", "yyyy-MM-dd'T'HH:mm:ssz", "yyyy-MM-dd't'HH:mm:ssz", "yyyy-MM-dd'T'HH:mm:ssZ", "yyyy-MM-dd't'HH:mm:ssZ",
"yyyy-MM-dd'T'HH:mm:ss'Z'", "yyyy-MM-dd't'HH:mm:ss'z'", "yyyy-MM-dd'T'HH:mmz", // together
// with
// logic
// in
// the
// parseW3CDateTime
// they
"yyyy-MM'T'HH:mmz", // handle W3C dates without time forcing them to
// be GMT
"yyyy'T'HH:mmz", "yyyy-MM-dd't'HH:mmz", "yyyy-MM-dd'T'HH:mm'Z'", "yyyy-MM-dd't'HH:mm'z'", "yyyy-MM-dd", "yyyy-MM", "yyyy" };
/**
* The masks used to validate and parse the input to this Atom date. These are a lot more
@ -67,14 +67,14 @@ public class DateParser {
*/
@SuppressWarnings("unused")
private static final String[] masks = { "yyyy-MM-dd'T'HH:mm:ss.SSSz", "yyyy-MM-dd't'HH:mm:ss.SSSz", // invalid
"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "yyyy-MM-dd't'HH:mm:ss.SSS'z'", // invalid
"yyyy-MM-dd'T'HH:mm:ssz", "yyyy-MM-dd't'HH:mm:ssz", // invalid
"yyyy-MM-dd'T'HH:mm:ss'Z'", "yyyy-MM-dd't'HH:mm:ss'z'", // invalid
"yyyy-MM-dd'T'HH:mmz", // invalid
"yyyy-MM-dd't'HH:mmz", // invalid
"yyyy-MM-dd'T'HH:mm'Z'", // invalid
"yyyy-MM-dd't'HH:mm'z'", // invalid
"yyyy-MM-dd", "yyyy-MM", "yyyy" };
"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "yyyy-MM-dd't'HH:mm:ss.SSS'z'", // invalid
"yyyy-MM-dd'T'HH:mm:ssz", "yyyy-MM-dd't'HH:mm:ssz", // invalid
"yyyy-MM-dd'T'HH:mm:ss'Z'", "yyyy-MM-dd't'HH:mm:ss'z'", // invalid
"yyyy-MM-dd'T'HH:mmz", // invalid
"yyyy-MM-dd't'HH:mmz", // invalid
"yyyy-MM-dd'T'HH:mm'Z'", // invalid
"yyyy-MM-dd't'HH:mm'z'", // invalid
"yyyy-MM-dd", "yyyy-MM", "yyyy" };
static {
ADDITIONAL_MASKS = PropertiesLoader.getPropertiesLoader().getTokenizedProperty("datetime.extra.masks", "|");

6
src/main/java/com/sun/syndication/io/impl/FeedGenerators.java
View file

@ -30,15 +30,15 @@ import com.sun.syndication.io.WireFeedGenerator;
* Generators for a specific type must extend this class and register in the generator list. (Right
* now registration is hardcoded in the WireFeedGenerator constructor).
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class FeedGenerators extends PluginManager<WireFeedGenerator> {
/**
* WireFeedGenerator.classes= [className] ...
*
*
*/
public static final String FEED_GENERATORS_KEY = "WireFeedGenerator.classes";

12
src/main/java/com/sun/syndication/io/impl/NumberParser.java
View file

@ -2,7 +2,7 @@ package com.sun.syndication.io.impl;
/**
* A helper class that parses Numbers out of Strings in a lenient manner.
*
*
* <p>
* No method will throw any sort of Exception when parsing a string. All methods accept any Java
* String or null as legal input, if the input is non null, whitespace will be trimmed first, and
@ -19,7 +19,7 @@ public final class NumberParser {
/**
* Parses a Long out of a string.
*
*
* @param str string to parse for a Long.
* @return the Long represented by the given string, It returns <b>null</b> if it was not
* possible to parse the the string.
@ -38,7 +38,7 @@ public final class NumberParser {
/**
* Parse an Integer from a String. If the String is not an integer <b>null</b> is returned and
* no exception is thrown.
*
*
* @param str the String to parse
* @return The Integer represented by the String, or null if it could not be parsed.
*/
@ -56,7 +56,7 @@ public final class NumberParser {
/**
* Parse a Float from a String without exceptions. If the String is not a Float then null is
* returned
*
*
* @param str the String to parse
* @return The Float represented by the String, or null if it could not be parsed.
*/
@ -73,7 +73,7 @@ public final class NumberParser {
/**
* Parse a float from a String, with a default value
*
*
* @param str
* @param def the value to return if the String cannot be parsed
* @return
@ -89,7 +89,7 @@ public final class NumberParser {
/**
* Parses a long out of a string.
*
*
* @param str string to parse for a long.
* @param def default value to return if it is not possible to parse the the string.
* @return the long represented by the given string, or the default.

20
src/main/java/com/sun/syndication/io/impl/PropertiesLoader.java
View file

@ -25,9 +25,9 @@ import com.sun.syndication.feed.impl.ConfigurableClassLoader;
* date formats) assume properties are list of tokens, that why the only method to get property
* values is the getTokenizedProperty().
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class PropertiesLoader {
@ -38,9 +38,9 @@ public class PropertiesLoader {
/**
* Returns the PropertiesLoader singleton used by ROME to load plugin components.
*
*
* @return PropertiesLoader singleton.
*
*
*/
public static PropertiesLoader getPropertiesLoader() {
synchronized (PropertiesLoader.class) {
@ -63,11 +63,11 @@ public class PropertiesLoader {
/**
* Creates a PropertiesLoader.
* <p>
*
*
* @param masterFileLocation master file location, there must be only one.
* @param extraFileLocation extra file location, there may be many.
* @throws IOException thrown if one of the properties file could not be read.
*
*
*/
private PropertiesLoader(final String masterFileLocation, final String extraFileLocation) throws IOException {
final List<Properties> propertiesList = new ArrayList<Properties>();
@ -109,12 +109,12 @@ public class PropertiesLoader {
* Returns an array of tokenized values stored under a property key in all properties files. If
* the master file has this property its tokens will be the first ones in the array.
* <p>
*
*
* @param key property key to retrieve values
* @param separator String with all separator characters to tokenize from the values in all
* properties files.
* @return all the tokens for the given property key from all the properties files.
*
*
*/
public String[] getTokenizedProperty(final String key, final String separator) {
final List<String> entriesList = new ArrayList<String>();
@ -137,10 +137,10 @@ public class PropertiesLoader {
* Returns an array of values stored under a property key in all properties files. If the master
* file has this property it will be the first ones in the array.
* <p>
*
*
* @param key property key to retrieve values
* @return all the values for the given property key from all the properties files.
*
*
*/
public String[] getProperty(final String key) {
final List<String> entriesList = new ArrayList<String>();

4
src/main/java/com/sun/syndication/io/impl/RSS090Generator.java
View file

@ -32,7 +32,7 @@ import com.sun.syndication.io.FeedException;
/**
* Feed Generator for RSS 0.90
* <p/>
*
*
* @author Elaine Chien
*/
public class RSS090Generator extends BaseWireFeedGenerator {
@ -106,7 +106,7 @@ public class RSS090Generator extends BaseWireFeedGenerator {
/**
* Populates the given channel with parsed data from the ROME element that holds the channel
* data.
*
*
* @param channel the channel into which parsed data will be added.
* @param eChannel the XML element that holds the data for the channel.
*/

4
src/main/java/com/sun/syndication/io/impl/RSS091NetscapeGenerator.java
View file

@ -23,9 +23,9 @@ import org.jdom2.Element;
/**
* Feed Generator for RSS 0.91
* <p/>
*
*
* @author Elaine Chien
*
*
*/
public class RSS091NetscapeGenerator extends RSS091UserlandGenerator {

4
src/main/java/com/sun/syndication/io/impl/RSS093Generator.java
View file

@ -28,9 +28,9 @@ import com.sun.syndication.feed.rss.Item;
/**
* Feed Generator for RSS 0.93
* <p/>
*
*
* @author Elaine Chien
*
*
*/
public class RSS093Generator extends RSS092Generator {

4
src/main/java/com/sun/syndication/io/impl/RSS094Generator.java
View file

@ -25,9 +25,9 @@ import com.sun.syndication.feed.rss.Item;
/**
* Feed Generator for RSS 0.94
* <p/>
*
*
* @author Elaine Chien
*
*
*/
public class RSS094Generator extends RSS093Generator {

6
src/test/java/com/sun/syndication/unittest/FeedOpsTest.java
View file

@ -10,11 +10,11 @@ import com.sun.syndication.feed.synd.SyndFeed;
import com.sun.syndication.feed.synd.SyndFeedImpl;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public abstract class FeedOpsTest extends FeedTest {

2
src/test/java/com/sun/syndication/unittest/FeedTest.java
View file

@ -18,7 +18,7 @@ import com.sun.syndication.io.WireFeedInput;
/**
* @author pat, tucu
*
*
*/
public abstract class FeedTest extends TestCase {
private final String feedFileName;

6
src/test/java/com/sun/syndication/unittest/TestDateParser.java
View file

@ -27,11 +27,11 @@ import junit.framework.TestCase;
import com.sun.syndication.io.impl.DateParser;
/**
*
*
* Start of tests for DateParser
*
*
* @author Nick Lothian
*
*
*/
public class TestDateParser extends TestCase {
public void testParse() {

6
src/test/java/com/sun/syndication/unittest/TestOpsAtom03.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsAtom03 extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsAtom10.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Dave Johnson
*
*
*/
public class TestOpsAtom10 extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS090.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS090 extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS091N.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS091N extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS091U.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS091U extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS092.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS092 extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS093.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS093 extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS094.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS094 extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS10.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS10 extends FeedOpsTest {

6
src/test/java/com/sun/syndication/unittest/TestOpsRSS20.java
View file

@ -1,11 +1,11 @@
package com.sun.syndication.unittest;
/**
*
*
* <p>
*
*
* @author Alejandro Abdelnur
*
*
*/
public class TestOpsRSS20 extends FeedOpsTest {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedAtom03.java
View file

@ -13,7 +13,7 @@ import com.sun.syndication.io.impl.DateParser;
/**
* @author pat
*
*
*/
public class TestSyndFeedAtom03 extends SyndFeedTest {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedAtom03DCSyModules.java
View file

@ -73,7 +73,7 @@ public class TestSyndFeedAtom03DCSyModules extends TestSyndFeedAtom03 {
assertProperty(dc.getRights(), prefix + "dc:rights");
} else {
assertProperty(dc.getRights(), prefix + "copyright"); // in
// header
// header
// is
// convenience
// method

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedAtom10.java
View file

@ -16,7 +16,7 @@ import com.sun.syndication.io.impl.DateParser;
/**
* @author pat
* @author Dave Johnson (modified for Atom 1.0)
*
*
*/
public class TestSyndFeedAtom10 extends TestSyndFeedAtom03 {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS090.java
View file

@ -10,7 +10,7 @@ import com.sun.syndication.feed.synd.SyndEntry;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS090 extends SyndFeedTest {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS091N.java
View file

@ -13,7 +13,7 @@ import com.sun.syndication.io.impl.DateParser;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS091N extends SyndFeedTest {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS091U.java
View file

@ -6,7 +6,7 @@ package com.sun.syndication.unittest;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS091U extends TestSyndFeedRSS091N {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS092.java
View file

@ -14,7 +14,7 @@ import com.sun.syndication.feed.synd.SyndEntry;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS092 extends TestSyndFeedRSS091N {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS093.java
View file

@ -13,7 +13,7 @@ import com.sun.syndication.io.impl.DateParser;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS093 extends TestSyndFeedRSS092 {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS094.java
View file

@ -10,7 +10,7 @@ import com.sun.syndication.feed.synd.SyndEntry;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS094 extends TestSyndFeedRSS093 {
public TestSyndFeedRSS094() {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS10.java
View file

@ -10,7 +10,7 @@ import com.sun.syndication.feed.synd.SyndEntry;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS10 extends TestSyndFeedRSS090 {

2
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS10DCMulti.java
View file

@ -11,7 +11,7 @@ import com.sun.syndication.io.impl.DateParser;
/**
* Test case for the multi-valued DublinCore module elements.
* <p>
*
*
* @author Paul Dlug
*/
public class TestSyndFeedRSS10DCMulti extends TestSyndFeedRSS10 {

4
src/test/java/com/sun/syndication/unittest/TestSyndFeedRSS20.java
View file

@ -13,7 +13,7 @@ import com.sun.syndication.feed.synd.SyndEntry;
/**
* @author pat
*
*
*/
public class TestSyndFeedRSS20 extends TestSyndFeedRSS094 {
@ -39,7 +39,7 @@ public class TestSyndFeedRSS20 extends TestSyndFeedRSS094 {
/**
* Test we can get to RSS attributes which aren't exposed in the SyndEntry object
*
*
* @throws Exception
*/
public void testPreservedWireItems() throws Exception {

2
src/test/java/com/sun/syndication/unittest/TestXmlFixerReader.java
View file

@ -35,7 +35,7 @@ import com.sun.syndication.io.impl.XmlFixerReader;
/**
* @author pat, tucu
*
*
*/
public class TestXmlFixerReader extends TestCase {
private static final String XML_PROLOG = "<?xml version=\"1.0\" ?>";

4
src/test/java/com/sun/syndication/unittest/TestXmlReader.java
View file

@ -32,7 +32,7 @@ import com.sun.syndication.io.XmlReader;
/**
* @author pat, tucu
*
*
*/
public class TestXmlReader extends TestCase {
private static final String XML5 = "xml-prolog-encoding-spaced-single-quotes";
@ -317,7 +317,7 @@ public class TestXmlReader extends TestCase {
}
/**
*
*
* @param bomType no-bom, UTF-16BE-bom, UTF-16LE-bom, UTF-8-bom
* @param xmlType xml, xml-prolog, xml-prolog-charset
* @return XML stream

4
src/test/java/com/sun/syndication/unittest/issues/Issue131Test.java
View file

@ -11,9 +11,9 @@ import com.sun.syndication.unittest.FeedTest;
/**
* Test for #131: SyndFeedImpl copyFrom method does not copy Entry Categories.
*
*
* @author Martin Kurz
*
*
*/
public class Issue131Test extends FeedTest {

4
src/test/java/com/sun/syndication/unittest/issues/Issue134Test.java
View file

@ -5,9 +5,9 @@ import com.sun.syndication.unittest.FeedTest;
/**
* Test for #134: Incorrect handling of CDATA sections.
*
*
* @author Martin Kurz
*
*
*/
public class Issue134Test extends FeedTest {

4
src/test/java/com/sun/syndication/unittest/issues/Issue137Test.java
View file

@ -5,9 +5,9 @@ import com.sun.syndication.unittest.FeedTest;
/**
* Test for #137: RSS item description is not complete.
*
*
* @author Martin Kurz
*
*
*/
public class Issue137Test extends FeedTest {

4
src/test/java/com/sun/syndication/unittest/issues/Issue158Test.java
View file

@ -4,9 +4,9 @@ import com.sun.syndication.unittest.FeedTest;
/**
* Test for #161: No source element in RSS 2.0 items.
*
*
* @author Martin Kurz
*
*
*/
public class Issue158Test extends FeedTest {

4
src/test/java/com/sun/syndication/unittest/issues/Issue161Test.java
View file

@ -7,9 +7,9 @@ import com.sun.syndication.unittest.TestSyndFeedRSS20;
/**
* Test for #161: No source element in RSS 2.0 items.
*
*
* @author Martin Kurz
*
*
*/
public class Issue161Test extends TestSyndFeedRSS20 {

4
src/test/java/com/sun/syndication/unittest/issues/Issue162Test.java
View file

@ -10,9 +10,9 @@ import com.sun.syndication.unittest.TestSyndFeedRSS20;
/**
* Test for #161: No source element in RSS 2.0 items.
*
*
* @author Martin Kurz
*
*
*/
public class Issue162Test extends TestSyndFeedRSS20 {

2
src/test/java/com/sun/syndication/unittest/issues/Issue1Test.java
View file

@ -33,7 +33,7 @@ import com.sun.syndication.io.impl.XmlFixerReader;
import com.sun.syndication.unittest.SyndFeedTest;
/**
*
*
* @author robert.cooper
*/
public class Issue1Test extends SyndFeedTest {

8
src/test/java/com/sun/syndication/unittest/issues/Issue2Test.java
View file

@ -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,7 +23,7 @@ import com.sun.syndication.feed.synd.SyndEntry;
import com.sun.syndication.unittest.TestSyndFeedRSS094;
/**
*
*
* @author robert.cooper
*/
public class Issue2Test extends TestSyndFeedRSS094 {

4
src/test/java/com/sun/syndication/unittest/issues/Issue88Test.java
View file

@ -4,9 +4,9 @@ import com.sun.syndication.unittest.FeedTest;
/**
* Test for #134: Incorrect handling of CDATA sections.
*
*
* @author Martin Kurz
*
*
*/
public class Issue88Test extends FeedTest {