2006/unicorn/org/w3c/unicorn/response Longmessage.java,1.1,1.2 Response.java,1.1,1.2 Result.java,1.1,1.2

Update of /sources/public/2006/unicorn/org/w3c/unicorn/response
In directory hutz:/tmp/cvs-serv14031/org/w3c/unicorn/response

Modified Files:
	Longmessage.java Response.java Result.java 
Log Message:
Updating Javadoc for the project.

Index: Response.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/response/Response.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- Response.java	20 Feb 2008 15:09:58 -0000	1.1
+++ Response.java	17 Jun 2008 13:45:31 -0000	1.2
@@ -158,6 +158,12 @@
     	return resultList;
     }
     
+    /**
+     * Gets the result of the specified URI given a language.
+     * @param lang The language to consider.
+     * @param uri  The URI to consider.
+     * @return The result in the given language for the URI.
+     */
     public Result getResult(String lang, String uri) {
     	if (mapOfLangURIResult.get(lang)==null)
     		mapOfLangURIResult.put(lang, new LinkedHashMap<String, Result>());
@@ -167,9 +173,10 @@
     }
 
     /**
-	 * add a Result r to the map, if theres is already a result which have the
+	 * Adds a Result r to the map, if there is already a result which has the
 	 * same uri and the same language, we will append r to this result otherwise
-	 * we'll simply add r to the list
+	 * we'll simply add r to the list.
+	 * @param value The value of the result.
 	 */
     public void addResult(Result value) {
     	//search in the list a result which have the same uri and the same language
@@ -186,6 +193,10 @@
     	}
     }
 
+    /**
+     * 
+     * @return The list of errors corresponding to the results.
+     */
     List<Error> getErrorList() {
     	List<Error> xList = new ArrayList<Error>();
     	//iterate all language
@@ -198,6 +209,10 @@
     	return xList;
     }
     
+    /**
+     * 
+     * @return The list of warnings corresponding to the results.
+     */
     List<Warning> getWarningList() {
     	List<Warning> xList = new ArrayList<Warning>();
     	//iterate all language
@@ -210,6 +225,10 @@
     	return xList;
     }
     
+    /**
+     * 
+     * @return The list of infos corresponding to the results.
+     */
     List<Info> getAllInfo() {
     	List<Info> xList = new ArrayList<Info>();
     	//iterate all language

Index: Longmessage.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/response/Longmessage.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- Longmessage.java	20 Feb 2008 15:09:58 -0000	1.1
+++ Longmessage.java	17 Jun 2008 13:45:31 -0000	1.2
@@ -40,6 +40,10 @@
     protected List<Object> content = new ArrayList<Object>();
     protected String lang;
 
+    /**
+     * 
+     * @return The list of the contents.
+     */
     public List<Object> getContent() {
         if (content == null) {
             content = new ArrayList<Object>();
@@ -47,6 +51,10 @@
         return this.content;
     }
 
+    /**
+     * Sets the contents of the message.
+     * @param content The list to set.
+     */
 	public void setContent(List<Object> content) {
 		this.content = content;
 	}
@@ -60,10 +68,17 @@
 		return res;
 	}
 */
+	/**
+	 * @return The language of the message.
+	 */
 	public String getLang() {
 		return lang;
 	}
 
+	/**
+	 * Sets the language for this message.
+	 * @param lang The language of the message.
+	 */
 	public void setLang(String lang) {
 		this.lang = lang;
 	}

Index: Result.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/response/Result.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- Result.java	20 Feb 2008 15:09:58 -0000	1.1
+++ Result.java	17 Jun 2008 13:45:32 -0000	1.2
@@ -10,23 +10,53 @@
 	protected List<Warning> warnings = new ArrayList<Warning>();
 	protected List<Info> infos = new ArrayList<Info>();
 	
+	/**
+	 * Constructor for Result.
+	 * @param lang The language to consider.
+	 * @param uri The URI to consider.
+	 */
 	public Result(String lang, String uri) {
 		super();
 		this.uri = uri;
 		this.lang = lang;
 	}
+	
+	/** 
+	 * 
+	 * @return The URI of the result.
+	 */
 	public String getUri() {
 		return uri;
 	}
+	
+	/**
+	 * 
+	 * @return The list of errors.
+	 */
 	public List<Error> getErrors() {
 		return errors;
 	}
+	
+	/**
+	 * 
+	 * @return The list of warnings.
+	 */
 	public List<Warning> getWarnings() {
 		return warnings;
 	}
+	
+	/**
+	 * 
+	 * @return The list of infos.
+	 */
 	public List<Info> getInfos() {
 		return infos;
 	}
+	
+	/**
+	 * 
+	 * @return The language of the result.
+	 */
 	public String getLang() {
 		return lang;
 	}

Received on Tuesday, 17 June 2008 13:46:09 UTC