Top Description Fields Constructors Methods
com.rometools.rome.feed.module

public Class SyModuleImpl

extends ModuleImpl
implements SyModule
Class Inheritance
All Implemented Interfaces
com.rometools.rome.feed.module.SyModule, com.rometools.rome.feed.module.Module, java.io.Serializable, com.rometools.rome.feed.CopyFrom, java.lang.Cloneable
Imports
java.util.Collections, .Date, .HashMap, .HashSet, .Map, .Set, com.rometools.rome.feed.CopyFrom, com.rometools.rome.feed.impl.CopyFromHelper, com.rometools.utils.Dates
Syndication ModuleImpl, default implementation.

See Also
Syndication module

Field Summary

Modifier and TypeField and Description
private static final CopyFromHelper
COPY_FROM_HELPER

private static final Set<String>
PERIODS

private static final long
serialVersionUID

Hides com.rometools.rome.feed.module.ModuleImpl.serialVersionUID.

private Date
updateBase

private int
updateFrequency

private String
updatePeriod

Constructor Summary

AccessConstructor and Description
public
SyModuleImpl()

Method Summary

Modifier and TypeMethod and Description
public void
copyFrom(final CopyFrom
the instance to copy properties from.
obj)

Implements com.rometools.rome.feed.CopyFrom.copyFrom.

Copies all the properties of the given bean into this one.
public Class<? extends Module>
getInterface()

Implements com.rometools.rome.feed.CopyFrom.getInterface.

Returns the interface the copyFrom works on.
public Date

Returns:

the Syndication module update base date, null if none.
getUpdateBase()

Implements com.rometools.rome.feed.module.SyModule.getUpdateBase.

Returns the Syndication module update base date.
public int

Returns:

the Syndication module update frequency, null if none.
getUpdateFrequency()

Implements com.rometools.rome.feed.module.SyModule.getUpdateFrequency.

Returns the Syndication module update frequency.
public String

Returns:

the Syndication module update period, null if none.
getUpdatePeriod()

Implements com.rometools.rome.feed.module.SyModule.getUpdatePeriod.

Returns the Syndication module update period.
public void
setUpdateBase(final Date
the Syndication module update base date to set, null if none.
updateBase)

Implements com.rometools.rome.feed.module.SyModule.setUpdateBase.

Sets the Syndication module update base date.
public void
setUpdateFrequency(final int
the Syndication module update frequency to set, null if none.
updateFrequency)

Implements com.rometools.rome.feed.module.SyModule.setUpdateFrequency.

Sets the Syndication module update frequency.
public void
setUpdatePeriod(final String
the Syndication module update period to set, null if none.
updatePeriod)

Implements com.rometools.rome.feed.module.SyModule.setUpdatePeriod.

Sets the Syndication module update period.
Inherited from com.rometools.rome.feed.module.ModuleImpl:
cloneequalsgetUrihashCodetoString

Field Detail

COPY_FROM_HELPERback to summary
private static final CopyFromHelper COPY_FROM_HELPER
PERIODSback to summary
private static final Set<String> PERIODS
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.rometools.rome.feed.module.ModuleImpl.serialVersionUID.

updateBaseback to summary
private Date updateBase
updateFrequencyback to summary
private int updateFrequency
updatePeriodback to summary
private String updatePeriod

Constructor Detail

SyModuleImplback to summary
public SyModuleImpl()

Method Detail

copyFromback to summary
public void copyFrom(final CopyFrom obj)

Implements com.rometools.rome.feed.CopyFrom.copyFrom.

Doc from com.rometools.rome.feed.CopyFrom.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.

Parameters
obj:CopyFrom

the instance to copy properties from.

Annotations
@Override
getInterfaceback to summary
public Class<? extends Module> getInterface()

Implements com.rometools.rome.feed.CopyFrom.getInterface.

Doc from com.rometools.rome.feed.CopyFrom.getInterface.

Returns the interface the copyFrom works on.

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

Returns:Class<? extends Module>

the interface the copyFrom works on.

Annotations
@Override
getUpdateBaseback to summary
public Date getUpdateBase()

Implements com.rometools.rome.feed.module.SyModule.getUpdateBase.

Returns the Syndication module update base date.

Returns:Date

the Syndication module update base date, null if none.

Annotations
@Override
getUpdateFrequencyback to summary
public int getUpdateFrequency()

Implements com.rometools.rome.feed.module.SyModule.getUpdateFrequency.

Returns the Syndication module update frequency.

Returns:int

the Syndication module update frequency, null if none.

Annotations
@Override
getUpdatePeriodback to summary
public String getUpdatePeriod()

Implements com.rometools.rome.feed.module.SyModule.getUpdatePeriod.

Returns the Syndication module update period.

Returns:String

the Syndication module update period, null if none.

Annotations
@Override
setUpdateBaseback to summary
public void setUpdateBase(final Date updateBase)

Implements com.rometools.rome.feed.module.SyModule.setUpdateBase.

Sets the Syndication module update base date.

Parameters
updateBase:Date

the Syndication module update base date to set, null if none.

Annotations
@Override
setUpdateFrequencyback to summary
public void setUpdateFrequency(final int updateFrequency)

Implements com.rometools.rome.feed.module.SyModule.setUpdateFrequency.

Sets the Syndication module update frequency.

Parameters
updateFrequency:int

the Syndication module update frequency to set, null if none.

Annotations
@Override
setUpdatePeriodback to summary
public void setUpdatePeriod(final String updatePeriod)

Implements com.rometools.rome.feed.module.SyModule.setUpdatePeriod.

Sets the Syndication module update period.

Parameters
updatePeriod:String

the Syndication module update period to set, null if none.

Annotations
@Override