com.sun.syndication.feed.module
Class DCModuleImpl

java.lang.Object
  com.sun.syndication.feed.module.ModuleImpl
      com.sun.syndication.feed.module.DCModuleImpl

All Implemented Interfaces:

CopyFrom, DCModule, Module, Serializable, Cloneable

public class DCModuleImpl
extends ModuleImpl
implements DCModule

Dublin Core ModuleImpl, default implementation.

Author:

Alejandro Abdelnur

See Also:

Dublin Core module., Serialized Form

Field Summary

static Set

CONVENIENCE_PROPERTIES Unmodifiable Set containing the convenience properties of this class.

Fields inherited from interface com.sun.syndication.feed.module.DCModule

URI

Constructor Summary

DCModuleImpl()
Default constructor.

Method Summary

Object	clone() Creates a deep 'bean' clone of the object.
void	copyFrom(CopyFrom obj) Copies all the properties of the given bean into this one.
boolean	equals(Object other) Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
String	getContributor() Gets the DublinCore module contributor.
List	getContributors() Returns the DublinCore module contributor.
String	getCoverage() Gets the DublinCore module coverage.
List	getCoverages() Returns the DublinCore module coverage.
String	getCreator() Gets the DublinCore module title.
List	getCreators() Returns the DublinCore module creator.
Date	getDate() Gets the DublinCore module date.
List<Date>	getDates() Returns the DublinCore module date.
String	getDescription() Gets the DublinCore module description.
List	getDescriptions() Returns the DublinCore module description.
String	getFormat() Gets the DublinCore module format.
List	getFormats() Returns the DublinCore module format.
String	getIdentifier() Gets the DublinCore module identifier.
List	getIdentifiers() Returns the DublinCore module identifier.
Class<? extends CopyFrom>	getInterface() Returns the interface the copyFrom works on.
String	getLanguage() Gets the DublinCore module language.
List	getLanguages() Returns the DublinCore module language.
String	getPublisher() Gets the DublinCore module title.
List	getPublishers() Returns the DublinCore module publisher.
String	getRelation() Gets the DublinCore module relation.
List	getRelations() Returns the DublinCore module relation.
String	getRights() Gets the DublinCore module rights.
List	getRightsList() Returns the DublinCore module rights.
String	getSource() Gets the DublinCore module source.
List	getSources() Returns the DublinCore module source.
DCSubject	getSubject() Gets the DublinCore module subject.
List	getSubjects() Returns the DublinCore module subjects.
String	getTitle() Gets the DublinCore module title.
List	getTitles() Returns the DublinCore module titles.
String	getType() Gets the DublinCore module type.
List	getTypes() Returns the DublinCore module type.
int	hashCode() Returns a hashcode value for the object.
void	setContributor(String contributor) Sets the DublinCore module contributor.
void	setContributors(List contributors) Sets the DublinCore module contributors.
void	setCoverage(String coverage) Sets the DublinCore module coverage.
void	setCoverages(List coverages) Sets the DublinCore module coverages.
void	setCreator(String creator) Sets the DublinCore module creator.
void	setCreators(List creators) Sets the DublinCore module creators.
void	setDate(Date date) Sets the DublinCore module date.
void	setDates(List<Date> dates) Sets the DublinCore module dates.
void	setDescription(String description) Sets the DublinCore module description.
void	setDescriptions(List descriptions) Sets the DublinCore module descriptions.
void	setFormat(String format) Sets the DublinCore module format.
void	setFormats(List formats) Sets the DublinCore module formats.
void	setIdentifier(String identifier) Sets the DublinCore module identifier.
void	setIdentifiers(List identifiers) Sets the DublinCore module identifiers.
void	setLanguage(String language) Sets the DublinCore module language.
void	setLanguages(List languages) Sets the DublinCore module languages.
void	setPublisher(String publisher) Sets the DublinCore module publisher.
void	setPublishers(List publishers) Sets the DublinCore module publishers.
void	setRelation(String relation) Sets the DublinCore module relation.
void	setRelations(List relations) Sets the DublinCore module relations.
void	setRights(String rights) Sets the DublinCore module rights.
void	setRightsList(List rights) Sets the DublinCore module rights.
void	setSource(String source) Sets the DublinCore module source.
void	setSources(List sources) Sets the DublinCore module sources.
void	setSubject(DCSubject subject) Sets the DCSubject element.
void	setSubjects(List subjects) Sets the DublinCore module subjects.
void	setTitle(String title) Sets the DublinCore module title.
void	setTitles(List titles) Sets the DublinCore module titles.
void	setType(String type) Sets the DublinCore module type.
void	setTypes(List types) Sets the DublinCore module types.
String	toString() Returns the String representation for the object.

Methods inherited from class com.sun.syndication.feed.module.ModuleImpl

getUri

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sun.syndication.feed.module.Module

getUri

Field Detail

CONVENIENCE_PROPERTIES

public static final Set CONVENIENCE_PROPERTIES

Unmodifiable Set containing the convenience properties of this class.

Convenience properties are mapped to Modules, for cloning the convenience properties can be ignored as the will be copied as part of the module cloning.

Constructor Detail

DCModuleImpl

public DCModuleImpl()

Default constructor. All properties are set to null.

Method Detail

getTitles

public List getTitles()

Returns the DublinCore module titles.

Specified by:

getTitles in interface DCModule

Returns:

a list of Strings representing the DublinCore module title, an empty list if none.

setTitles

public void setTitles(List titles)

Sets the DublinCore module titles.

Specified by:

setTitles in interface DCModule

Parameters:

titles - the list of String representing the DublinCore module titles to set, an empty list or null if none.

getTitle

public String getTitle()

Gets the DublinCore module title. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getTitle in interface DCModule

Returns:

the first DublinCore module title, null if none.

setTitle

public void setTitle(String title)

Sets the DublinCore module title. Convenience method that can be used when there is only one title to set.

Specified by:

setTitle in interface DCModule

Parameters:

title - the DublinCore module title to set, null if none.

getCreators

public List getCreators()

Returns the DublinCore module creator.

Specified by:

getCreators in interface DCModule

Returns:

a list of Strings representing the DublinCore module creator, an empty list if none.

setCreators

public void setCreators(List creators)

Sets the DublinCore module creators.

Specified by:

setCreators in interface DCModule

Parameters:

creators - the list of String representing the DublinCore module creators to set, an empty list or null if none.

getCreator

public String getCreator()

Gets the DublinCore module title. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getCreator in interface DCModule

Returns:

the first DublinCore module title, null if none.

setCreator

public void setCreator(String creator)

Sets the DublinCore module creator. Convenience method that can be used when there is only one creator to set.

Specified by:

setCreator in interface DCModule

Parameters:

creator - the DublinCore module creator to set, null if none.

getSubjects

public List getSubjects()

Returns the DublinCore module subjects.

Specified by:

getSubjects in interface DCModule

Returns:

a list of DCSubject elements with the DublinCore module subjects, an empty list if none.

setSubjects

public void setSubjects(List subjects)

Sets the DublinCore module subjects.

Specified by:

setSubjects in interface DCModule

Parameters:

subjects - the list of DCSubject elements with the DublinCore module subjects to set, an empty list or null if none.

getSubject

public DCSubject getSubject()

Gets the DublinCore module subject. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getSubject in interface DCModule

Returns:

the first DublinCore module subject, null if none.

setSubject

public void setSubject(DCSubject subject)

Sets the DCSubject element. Convenience method that can be used when there is only one subject to set.

Specified by:

setSubject in interface DCModule

Parameters:

subject - the DublinCore module subject to set, null if none.

getDescriptions

public List getDescriptions()

Returns the DublinCore module description.

Specified by:

getDescriptions in interface DCModule

Returns:

a list of Strings representing the DublinCore module description, an empty list if none.

setDescriptions

public void setDescriptions(List descriptions)

Sets the DublinCore module descriptions.

Specified by:

setDescriptions in interface DCModule

Parameters:

descriptions - the list of String representing the DublinCore module descriptions to set, an empty list or null if none.

getDescription

public String getDescription()

Gets the DublinCore module description. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getDescription in interface DCModule

Returns:

the first DublinCore module description, null if none.

setDescription

public void setDescription(String description)

Sets the DublinCore module description. Convenience method that can be used when there is only one description to set.

Specified by:

setDescription in interface DCModule

Parameters:

description - the DublinCore module description to set, null if none.

getPublishers

public List getPublishers()

Returns the DublinCore module publisher.

Specified by:

getPublishers in interface DCModule

Returns:

a list of Strings representing the DublinCore module publisher, an empty list if none.

setPublishers

public void setPublishers(List publishers)

Sets the DublinCore module publishers.

Specified by:

setPublishers in interface DCModule

Parameters:

publishers - the list of String representing the DublinCore module publishers to set, an empty list or null if none.

getPublisher

public String getPublisher()

Gets the DublinCore module title. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getPublisher in interface DCModule

Returns:

the first DublinCore module title, null if none.

setPublisher

public void setPublisher(String publisher)

Sets the DublinCore module publisher. Convenience method that can be used when there is only one publisher to set.

Specified by:

setPublisher in interface DCModule

Parameters:

publisher - the DublinCore module publisher to set, null if none.

getContributors

public List getContributors()

Returns the DublinCore module contributor.

Specified by:

getContributors in interface DCModule

Returns:

a list of Strings representing the DublinCore module contributor, an empty list if none.

setContributors

public void setContributors(List contributors)

Sets the DublinCore module contributors.

Specified by:

setContributors in interface DCModule

Parameters:

contributors - the list of String representing the DublinCore module contributors to set, an empty list or null if none.

getContributor

public String getContributor()

Gets the DublinCore module contributor. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getContributor in interface DCModule

Returns:

the first DublinCore module contributor, null if none.

setContributor

public void setContributor(String contributor)

Sets the DublinCore module contributor. Convenience method that can be used when there is only one contributor to set.

Specified by:

setContributor in interface DCModule

Parameters:

contributor - the DublinCore module contributor to set, null if none.

getDates

public List<Date> getDates()

Returns the DublinCore module date.

Specified by:

getDates in interface DCModule

Returns:

a list of Strings representing the DublinCore module date, an empty list if none.

setDates

public void setDates(List<Date> dates)

Sets the DublinCore module dates.

Specified by:

setDates in interface DCModule

Parameters:

dates - the list of Date representing the DublinCore module dates to set, an empty list or null if none.

getDate

public Date getDate()

Gets the DublinCore module date. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getDate in interface DCModule

Returns:

the first DublinCore module date, null if none.

setDate

public void setDate(Date date)

Sets the DublinCore module date. Convenience method that can be used when there is only one date to set.

Specified by:

setDate in interface DCModule

Parameters:

date - the DublinCore module date to set, null if none.

getTypes

public List getTypes()

Returns the DublinCore module type.

Specified by:

getTypes in interface DCModule

Returns:

a list of Strings representing the DublinCore module type, an empty list if none.

setTypes

public void setTypes(List types)

Sets the DublinCore module types.

Specified by:

setTypes in interface DCModule

Parameters:

types - the list of String representing the DublinCore module types to set, an empty list or null if none.

getType

public String getType()

Gets the DublinCore module type. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getType in interface DCModule

Returns:

the first DublinCore module type, null if none.

setType

public void setType(String type)

Sets the DublinCore module type. Convenience method that can be used when there is only one type to set.

Specified by:

setType in interface DCModule

Parameters:

type - the DublinCore module type to set, null if none.

getFormats

public List getFormats()

Returns the DublinCore module format.

Specified by:

getFormats in interface DCModule

Returns:

a list of Strings representing the DublinCore module format, an empty list if none.

setFormats

public void setFormats(List formats)

Sets the DublinCore module formats.

Specified by:

setFormats in interface DCModule

Parameters:

formats - the list of String representing the DublinCore module formats to set, an empty list or null if none.

getFormat

public String getFormat()

Gets the DublinCore module format. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getFormat in interface DCModule

Returns:

the first DublinCore module format, null if none.

setFormat

public void setFormat(String format)

Sets the DublinCore module format. Convenience method that can be used when there is only one format to set.

Specified by:

setFormat in interface DCModule

Parameters:

format - the DublinCore module format to set, null if none.

getIdentifiers

public List getIdentifiers()

Returns the DublinCore module identifier.

Specified by:

getIdentifiers in interface DCModule

Returns:

a list of Strings representing the DublinCore module identifier, an empty list if none.

setIdentifiers

public void setIdentifiers(List identifiers)

Sets the DublinCore module identifiers.

Specified by:

setIdentifiers in interface DCModule

Parameters:

identifiers - the list of String representing the DublinCore module identifiers to set, an empty list or null if none.

getIdentifier

public String getIdentifier()

Gets the DublinCore module identifier. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getIdentifier in interface DCModule

Returns:

the first DublinCore module identifier, null if none.

setIdentifier

public void setIdentifier(String identifier)

Sets the DublinCore module identifier. Convenience method that can be used when there is only one identifier to set.

Specified by:

setIdentifier in interface DCModule

Parameters:

identifier - the DublinCore module identifier to set, null if none.

getSources

public List getSources()

Returns the DublinCore module source.

Specified by:

getSources in interface DCModule

Returns:

a list of Strings representing the DublinCore module source, an empty list if none.

setSources

public void setSources(List sources)

Sets the DublinCore module sources.

Specified by:

setSources in interface DCModule

Parameters:

sources - the list of String representing the DublinCore module sources to set, an empty list or null if none.

getSource

public String getSource()

Gets the DublinCore module source. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getSource in interface DCModule

Returns:

the first DublinCore module source, null if none.

setSource

public void setSource(String source)

Sets the DublinCore module source. Convenience method that can be used when there is only one source to set.

Specified by:

setSource in interface DCModule

Parameters:

source - the DublinCore module source to set, null if none.

getLanguages

public List getLanguages()

Returns the DublinCore module language.

Specified by:

getLanguages in interface DCModule

Returns:

a list of Strings representing the DublinCore module language, an empty list if none.

setLanguages

public void setLanguages(List languages)

Sets the DublinCore module languages.

Specified by:

setLanguages in interface DCModule

Parameters:

languages - the list of String representing the DublinCore module languages to set, an empty list or null if none.

getLanguage

public String getLanguage()

Gets the DublinCore module language. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getLanguage in interface DCModule

Returns:

the first DublinCore module langauge, null if none.

setLanguage

public void setLanguage(String language)

Sets the DublinCore module language. Convenience method that can be used when there is only one language to set.

Specified by:

setLanguage in interface DCModule

Parameters:

language - the DublinCore module language to set, null if none.

getRelations

public List getRelations()

Returns the DublinCore module relation.

Specified by:

getRelations in interface DCModule

Returns:

a list of Strings representing the DublinCore module relation, an empty list if none.

setRelations

public void setRelations(List relations)

Sets the DublinCore module relations.

Specified by:

setRelations in interface DCModule

Parameters:

relations - the list of String representing the DublinCore module relations to set, an empty list or null if none.

getRelation

public String getRelation()

Gets the DublinCore module relation. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getRelation in interface DCModule

Returns:

the first DublinCore module relation, null if none.

setRelation

public void setRelation(String relation)

Sets the DublinCore module relation. Convenience method that can be used when there is only one relation to set.

Specified by:

setRelation in interface DCModule

Parameters:

relation - the DublinCore module relation to set, null if none.

getCoverages

public List getCoverages()

Returns the DublinCore module coverage.

Specified by:

getCoverages in interface DCModule

Returns:

a list of Strings representing the DublinCore module coverage, an empty list if none.

setCoverages

public void setCoverages(List coverages)

Sets the DublinCore module coverages.

Specified by:

setCoverages in interface DCModule

Parameters:

coverages - the list of String representing the DublinCore module coverages to set, an empty list or null if none.

getCoverage

public String getCoverage()

Gets the DublinCore module coverage. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getCoverage in interface DCModule

Returns:

the first DublinCore module coverage, null if none.

setCoverage

public void setCoverage(String coverage)

Sets the DublinCore module coverage. Convenience method that can be used when there is only one coverage to set.

Specified by:

setCoverage in interface DCModule

Parameters:

coverage - the DublinCore module coverage to set, null if none.

getRightsList

public List getRightsList()

Returns the DublinCore module rights.

Specified by:

getRightsList in interface DCModule

Returns:

a list of Strings representing the DublinCore module rights, an empty list if none.

setRightsList

public void setRightsList(List rights)

Sets the DublinCore module rights.

Specified by:

setRightsList in interface DCModule

Parameters:

rights - the list of String representing the DublinCore module rights to set, an empty list or null if none.

getRights

public String getRights()

Gets the DublinCore module rights. Convenience method that can be used to obtain the first item, null if none.

Specified by:

getRights in interface DCModule

Returns:

the first DublinCore module rights, null if none.

setRights

public void setRights(String rights)

Sets the DublinCore module rights. Convenience method that can be used when there is only one rights to set.

Specified by:

setRights in interface DCModule

Parameters:

rights - the DublinCore module rights to set, null if none.

clone

public final Object clone()
                   throws CloneNotSupportedException

Creates a deep 'bean' clone of the object.

Specified by:

clone in interface Module

Overrides:

clone in class ModuleImpl

Returns:

a clone of the object.

Throws:

CloneNotSupportedException - thrown if an element of the object cannot be cloned.

equals

public final boolean equals(Object other)

Indicates whether some other object is "equal to" this one as defined by the Object equals() method.

Overrides:

equals in class ModuleImpl

Parameters:

other - he reference object with which to compare.

Returns:

true if 'this' object is equal to the 'other' object.

hashCode

public final int hashCode()

Returns a hashcode value for the object.

It follows the contract defined by the Object hashCode() method.

Overrides:

hashCode in class ModuleImpl

Returns:

the hashcode of the bean object.

toString

public final String toString()

Returns the String representation for the object.

Overrides:

toString in class ModuleImpl

Returns:

String representation for the object.

getInterface

public final Class<? extends CopyFrom> getInterface()

Description copied from interface: CopyFrom

Returns the interface the copyFrom works on.

This is useful when dealing with properties that may have multiple implementations. For example, Module.

Specified by:

getInterface in interface CopyFrom

Returns:

the interface the copyFrom works on.

copyFrom

public final void copyFrom(CopyFrom obj)

Description copied from interface: CopyFrom

Copies all the properties of the given bean into this one.

Any existing properties in this bean are lost.

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.

Specified by:

copyFrom in interface CopyFrom

Parameters:

obj - the instance to copy properties from.