(no commit message)
[utils] / crawler / kiss / src / org / wamblee / crawler / kiss / Channel.java
index 140a3d1cd7a813a3cf67903c626e069f8986cb0d..a59ed08d109c30794f5ad182c1e71895d2871789 100644 (file)
@@ -12,7 +12,7 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ 
+ */
 
 package org.wamblee.crawler.kiss;
 
@@ -20,27 +20,51 @@ import java.util.Collections;
 import java.util.List;
 
 /**
- * 
+ * Represents the programme for a tv channel.
  */
 public class Channel {
-    
+
+    /**
+     * TV channel name. 
+     */
     private String _name;
-    private List<Program> _programs; 
-    
-    public Channel(String aName, List<Program> aPrograms) { 
-        _name = aName; 
-        _programs = aPrograms; 
+
+    /**
+     * List of programs in chronological order. 
+     */
+    private List<Program> _programs;
+
+    /**
+     * Constructs the channel. 
+     * @param aName Channel name.
+     * @param aPrograms Programs. 
+     */
+    public Channel(String aName, List<Program> aPrograms) {
+        _name = aName;
+        _programs = aPrograms;
     }
-    
-    public String getName() { 
-        return _name; 
+
+    /**
+     * Gets the channel name. 
+     * @return channel name. 
+     */
+    public String getName() {
+        return _name;
     }
-    
-    public List<Program> getPrograms() { 
+
+    /**
+     * Gets the list of program. 
+     * @return Programs. 
+     */
+    public List<Program> getPrograms() {
         return Collections.unmodifiableList(_programs);
     }
-    
-    public void accept(Visitor aVisitor) { 
+
+    /**
+     * Accepts a visitor. 
+     * @param aVisitor Visitor. 
+     */
+    public void accept(Visitor aVisitor) {
         aVisitor.visitChannel(this);
     }
 }