View Javadoc

1   /*
2    * Copyright 2004 Sun Microsystems, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   */
17  package com.sun.syndication.feed.module;
18  
19  import java.util.Date;
20  
21  /***
22   * Syndication Module, default implementation.
23   * <p>
24   * @see <a href="http://web.resource.org/rss/1.0/modules/syndication/">Syndication module</a>.
25   * @author Alejandro Abdelnur
26   *
27   */
28  public class SyModule extends Module implements SyModuleI {
29      private SyModuleI.Period _updatePeriod;
30      private int _updateFrequency;
31      private Date _updateBase;
32  
33      /***
34       * Default constructor. All properties are set to <b>null</b>.
35       * <p>
36       *
37       */
38      public SyModule() {
39          super(URI);
40      }
41  
42      /***
43       * Returns the Syndication module update period.
44       * <p>
45       * @return the Syndication module update period, <b>null</b> if none.
46       *
47       */
48      public SyModuleI.Period getUpdatePeriod() {
49          return _updatePeriod;
50      }
51  
52      /***
53       * Sets the Syndication module update period.
54       * <p>
55       * @param updatePeriod the Syndication module update period to set, <b>null</b> if none.
56       *
57       */
58      public void setUpdatePeriod(SyModuleI.Period updatePeriod) {
59          _updatePeriod = updatePeriod;
60      }
61  
62      /***
63       * Returns the Syndication module update frequency.
64       * <p>
65       * @return the Syndication module update frequency, <b>null</b> if none.
66       *
67       */
68      public int getUpdateFrequency() {
69          return _updateFrequency;
70      }
71  
72      /***
73       * Sets the Syndication module update frequency.
74       * <p>
75       * @param updateFrequency the Syndication module update frequency to set, <b>null</b> if none.
76       *
77       */
78      public void setUpdateFrequency(int updateFrequency) {
79          _updateFrequency = updateFrequency;
80      }
81  
82      /***
83       * Returns the Syndication module update base date.
84       * <p>
85       * @return the Syndication module update base date, <b>null</b> if none.
86       *
87       */
88      public Date getUpdateBase() {
89          return _updateBase;
90      }
91  
92      /***
93       * Sets the Syndication module update base date.
94       * <p>
95       * @param updateBase the Syndication module update base date to set, <b>null</b> if none.
96       *
97       */
98      public void setUpdateBase(Date updateBase) {
99          _updateBase = updateBase;
100     }
101 
102 }