From 8d39970ee7fad0c2374ad32fe2e936042c76805f Mon Sep 17 00:00:00 2001 From: Neel Patel Date: Sat, 16 Sep 2017 17:52:59 +0530 Subject: [PATCH] update documentation. --- .../com/neel/articleshub/MainActivity.java | 2 + .../restapi/beans/UserDetail.java | 2 +- .../restapi/request/AddRequestTask.java | 25 +++-- .../restapi/request/RequestHandler.java | 5 +- .../restapi/request/RequestTask.java | 26 +++-- docs/allclasses-frame.html | 4 +- docs/allclasses-noframe.html | 4 +- .../ExampleInstrumentedTest.html | 4 +- .../neel/articleshubapi/ExampleUnitTest.html | 4 +- .../neel/articleshubapi/package-frame.html | 4 +- .../neel/articleshubapi/package-summary.html | 4 +- .../com/neel/articleshubapi/package-tree.html | 4 +- .../restapi/beans/ArticleDetail.html | 4 +- .../restapi/beans/CommentDetail.html | 4 +- .../articleshubapi/restapi/beans/Link.html | 4 +- .../restapi/beans/ShortArticleDetail.html | 4 +- .../restapi/beans/ShortUserDetail.html | 86 +++++++++++++++-- .../restapi/beans/TagDetail.html | 4 +- .../restapi/beans/UserDetail.html | 94 ++++++++++++++++--- .../restapi/beans/package-frame.html | 4 +- .../restapi/beans/package-summary.html | 4 +- .../restapi/beans/package-tree.html | 4 +- .../restapi/request/AddRequestTask.html | 47 +++++++--- .../restapi/request/HeaderTools.EntryImp.html | 4 +- .../restapi/request/HeaderTools.html | 4 +- .../restapi/request/RequestHandler.html | 33 +++++-- .../restapi/request/RequestTask.html | 48 +++++++--- .../restapi/request/package-frame.html | 4 +- .../restapi/request/package-summary.html | 4 +- .../restapi/request/package-tree.html | 4 +- docs/constant-values.html | 4 +- docs/deprecated-list.html | 4 +- docs/help-doc.html | 4 +- docs/index-files/index-1.html | 4 +- docs/index-files/index-10.html | 12 ++- docs/index-files/index-11.html | 4 +- docs/index-files/index-12.html | 4 +- docs/index-files/index-2.html | 4 +- docs/index-files/index-3.html | 4 +- docs/index-files/index-4.html | 4 +- docs/index-files/index-5.html | 18 +++- docs/index-files/index-6.html | 4 +- docs/index-files/index-7.html | 4 +- docs/index-files/index-8.html | 4 +- docs/index-files/index-9.html | 4 +- docs/index.html | 2 +- docs/overview-frame.html | 4 +- docs/overview-summary.html | 4 +- docs/overview-tree.html | 4 +- 49 files changed, 399 insertions(+), 145 deletions(-) diff --git a/app/src/main/java/com/neel/articleshub/MainActivity.java b/app/src/main/java/com/neel/articleshub/MainActivity.java index bc34708..b799b54 100644 --- a/app/src/main/java/com/neel/articleshub/MainActivity.java +++ b/app/src/main/java/com/neel/articleshub/MainActivity.java @@ -12,6 +12,7 @@ import com.neel.articleshubapi.restapi.request.RequestTask; import org.springframework.http.HttpMethod; +import org.springframework.http.HttpStatus; import static com.neel.articleshubapi.restapi.request.HeaderTools.CONTENT_TYPE_JSON; @@ -60,6 +61,7 @@ protected void onStart(){ login, HttpMethod.POST, HeaderTools.CONTENT_TYPE_JSON, HeaderTools.ACCEPT_TEXT); rt4.execute(getResources().getString(R.string.ser_base_url)+"/authentication/user1"); Log.i("login",rt4.getObj()); + HttpStatus status = rt4.getHttpStatus(); RequestTask rt5=new RequestTask(String.class, HttpMethod.POST, HeaderTools.CONTENT_TYPE_JSON, HeaderTools.makeAuth("402881825d691eaa015d693baadf0000")); rt5.execute(getResources().getString(R.string.ser_base_url)+"/user/juser/like/13"); diff --git a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/beans/UserDetail.java b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/beans/UserDetail.java index 0dc27d4..b989ddf 100644 --- a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/beans/UserDetail.java +++ b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/beans/UserDetail.java @@ -32,7 +32,7 @@ /** * Created by Neel Patel on 26-07-2017. * @author Neel Patel - * @version 1.0.0 + * @version 2.0.0 */ public class UserDetail { diff --git a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/AddRequestTask.java b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/AddRequestTask.java index 11b0b9c..d7b6af9 100644 --- a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/AddRequestTask.java +++ b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/AddRequestTask.java @@ -43,14 +43,19 @@ * following snapshot of code can be used to update article having id '1'
* 
  * {@code
+        ArticleDetail article = new ArticleDetail();
         article.setAuthor("username");
         article.setTitle("android test");
         article.setArticleId(1);
         article.getContent().add("android update");
-        AddRequestTask rt6=new AddRequestTask(String.class,
+        AddRequestTask rt=new AddRequestTask(String.class,
                 article, HttpMethod.PUT, HeaderTools.CONTENT_TYPE_JSON,
-                HeaderTools.makeAuth("402881825d691eaa015d693baadf0000"));
-        rt6.execute(BASE_URL+"/article/1");
+                HeaderTools.makeAuth(token));
+        rt.execute(BASE_URL+"/article/1");
+        // initiate waiting logic
+        rt.getObj();
+        // terminate waiting logic
+        HttpStatus status = rt.getHttpStatus();
    }
  *
*

@@ -61,10 +66,13 @@ UserDetail login =new UserDetail(); login.setUserName("username"); login.setPass("pass"); - AddRequestTask rt4=new AddRequestTask(String.class, + AddRequestTask rt=new AddRequestTask(String.class, login, HttpMethod.POST, HeaderTools.CONTENT_TYPE_JSON, HeaderTools.ACCEPT_TEXT); - rt4.execute(BASE_URL+"/authentication/username"); - String token = rt4.getObj()); + rt.execute(BASE_URL+"/authentication/username"); + // initiate waiting logic + String token = rt.getObj()); + // terminate waiting logic + HttpStatus status = rt.getHttpStatus(); } * *

@@ -73,7 +81,7 @@ * @see com.neel.articleshubapi.restapi.request.RequestTask * @see com.neel.articleshubapi.restapi.request.HeaderTools * @see android.os.AsyncTask - * @version 1.0.0 + * @version 2.0.0 */ public class AddRequestTask extends AsyncTask { @@ -132,6 +140,9 @@ public T getObj(){ return null; } + /** + * @return http status code of last request + */ public HttpStatus getHttpStatus() { return httpStatus; } diff --git a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestHandler.java b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestHandler.java index a0e1c47..f64045c 100644 --- a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestHandler.java +++ b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestHandler.java @@ -54,7 +54,7 @@ methods of this class as they contains network access permission which is not * @author Neel Patel * @see com.neel.articleshubapi.restapi.request.RequestTask * @see com.neel.articleshubapi.restapi.request.AddRequestTask - * @version 1.0.0 + * @version 2.0.0 */ public class RequestHandler{ @@ -156,6 +156,9 @@ public T getResource(Class type, String url){ return getResource(type, url, HttpMethod.GET); } + /** + * @return http status code of last request + */ public HttpStatus getHttpStatus() { return httpStatus; } diff --git a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestTask.java b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestTask.java index 0b3986f..de79252 100644 --- a/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestTask.java +++ b/articleshubapi/src/main/java/com/neel/articleshubapi/restapi/request/RequestTask.java @@ -44,7 +44,10 @@ * {@code RequestTask rt=new RequestTask<>(ArticleDetail.class,CONTENT_TYPE_JSON); rt.execute(BASE_URL+"/article/"+2); + // initiate waiting logic ArticleDetail article=rt.getObj(); + // terminate waiting logic + HttpStatus status = rt.getHttpStatus(); } * *

@@ -54,10 +57,12 @@ who liked article with id '1'.
* 
  * {@code
-        RequestTask rt2=
+        RequestTask rt=
                     new RequestTask<>(ShortUserDetail[].class,CONTENT_TYPE_JSON);
-        rt2.execute(BASE_URL+"/article/1/likes");
-        ShortUserDetail[] ud=rt2.getObj();
+        rt.execute(BASE_URL+"/article/1/likes");
+        // initiate waiting logic
+        ShortUserDetail[] ud=rt.getObj();
+        // terminate waiting logic
    }
  *
*

@@ -67,10 +72,14 @@ * following snapshot of code can be used to add like on article.
* 
  * {@code
-        RequestTask rt5=new RequestTask(String.class, HttpMethod.POST,
+        RequestTask rt=new RequestTask(String.class, HttpMethod.POST,
                 HeaderTools.CONTENT_TYPE_JSON,
-                HeaderTools.makeAuth("402881825d691eaa015d693baadf0000"));
-        rt5.execute(BASE_URL+"/user/username/like/1");
+                HeaderTools.makeAuth(token));
+        rt.execute(BASE_URL+"/user/username/like/1");
+        // initiate waiting logic
+        rt.getObj();
+        // terminate waiting logic
+        HttpStatus status = rt.getHttpStatus();
    }
  *
*

@@ -79,7 +88,7 @@ * @see com.neel.articleshubapi.restapi.request.AddRequestTask * @see com.neel.articleshubapi.restapi.request.HeaderTools * @see android.os.AsyncTask - * @version 1.0.0 + * @version 2.0.0 */ public class RequestTask extends AsyncTask { @@ -150,6 +159,9 @@ public T getObj(){ return null; } + /** + * @return http status code of last request + */ public HttpStatus getHttpStatus() { return httpStatus; } diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index cfc3750..bef270e 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -2,9 +2,9 @@ - + All Classes - + diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html index cb1be56..1d72378 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes - + diff --git a/docs/com/neel/articleshubapi/ExampleInstrumentedTest.html b/docs/com/neel/articleshubapi/ExampleInstrumentedTest.html index 65bce7b..4697a69 100644 --- a/docs/com/neel/articleshubapi/ExampleInstrumentedTest.html +++ b/docs/com/neel/articleshubapi/ExampleInstrumentedTest.html @@ -2,9 +2,9 @@ - + ExampleInstrumentedTest - + diff --git a/docs/com/neel/articleshubapi/ExampleUnitTest.html b/docs/com/neel/articleshubapi/ExampleUnitTest.html index abe4c47..2b48a0e 100644 --- a/docs/com/neel/articleshubapi/ExampleUnitTest.html +++ b/docs/com/neel/articleshubapi/ExampleUnitTest.html @@ -2,9 +2,9 @@ - + ExampleUnitTest - + diff --git a/docs/com/neel/articleshubapi/package-frame.html b/docs/com/neel/articleshubapi/package-frame.html index bbb0a48..0a118c5 100644 --- a/docs/com/neel/articleshubapi/package-frame.html +++ b/docs/com/neel/articleshubapi/package-frame.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi - + diff --git a/docs/com/neel/articleshubapi/package-summary.html b/docs/com/neel/articleshubapi/package-summary.html index f7aa283..6611add 100644 --- a/docs/com/neel/articleshubapi/package-summary.html +++ b/docs/com/neel/articleshubapi/package-summary.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi - + diff --git a/docs/com/neel/articleshubapi/package-tree.html b/docs/com/neel/articleshubapi/package-tree.html index d8b6e7c..4ba1cf2 100644 --- a/docs/com/neel/articleshubapi/package-tree.html +++ b/docs/com/neel/articleshubapi/package-tree.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi Class Hierarchy - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/ArticleDetail.html b/docs/com/neel/articleshubapi/restapi/beans/ArticleDetail.html index 50cf626..2f109ee 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/ArticleDetail.html +++ b/docs/com/neel/articleshubapi/restapi/beans/ArticleDetail.html @@ -2,9 +2,9 @@ - + ArticleDetail - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/CommentDetail.html b/docs/com/neel/articleshubapi/restapi/beans/CommentDetail.html index 49be912..7f14fdc 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/CommentDetail.html +++ b/docs/com/neel/articleshubapi/restapi/beans/CommentDetail.html @@ -2,9 +2,9 @@ - + CommentDetail - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/Link.html b/docs/com/neel/articleshubapi/restapi/beans/Link.html index 5fc4bb1..c3509f6 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/Link.html +++ b/docs/com/neel/articleshubapi/restapi/beans/Link.html @@ -2,9 +2,9 @@ - + Link - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/ShortArticleDetail.html b/docs/com/neel/articleshubapi/restapi/beans/ShortArticleDetail.html index aeb405d..c225681 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/ShortArticleDetail.html +++ b/docs/com/neel/articleshubapi/restapi/beans/ShortArticleDetail.html @@ -2,9 +2,9 @@ - + ShortArticleDetail - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/ShortUserDetail.html b/docs/com/neel/articleshubapi/restapi/beans/ShortUserDetail.html index 408161c..e644d6a 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/ShortUserDetail.html +++ b/docs/com/neel/articleshubapi/restapi/beans/ShortUserDetail.html @@ -2,9 +2,9 @@ - + ShortUserDetail - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -113,7 +113,7 @@

Class ShortUserDetail

Created by Neel Patel on 8/3/2017.
Version:
-
1.0.0
+
2.0.0
Author:
Neel Patel
@@ -158,25 +158,41 @@

Method Summary

java.lang.String -getLink()  +getFirstName()  java.lang.String -getUserName()  +getLastName()  +java.lang.String +getLink()  + + +java.lang.String +getUserName()  + + void setEmailId(java.lang.String emailId)  - + +void +setFirstName(java.lang.String firstName)  + + +void +setLastName(java.lang.String lastName)  + + void setLink(java.lang.String link)  - + void setUserName(java.lang.String userName)  - + java.lang.String toString()  @@ -245,6 +261,58 @@

setUserName

+ + + +
    +
  • +

    getFirstName

    +
    public java.lang.String getFirstName()
    +
    +
    Returns:
    +
    firstname
    +
    +
    • +
+ + + +
    +
  • +

    setFirstName

    +
    public void setFirstName(java.lang.String firstName)
    +
    +
    Parameters:
    +
    firstName - firstname
    +
    +
    • +
+ + + +
    +
  • +

    getLastName

    +
    public java.lang.String getLastName()
    +
    +
    Returns:
    +
    lastname
    +
    +
    • +
+ + + +
    +
  • +

    setLastName

    +
    public void setLastName(java.lang.String lastName)
    +
    +
    Parameters:
    +
    lastName - lastname
    +
    +
    • +
diff --git a/docs/com/neel/articleshubapi/restapi/beans/TagDetail.html b/docs/com/neel/articleshubapi/restapi/beans/TagDetail.html index 0e9ae39..7dabee0 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/TagDetail.html +++ b/docs/com/neel/articleshubapi/restapi/beans/TagDetail.html @@ -2,9 +2,9 @@ - + TagDetail - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/UserDetail.html b/docs/com/neel/articleshubapi/restapi/beans/UserDetail.html index 96b1355..a79cf06 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/UserDetail.html +++ b/docs/com/neel/articleshubapi/restapi/beans/UserDetail.html @@ -2,9 +2,9 @@ - + UserDetail - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -113,7 +113,7 @@

Class UserDetail

Created by Neel Patel on 26-07-2017.
Version:
-
1.0.0
+
2.0.0
Author:
Neel Patel
@@ -158,46 +158,62 @@

Method Summary

java.lang.String -getInfo()  +getFirstName()  +java.lang.String +getInfo()  + + +java.lang.String +getLastName()  + + Link getLink(java.lang.String name)
this method returns Link object having name specified from the list returned by the getLinks method.
- + java.util.List<Link> getLinks()
this method returns links related to this object.
- + java.lang.String getPass()  - + java.lang.String getUserName()  - + void setEmailId(java.lang.String emailId)  - + +void +setFirstName(java.lang.String firstName)  + + void setInfo(java.lang.String info)  - + +void +setLastName(java.lang.String lastName)  + + void setPass(java.lang.String pass)  - + void setUserName(java.lang.String userName)  - + java.lang.String toString()  @@ -266,6 +282,58 @@

setUserName

+ + + +
    +
  • +

    getFirstName

    +
    public java.lang.String getFirstName()
    +
    +
    Returns:
    +
    firstname
    +
    +
    • +
+ + + +
    +
  • +

    setFirstName

    +
    public void setFirstName(java.lang.String firstName)
    +
    +
    Parameters:
    +
    firstName - firstname
    +
    +
    • +
+ + + +
    +
  • +

    getLastName

    +
    public java.lang.String getLastName()
    +
    +
    Returns:
    +
    lastname
    +
    +
    • +
+ + + +
    +
  • +

    setLastName

    +
    public void setLastName(java.lang.String lastName)
    +
    +
    Parameters:
    +
    lastName - lastname
    +
    +
    • +
diff --git a/docs/com/neel/articleshubapi/restapi/beans/package-frame.html b/docs/com/neel/articleshubapi/restapi/beans/package-frame.html index 4efd66a..05567db 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/package-frame.html +++ b/docs/com/neel/articleshubapi/restapi/beans/package-frame.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi.restapi.beans - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/package-summary.html b/docs/com/neel/articleshubapi/restapi/beans/package-summary.html index 02ef62a..49a59a8 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/package-summary.html +++ b/docs/com/neel/articleshubapi/restapi/beans/package-summary.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi.restapi.beans - + diff --git a/docs/com/neel/articleshubapi/restapi/beans/package-tree.html b/docs/com/neel/articleshubapi/restapi/beans/package-tree.html index 3ec764a..cef0484 100644 --- a/docs/com/neel/articleshubapi/restapi/beans/package-tree.html +++ b/docs/com/neel/articleshubapi/restapi/beans/package-tree.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi.restapi.beans Class Hierarchy - + diff --git a/docs/com/neel/articleshubapi/restapi/request/AddRequestTask.html b/docs/com/neel/articleshubapi/restapi/request/AddRequestTask.html index 3960aa4..30d3aa0 100644 --- a/docs/com/neel/articleshubapi/restapi/request/AddRequestTask.html +++ b/docs/com/neel/articleshubapi/restapi/request/AddRequestTask.html @@ -2,9 +2,9 @@ - + AddRequestTask - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -123,14 +123,19 @@

Class AddRequestTask<T,R> 
  
+        ArticleDetail article = new ArticleDetail();
         article.setAuthor("username");
         article.setTitle("android test");
         article.setArticleId(1);
         article.getContent().add("android update");
-        AddRequestTask<String,ArticleDetail> rt6=new AddRequestTask<String, ArticleDetail>(String.class,
+        AddRequestTask<String,ArticleDetail> rt=new AddRequestTask<String, ArticleDetail>(String.class,
                 article, HttpMethod.PUT, HeaderTools.CONTENT_TYPE_JSON,
-                HeaderTools.makeAuth("402881825d691eaa015d693baadf0000"));
-        rt6.execute(BASE_URL+"/article/1");
+                HeaderTools.makeAuth(token));
+        rt.execute(BASE_URL+"/article/1");
+        // initiate waiting logic
+        rt.getObj();
+        // terminate waiting logic
+        HttpStatus status = rt.getHttpStatus();


@@ -141,17 +146,20 @@

Class AddRequestTask<T,R>

Created by Neel Patel on 24-07-2017.
Version:
-
1.0.0
+
2.0.0
Author:
Neel Patel
See Also:
@@ -237,6 +245,10 @@

Method Summary

doInBackground(java.lang.String... params)  +org.springframework.http.HttpStatus +getHttpStatus()  + + T getObj()  @@ -320,12 +332,25 @@

doInBackground

-
    +

    • getObj

      public T getObj()
    + + + +
      +
    • +

      getHttpStatus

      +
      public org.springframework.http.HttpStatus getHttpStatus()
      +
      +
      Returns:
      +
      http status code of last request
      +
      +
      • +
diff --git a/docs/com/neel/articleshubapi/restapi/request/HeaderTools.EntryImp.html b/docs/com/neel/articleshubapi/restapi/request/HeaderTools.EntryImp.html index 8999e95..9698b57 100644 --- a/docs/com/neel/articleshubapi/restapi/request/HeaderTools.EntryImp.html +++ b/docs/com/neel/articleshubapi/restapi/request/HeaderTools.EntryImp.html @@ -2,9 +2,9 @@ - + HeaderTools.EntryImp - + diff --git a/docs/com/neel/articleshubapi/restapi/request/HeaderTools.html b/docs/com/neel/articleshubapi/restapi/request/HeaderTools.html index f729a2a..65129e7 100644 --- a/docs/com/neel/articleshubapi/restapi/request/HeaderTools.html +++ b/docs/com/neel/articleshubapi/restapi/request/HeaderTools.html @@ -2,9 +2,9 @@ - + HeaderTools - + diff --git a/docs/com/neel/articleshubapi/restapi/request/RequestHandler.html b/docs/com/neel/articleshubapi/restapi/request/RequestHandler.html index d1b9e09..5f0bf96 100644 --- a/docs/com/neel/articleshubapi/restapi/request/RequestHandler.html +++ b/docs/com/neel/articleshubapi/restapi/request/RequestHandler.html @@ -2,9 +2,9 @@ - + RequestHandler - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -124,7 +124,7 @@

Class RequestHandler

Created by Neel Patel on 24-07-2017.
Version:
-
1.0.0
+
2.0.0
Author:
Neel Patel
See Also:
@@ -167,13 +167,17 @@

Method Summary

Method and Description +org.springframework.http.HttpStatus +getHttpStatus()  + + <T> T getResource(java.lang.Class<T> type, java.lang.String url)
this method will make http get request without body & Header.
- + <T> T getResource(java.lang.Class<T> type, java.lang.String url, @@ -181,7 +185,7 @@

Method Summary

this method will make http request without body & Header.
- + <T> T getResource(java.lang.Class<T> type, java.lang.String url, @@ -190,7 +194,7 @@

Method Summary

this method will make http request without body.
- + <T,R> T getResource(java.lang.Class<T> type, java.lang.String url, @@ -330,7 +334,7 @@

getResource

-
    +

    • getResource

      public <T> T getResource(java.lang.Class<T> type,
@@ -351,6 +355,19 @@ 
      getResource
+ + + +
    +
  • +

    getHttpStatus

    +
    public org.springframework.http.HttpStatus getHttpStatus()
    +
    +
    Returns:
    +
    http status code of last request
    +
    +
    • +
diff --git a/docs/com/neel/articleshubapi/restapi/request/RequestTask.html b/docs/com/neel/articleshubapi/restapi/request/RequestTask.html index 9956f4b..dcdf468 100644 --- a/docs/com/neel/articleshubapi/restapi/request/RequestTask.html +++ b/docs/com/neel/articleshubapi/restapi/request/RequestTask.html @@ -2,9 +2,9 @@ - + RequestTask - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -124,7 +124,10 @@

Class RequestTask<T>

RequestTask<ArticleDetail> rt=new RequestTask<>(ArticleDetail.class,CONTENT_TYPE_JSON); rt.execute(BASE_URL+"/article/"+2); + // initiate waiting logic ArticleDetail article=rt.getObj(); + // terminate waiting logic + HttpStatus status = rt.getHttpStatus();

@@ -134,10 +137,12 @@

Class RequestTask<T>

who liked article with id '1'.
  
-        RequestTask<ShortUserDetail[]> rt2=
+        RequestTask<ShortUserDetail[]> rt=
                     new RequestTask<>(ShortUserDetail[].class,CONTENT_TYPE_JSON);
-        rt2.execute(BASE_URL+"/article/1/likes");
-        ShortUserDetail[] ud=rt2.getObj();
+        rt.execute(BASE_URL+"/article/1/likes");
+        // initiate waiting logic
+        ShortUserDetail[] ud=rt.getObj();
+        // terminate waiting logic


@@ -147,17 +152,21 @@

Class RequestTask<T>

following snapshot of code can be used to add like on article.
  
-        RequestTask<String> rt5=new RequestTask<String>(String.class, HttpMethod.POST,
+        RequestTask<String> rt=new RequestTask<String>(String.class, HttpMethod.POST,
                 HeaderTools.CONTENT_TYPE_JSON,
-                HeaderTools.makeAuth("402881825d691eaa015d693baadf0000"));
-        rt5.execute(BASE_URL+"/user/username/like/1");
+                HeaderTools.makeAuth(token));
+        rt.execute(BASE_URL+"/user/username/like/1");
+        // initiate waiting logic
+        rt.getObj();
+        // terminate waiting logic
+        HttpStatus status = rt.getHttpStatus();


Created by Neel Patel on 24-07-2017.
Version:
-
1.0.0
+
2.0.0
Author:
Neel Patel
See Also:
@@ -245,6 +254,10 @@

Method Summary

doInBackground(java.lang.String... params)  +org.springframework.http.HttpStatus +getHttpStatus()  + + T getObj()
this method simply return object return by 'get' method of this class.
@@ -337,7 +350,7 @@

doInBackground

-
    +

    • getObj

      public T getObj()
      @@ -350,6 +363,19 @@

      getObj

+ + + +
    +
  • +

    getHttpStatus

    +
    public org.springframework.http.HttpStatus getHttpStatus()
    +
    +
    Returns:
    +
    http status code of last request
    +
    +
    • +
diff --git a/docs/com/neel/articleshubapi/restapi/request/package-frame.html b/docs/com/neel/articleshubapi/restapi/request/package-frame.html index d36cdae..4b6c0a7 100644 --- a/docs/com/neel/articleshubapi/restapi/request/package-frame.html +++ b/docs/com/neel/articleshubapi/restapi/request/package-frame.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi.restapi.request - + diff --git a/docs/com/neel/articleshubapi/restapi/request/package-summary.html b/docs/com/neel/articleshubapi/restapi/request/package-summary.html index c62a87b..63c47a3 100644 --- a/docs/com/neel/articleshubapi/restapi/request/package-summary.html +++ b/docs/com/neel/articleshubapi/restapi/request/package-summary.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi.restapi.request - + diff --git a/docs/com/neel/articleshubapi/restapi/request/package-tree.html b/docs/com/neel/articleshubapi/restapi/request/package-tree.html index cdb56c7..c46efc6 100644 --- a/docs/com/neel/articleshubapi/restapi/request/package-tree.html +++ b/docs/com/neel/articleshubapi/restapi/request/package-tree.html @@ -2,9 +2,9 @@ - + com.neel.articleshubapi.restapi.request Class Hierarchy - + diff --git a/docs/constant-values.html b/docs/constant-values.html index 5e453f8..a175fcd 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values - + diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html index e10a5a5..2e7825f 100644 --- a/docs/deprecated-list.html +++ b/docs/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List - + diff --git a/docs/help-doc.html b/docs/help-doc.html index 79b5abc..b1e92ff 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -2,9 +2,9 @@ - + API Help - + diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index df4723b..643de1a 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -2,9 +2,9 @@ - + A-Index - + diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index e793995..635fa47 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -2,9 +2,9 @@ - + S-Index - + @@ -99,8 +99,16 @@

S

 
setEmailId(String) - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
 
+
setFirstName(String) - Method in class com.neel.articleshubapi.restapi.beans.ShortUserDetail
+
 
+
setFirstName(String) - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
+
 
setInfo(String) - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
 
+
setLastName(String) - Method in class com.neel.articleshubapi.restapi.beans.ShortUserDetail
+
 
+
setLastName(String) - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
+
 
setLink(String) - Method in class com.neel.articleshubapi.restapi.beans.ShortArticleDetail
 
setLink(String) - Method in class com.neel.articleshubapi.restapi.beans.ShortUserDetail
diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html index f95e2a6..5418807 100644 --- a/docs/index-files/index-11.html +++ b/docs/index-files/index-11.html @@ -2,9 +2,9 @@ - + T-Index - + diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html index acc7540..4edc98e 100644 --- a/docs/index-files/index-12.html +++ b/docs/index-files/index-12.html @@ -2,9 +2,9 @@ - + U-Index - + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index dd9f27d..4db0b21 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -2,9 +2,9 @@ - + C-Index - + diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index 54fd2ae..028d446 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -2,9 +2,9 @@ - + D-Index - + diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index c6fbf81..63948ab 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -2,9 +2,9 @@ - + E-Index - + diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index 5c80719..12a62a2 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -2,9 +2,9 @@ - + G-Index - + @@ -99,10 +99,24 @@

G

 
getEmailId() - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
 
+
getFirstName() - Method in class com.neel.articleshubapi.restapi.beans.ShortUserDetail
+
 
+
getFirstName() - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
+
 
+
getHttpStatus() - Method in class com.neel.articleshubapi.restapi.request.AddRequestTask
+
 
+
getHttpStatus() - Method in class com.neel.articleshubapi.restapi.request.RequestHandler
+
 
+
getHttpStatus() - Method in class com.neel.articleshubapi.restapi.request.RequestTask
+
 
getInfo() - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
 
getKey() - Method in class com.neel.articleshubapi.restapi.request.HeaderTools.EntryImp
 
+
getLastName() - Method in class com.neel.articleshubapi.restapi.beans.ShortUserDetail
+
 
+
getLastName() - Method in class com.neel.articleshubapi.restapi.beans.UserDetail
+
 
getLink(String) - Method in class com.neel.articleshubapi.restapi.beans.ArticleDetail
this method returns Link object having name specified from diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index ccb88a2..66cafc2 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -2,9 +2,9 @@ - + H-Index - + diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 227f14a..f59f944 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -2,9 +2,9 @@ - + L-Index - + diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index 638058c..8e81b7f 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -2,9 +2,9 @@ - + M-Index - + diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html index bf23515..58a181e 100644 --- a/docs/index-files/index-9.html +++ b/docs/index-files/index-9.html @@ -2,9 +2,9 @@ - + R-Index - + diff --git a/docs/index.html b/docs/index.html index d676547..147c7dd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) diff --git a/docs/overview-summary.html b/docs/overview-summary.html index b6e174c..5d0b86e 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -2,9 +2,9 @@ - + Overview - + diff --git a/docs/overview-tree.html b/docs/overview-tree.html index 0134500..01dea6a 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -2,9 +2,9 @@ - + Class Hierarchy - +