You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wink.apache.org by lr...@apache.org on 2012/11/30 22:55:25 UTC

svn commit: r1415865 - in /incubator/wink/trunk/wink-common/src: main/java/org/apache/wink/common/model/wadl/WADLDoc.java main/java/org/apache/wink/common/model/wadl/WADLGenerator.java test/java/org/apache/wink/common/model/wadl/WADLGeneratorTest.java

Author: lresende
Date: Fri Nov 30 21:55:24 2012
New Revision: 1415865

URL: http://svn.apache.org/viewvc?rev=1415865&view=rev
Log:
WINK-372 - Add Support for WADL Doc text content when using @WADLDoc annotation in Resource class

Patch provided by Etienne Canaud

Modified:
    incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLDoc.java
    incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLGenerator.java
    incubator/wink/trunk/wink-common/src/test/java/org/apache/wink/common/model/wadl/WADLGeneratorTest.java

Modified: incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLDoc.java
URL: http://svn.apache.org/viewvc/incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLDoc.java?rev=1415865&r1=1415864&r2=1415865&view=diff
==============================================================================
--- incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLDoc.java (original)
+++ incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLDoc.java Fri Nov 30 21:55:24 2012
@@ -28,4 +28,6 @@ import java.lang.annotation.Target;
 public @interface WADLDoc {
 
     String value();
+
+    String content() default "";
 }

Modified: incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLGenerator.java
URL: http://svn.apache.org/viewvc/incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLGenerator.java?rev=1415865&r1=1415864&r2=1415865&view=diff
==============================================================================
--- incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLGenerator.java (original)
+++ incubator/wink/trunk/wink-common/src/main/java/org/apache/wink/common/model/wadl/WADLGenerator.java Fri Nov 30 21:55:24 2012
@@ -782,6 +782,9 @@ public class WADLGenerator {
     /* package */Doc getDocument(WADLDoc desc) {
         Doc d = new Doc();
         d.setTitle(desc.value());
+        if (!"".equals(desc.content())) {
+            d.getContent().add(desc.content());
+        }
         return d;
     }
 

Modified: incubator/wink/trunk/wink-common/src/test/java/org/apache/wink/common/model/wadl/WADLGeneratorTest.java
URL: http://svn.apache.org/viewvc/incubator/wink/trunk/wink-common/src/test/java/org/apache/wink/common/model/wadl/WADLGeneratorTest.java?rev=1415865&r1=1415864&r2=1415865&view=diff
==============================================================================
--- incubator/wink/trunk/wink-common/src/test/java/org/apache/wink/common/model/wadl/WADLGeneratorTest.java (original)
+++ incubator/wink/trunk/wink-common/src/test/java/org/apache/wink/common/model/wadl/WADLGeneratorTest.java Fri Nov 30 21:55:24 2012
@@ -78,11 +78,11 @@ public class WADLGeneratorTest {
 
     @Path("resource1/{pp}")
     @Consumes(value = {MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN})
-    @WADLDoc("this is resource1")
+    @WADLDoc(value = "this is resource1 title", content = "this is resource1 content")
     static class Resource1 {
 
         @GET
-        @WADLDoc("this is the hello method")
+        @WADLDoc("this is the hello method with only default title value and no content")
         public String hello(@WADLDoc("request doc") String abcd,
                             @WADLDoc("q2 parameter doc") @QueryParam("q2") String q,
                             @QueryParam("q3") int q2,
@@ -403,10 +403,14 @@ public class WADLGeneratorTest {
         Application app = generator.generate("", classes);
         Resource res = app.getResources().get(0).getResource().get(0);
         assertEquals(1, res.getDoc().size());
-        assertEquals("this is resource1", res.getDoc().get(0).getTitle());
+        assertEquals("this is resource1 title", res.getDoc().get(0).getTitle());
+        assertEquals(res.getDoc().get(0).getContent().size(), 1);
+        assertEquals("this is resource1 content", res.getDoc().get(0).getContent().get(0));
         Method m = (Method)res.getMethodOrResource().get(0);
         assertEquals(1, m.getDoc().size());
-        assertEquals("this is the hello method", m.getDoc().get(0).getTitle());
+        assertEquals("this is the hello method with only default title value and no content", m.getDoc().get(0)
+                .getTitle());
+        assertEquals(0, m.getDoc().get(0).getContent().size());
 
         assertEquals(1, m.getRequest().getDoc().size());
         assertEquals("request doc", m.getRequest().getDoc().get(0).getTitle());