com.sun.syndication.feed.module
Class SyModule

java.lang.Object
  extended bycom.sun.syndication.common.ObjectBean
      extended bycom.sun.syndication.feed.module.Module
          extended bycom.sun.syndication.feed.module.SyModule
All Implemented Interfaces:
java.lang.Cloneable, CopyFrom, ModuleI, java.io.Serializable, SyModuleI, ToString

public class SyModule
extends Module
implements SyModuleI

Syndication Module, default implementation.

Author:
Alejandro Abdelnur
See Also:
Syndication module., Serialized Form

Nested Class Summary
 
Nested classes inherited from class com.sun.syndication.feed.module.SyModuleI
SyModuleI.Period
 
Field Summary
 
Fields inherited from interface com.sun.syndication.feed.module.SyModuleI
DAILY, HOURLY, MONTHLY, URI, WEEKLY, YEARLY
 
Constructor Summary
SyModule()
          Default constructor.
 
Method Summary
 void copyFrom(java.lang.Object obj)
          Copies all the properties of the given bean into this one.
 java.lang.Class getInterface()
          Returns the interface the copyFrom works on.
 java.util.Date getUpdateBase()
          Returns the Syndication module update base date.
 int getUpdateFrequency()
          Returns the Syndication module update frequency.
 SyModuleI.Period getUpdatePeriod()
          Returns the Syndication module update period.
 void setUpdateBase(java.util.Date updateBase)
          Sets the Syndication module update base date.
 void setUpdateFrequency(int updateFrequency)
          Sets the Syndication module update frequency.
 void setUpdatePeriod(SyModuleI.Period updatePeriod)
          Sets the Syndication module update period.
 
Methods inherited from class com.sun.syndication.feed.module.Module
getUri
 
Methods inherited from class com.sun.syndication.common.ObjectBean
clone, equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sun.syndication.feed.module.ModuleI
clone, getUri
 
Methods inherited from interface com.sun.syndication.common.ToString
toString
 

Constructor Detail

SyModule

public SyModule()
Default constructor. All properties are set to null.

Method Detail

getUpdatePeriod

public SyModuleI.Period getUpdatePeriod()
Returns the Syndication module update period.

Specified by:
getUpdatePeriod in interface SyModuleI
Returns:
the Syndication module update period, null if none.

setUpdatePeriod

public void setUpdatePeriod(SyModuleI.Period updatePeriod)
Sets the Syndication module update period.

Specified by:
setUpdatePeriod in interface SyModuleI
Parameters:
updatePeriod - the Syndication module update period to set, null if none.

getUpdateFrequency

public int getUpdateFrequency()
Returns the Syndication module update frequency.

Specified by:
getUpdateFrequency in interface SyModuleI
Returns:
the Syndication module update frequency, null if none.

setUpdateFrequency

public void setUpdateFrequency(int updateFrequency)
Sets the Syndication module update frequency.

Specified by:
setUpdateFrequency in interface SyModuleI
Parameters:
updateFrequency - the Syndication module update frequency to set, null if none.

getUpdateBase

public java.util.Date getUpdateBase()
Returns the Syndication module update base date.

Specified by:
getUpdateBase in interface SyModuleI
Returns:
the Syndication module update base date, null if none.

setUpdateBase

public void setUpdateBase(java.util.Date updateBase)
Sets the Syndication module update base date.

Specified by:
setUpdateBase in interface SyModuleI
Parameters:
updateBase - the Syndication module update base date to set, null if none.

getInterface

public java.lang.Class 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, ModuleI.

Specified by:
getInterface in interface CopyFrom
Returns:
the interface the copyFrom works on.

copyFrom

public void copyFrom(java.lang.Object 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 SyndFeedI bean implementation to a Hibernate ready implementation.

Specified by:
copyFrom in interface CopyFrom
Parameters:
obj - the instance to copy properties from.


Copyright © 2004 Sun Microsystems. All Rights Reserved.