Formatted and cleaned up sources

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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 * 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 * 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 * 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. * 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. * Crimson is one parser which is known not to support these features.
* *
*/ */
public class SAXBuilder extends org.jdom2.input.SAXBuilder { 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 * @deprecated use SAXBuilder(XMLReaderJDOMFactory) with either XMLReaders.DTDVALIDATING or
* XMLReaders.NONVALIDATING * XMLReaders.NONVALIDATING
* @param validate * @param validate

View file

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

View file

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

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

View file

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

View file

@ -34,22 +34,29 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern; 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> * <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> * <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% * All this has to be done without consuming characters from the stream, if not the XML parser will
* 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). * 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> * <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> * <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 * By default the charset encoding detection is lenient, the constructor with the lenient flag can
* 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 * be used for an script (following HTTP MIME and XML specifications). All this is nicely explained
* the character encoding of a feed</a>. * 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> * <p>
* *
* @author Alejandro Abdelnur * @author Alejandro Abdelnur
* *
*/ */
public class XmlReader extends Reader { public class XmlReader extends Reader {
@ -80,14 +87,16 @@ public class XmlReader extends Reader {
/** /**
* Creates a Reader for a File. * Creates a Reader for a File.
* <p> * <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> * <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> * <p>
* *
* @param file File to create a Reader from. * @param file File to create a Reader from.
* @throws IOException thrown if there is a problem reading the file. * @throws IOException thrown if there is a problem reading the file.
* *
*/ */
public XmlReader(final File file) throws IOException { public XmlReader(final File file) throws IOException {
this(new FileInputStream(file)); this(new FileInputStream(file));
@ -98,25 +107,29 @@ public class XmlReader extends Reader {
* <p> * <p>
* It follows the same logic used for files. * It follows the same logic used for files.
* <p> * <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> * <p>
* *
* @param is InputStream to create a Reader from. * @param is InputStream to create a Reader from.
* @throws IOException thrown if there is a problem reading the stream. * @throws IOException thrown if there is a problem reading the stream.
* *
*/ */
public XmlReader(final InputStream is) throws IOException { public XmlReader(final InputStream is) throws IOException {
this(is, true); 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> * <p>
* It follows the same logic used for files. * It follows the same logic used for files.
* <p> * <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> * <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> * <p>
* Else if the XML prolog had a charset encoding that encoding is used. * Else if the XML prolog had a charset encoding that encoding is used.
* <p> * <p>
@ -126,13 +139,14 @@ public class XmlReader extends Reader {
* <p> * <p>
* If lenient detection is indicated an XmlReaderException is never thrown. * If lenient detection is indicated an XmlReaderException is never thrown.
* <p> * <p>
* *
* @param is InputStream to create a Reader from. * @param is InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection should be relaxed. * @param lenient indicates if the charset encoding detection should be relaxed.
* @param defaultEncoding default encoding to use if one cannot be detected. * @param defaultEncoding default encoding to use if one cannot be detected.
* @throws IOException thrown if there is a problem reading the stream. * @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 { public XmlReader(final InputStream is, final boolean lenient, final String defaultEncoding) throws IOException, XmlReaderException {
if (defaultEncoding == null) { if (defaultEncoding == null) {
@ -156,9 +170,11 @@ public class XmlReader extends Reader {
* <p> * <p>
* It follows the same logic used for files. * It follows the same logic used for files.
* <p> * <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> * <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> * <p>
* Else if the XML prolog had a charset encoding that encoding is used. * Else if the XML prolog had a charset encoding that encoding is used.
* <p> * <p>
@ -168,12 +184,13 @@ public class XmlReader extends Reader {
* <p> * <p>
* If lenient detection is indicated an XmlReaderException is never thrown. * If lenient detection is indicated an XmlReaderException is never thrown.
* <p> * <p>
* *
* @param is InputStream to create a Reader from. * @param is InputStream to create a Reader from.
* @param lenient indicates if the charset encoding detection should be relaxed. * @param lenient indicates if the charset encoding detection should be relaxed.
* @throws IOException thrown if there is a problem reading the stream. * @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 { public XmlReader(final InputStream is, final boolean lenient) throws IOException, XmlReaderException {
this(is, lenient, null); this(is, lenient, null);
@ -182,16 +199,19 @@ public class XmlReader extends Reader {
/** /**
* Creates a Reader using the InputStream of a URL. * Creates a Reader using the InputStream of a URL.
* <p> * <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> * <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> * <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> * <p>
* *
* @param url URL to create a Reader from. * @param url URL to create a Reader from.
* @throws IOException thrown if there is a problem reading the stream of the URL. * @throws IOException thrown if there is a problem reading the stream of the URL.
* *
*/ */
public XmlReader(final URL url) throws IOException { public XmlReader(final URL url) throws IOException {
this(url.openConnection()); this(url.openConnection());
@ -200,17 +220,19 @@ public class XmlReader extends Reader {
/** /**
* Creates a Reader using the InputStream of a URLConnection. * Creates a Reader using the InputStream of a URLConnection.
* <p> * <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> * <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 * If the URLConnection is a HTTP Url or there is a 'content-type' header in the fetched data it
* content-type. * uses the same logic used for an InputStream with content-type.
* <p> * <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> * <p>
* *
* @param conn URLConnection to create a Reader from. * @param conn URLConnection to create a Reader from.
* @throws IOException thrown if there is a problem reading the stream of the URLConnection. * @throws IOException thrown if there is a problem reading the stream of the URLConnection.
* *
*/ */
public XmlReader(final URLConnection conn) throws IOException { public XmlReader(final URLConnection conn) throws IOException {
defaultEncoding = staticDefaultEncoding; defaultEncoding = staticDefaultEncoding;
@ -245,16 +267,18 @@ public class XmlReader extends Reader {
/** /**
* Creates a Reader using an InputStream and the associated content-type header. * Creates a Reader using an InputStream and the associated content-type header.
* <p> * <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 * First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
* encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type. * 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> * <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> * <p>
* *
* @param is InputStream to create the reader from. * @param is InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of the charset encoding. * @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. * @throws IOException thrown if there is a problem reading the file.
* *
*/ */
public XmlReader(final InputStream is, final String httpContentType) throws IOException { public XmlReader(final InputStream is, final String httpContentType) throws IOException {
this(is, httpContentType, true); 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. * Creates a Reader using an InputStream and the associated content-type header.
* <p> * <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 * First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
* encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type. * 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> * <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> * <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> * <p>
* Else if the XML prolog had a charset encoding that encoding is used. * Else if the XML prolog had a charset encoding that encoding is used.
* <p> * <p>
@ -278,14 +305,15 @@ public class XmlReader extends Reader {
* <p> * <p>
* If lenient detection is indicated and XmlReaderException is never thrown. * If lenient detection is indicated and XmlReaderException is never thrown.
* <p> * <p>
* *
* @param is InputStream to create the reader from. * @param is InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of the charset encoding. * @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 lenient indicates if the charset encoding detection should be relaxed.
* @param defaultEncoding default encoding to use if one cannot be detected. * @param defaultEncoding default encoding to use if one cannot be detected.
* @throws IOException thrown if there is a problem reading the file. * @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, public XmlReader(final InputStream is, final String httpContentType, final boolean lenient, final String defaultEncoding) throws IOException,
XmlReaderException { XmlReaderException {
@ -308,12 +336,15 @@ public class XmlReader extends Reader {
/** /**
* Creates a Reader using an InputStream and the associated content-type header. * Creates a Reader using an InputStream and the associated content-type header.
* <p> * <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 * First it checks if the stream has BOM. If there is not BOM checks the content-type encoding.
* encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type. * 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> * <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> * <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> * <p>
* Else if the XML prolog had a charset encoding that encoding is used. * Else if the XML prolog had a charset encoding that encoding is used.
* <p> * <p>
@ -323,24 +354,26 @@ public class XmlReader extends Reader {
* <p> * <p>
* If lenient detection is indicated and XmlReaderException is never thrown. * If lenient detection is indicated and XmlReaderException is never thrown.
* <p> * <p>
* *
* @param is InputStream to create the reader from. * @param is InputStream to create the reader from.
* @param httpContentType content-type header to use for the resolution of the charset encoding. * @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 lenient indicates if the charset encoding detection should be relaxed.
* @throws IOException thrown if there is a problem reading the file. * @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 { public XmlReader(final InputStream is, final String httpContentType, final boolean lenient) throws IOException, XmlReaderException {
this(is, httpContentType, lenient, null); 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/> * <p/>
* If it is NULL the content-type based rules are used. * If it is NULL the content-type based rules are used.
* <p/> * <p/>
* *
* @return the default encoding to use. * @return the default encoding to use.
*/ */
public static String getDefaultEncoding() { 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/> * <p/>
* If it is set to NULL the content-type based rules are used. * If it is set to NULL the content-type based rules are used.
* <p/> * <p/>
* By default it is NULL. * By default it is NULL.
* <p/> * <p/>
* *
* @param encoding charset encoding to default to. * @param encoding charset encoding to default to.
*/ */
public static void setDefaultEncoding(final String encoding) { public static void setDefaultEncoding(final String encoding) {
@ -364,9 +398,9 @@ public class XmlReader extends Reader {
/** /**
* Returns the charset encoding of the XmlReader. * Returns the charset encoding of the XmlReader.
* <p> * <p>
* *
* @return charset encoding. * @return charset encoding.
* *
*/ */
public String getEncoding() { public String getEncoding() {
return encoding; return encoding;
@ -409,9 +443,9 @@ public class XmlReader extends Reader {
/** /**
* Closes the XmlReader stream. * Closes the XmlReader stream.
* <p> * <p>
* *
* @throws IOException thrown if there was a problem closing the stream. * @throws IOException thrown if there was a problem closing the stream.
* *
*/ */
@Override @Override
public void close() throws IOException { public void close() throws IOException {

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

View file

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

View file

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

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 // 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 // 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'", 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.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 "yyyy-MM-dd'T'HH:mm:ss'Z'", "yyyy-MM-dd't'HH:mm:ss'z'", "yyyy-MM-dd'T'HH:mmz", // together
// with // with
// logic // logic
// in // in
// the // the
// parseW3CDateTime // parseW3CDateTime
// they // they
"yyyy-MM'T'HH:mmz", // handle W3C dates without time forcing them to "yyyy-MM'T'HH:mmz", // handle W3C dates without time forcing them to
// be GMT // 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'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 * 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") @SuppressWarnings("unused")
private static final String[] masks = { "yyyy-MM-dd'T'HH:mm:ss.SSSz", "yyyy-MM-dd't'HH:mm:ss.SSSz", // invalid 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: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: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: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: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't'HH:mm'z'", // invalid "yyyy-MM-dd't'HH:mm'z'", // invalid
"yyyy-MM-dd", "yyyy-MM", "yyyy" }; "yyyy-MM-dd", "yyyy-MM", "yyyy" };
static { static {
ADDITIONAL_MASKS = PropertiesLoader.getPropertiesLoader().getTokenizedProperty("datetime.extra.masks", "|"); ADDITIONAL_MASKS = PropertiesLoader.getPropertiesLoader().getTokenizedProperty("datetime.extra.masks", "|");

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 * Generators for a specific type must extend this class and register in the generator list. (Right
* now registration is hardcoded in the WireFeedGenerator constructor). * now registration is hardcoded in the WireFeedGenerator constructor).
* <p> * <p>
* *
* @author Alejandro Abdelnur * @author Alejandro Abdelnur
* *
*/ */
public class FeedGenerators extends PluginManager<WireFeedGenerator> { public class FeedGenerators extends PluginManager<WireFeedGenerator> {
/** /**
* WireFeedGenerator.classes= [className] ... * WireFeedGenerator.classes= [className] ...
* *
*/ */
public static final String FEED_GENERATORS_KEY = "WireFeedGenerator.classes"; public static final String FEED_GENERATORS_KEY = "WireFeedGenerator.classes";

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

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -1,12 +1,12 @@
/* /*
* Copyright 2011 robert.cooper. * Copyright 2011 robert.cooper.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * 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; import com.sun.syndication.unittest.TestSyndFeedRSS094;
/** /**
* *
* @author robert.cooper * @author robert.cooper
*/ */
public class Issue2Test extends TestSyndFeedRSS094 { public class Issue2Test extends TestSyndFeedRSS094 {

View file

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