[vlma-devel] commit: More comments. (Adrien Grand )

[git version control]

vlma | branch: master | Adrien Grand <jpountz at videolan.org> | Sun Mar  1 20:16:34 2009 +0100| [873017ef6bc7b12ab6e5f9325f278150504d9fd2] | committer: Adrien Grand 

More comments.

> http://git.videolan.org/gitweb.cgi/vlma.git/?a=commit;h=873017ef6bc7b12ab6e5f9325f278150504d9fd2
---

 .../main/java/org/videolan/vlma/model/Program.java |   54 ++++++++++++++++++++
 1 files changed, 54 insertions(+), 0 deletions(-)

diff --git a/vlma-api/src/main/java/org/videolan/vlma/model/Program.java b/vlma-api/src/main/java/org/videolan/vlma/model/Program.java
index 6060685..f7f9b0e 100644
--- a/vlma-api/src/main/java/org/videolan/vlma/model/Program.java
+++ b/vlma-api/src/main/java/org/videolan/vlma/model/Program.java
@@ -29,39 +29,93 @@ import java.util.Date;
  * Basic implementation of Program which represents a programmation.
  *
  * @author Sylvain Cadilhac <sylv at videolan.org>
+ * @author Adrien Grand <jpountz at videolan.org>
  */
 public final class Program implements Serializable {
 
     private static final long serialVersionUID = 5L;
 
+    /**
+     * The program ID. Used to generate the url at which the program will be
+     * accessible. Must be unique.
+     */
     private String id;
 
+    /**
+     * Runtime field, filled by the OrderManager and used to know which adapter
+     * is responsible for streaming this program.
+     */
     private volatile Adapter adapter;
 
+    /**
+     * Runtime field, filled by the OrderManager and used to know whether this
+     * program is effectively broadcasted or not.
+     */
     private volatile boolean broadcastState;
 
+    /**
+     * The media this program is related to.
+     */
     private Media media;
 
+    /**
+     * The IP address to use to broadcast, only used with multicast UDP
+     * streaming.
+     */
     private InetAddress ip;
 
+    /**
+     * Time interval in seconds between two executions of this program. A
+     * number inferior or equals to 0 means not to wait between two executions
+     * of the program.
+     */
     private int liveInterval;
 
+    /**
+     * Length of the execution in seconds. A number inferior to 0 means
+     * infinity.
+     */
     private int liveLength;
 
+    /**
+     * Number of repetitions of the program. A numer inferior to 0 means
+     * infinity.
+     */
     private int liveRepetitions;
 
+    /**
+     * Time to start broadcasting at.
+     */
     private Date liveStart;
 
+    /**
+     * Priority of this program.
+     */
     private int priority;
 
+    /**
+     * Group of this program.
+     */
     private String sapGroup;
 
+    /**
+     * Display name of this program.
+     */
     private String sapName;
 
+    /**
+     * Streaming strategy of this program. Must not be null.
+     */
     private StreamingStrategy streamingStrategy;
 
+    /**
+     * Announcing strategy of this program. null means no announcement.
+     */
     private AnnouncingStrategy announcingStrategy;
 
+    /**
+     * Transcoding strategy of this program. null means no transcoding.
+     */
     private TranscodingStrategy transcodingStrategy;
 
     public Program() {