Skip to content

Commit

Permalink
Improve Javadoc markup
Browse files Browse the repository at this point in the history
  • Loading branch information
arteam committed Jan 14, 2022
1 parent 7d57ca6 commit 2d07a50
Show file tree
Hide file tree
Showing 15 changed files with 23 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@
/**
* Date: 8/9/14
* Time: 8:58 PM
* <p> JSON-RPC client. Represents a factory for a fluent client API {@link RequestBuilder}.
* It's parametrized by {@link Transport} and Jackson {@link ObjectMapper}</p>
* <p>
* JSON-RPC client. Represents a factory for a fluent client API {@link RequestBuilder}.
* It's parametrized by {@link Transport} and Jackson {@link ObjectMapper}
*/
public class JsonRpcClient {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/**
* Date: 11/4/14
* Time: 10:14 PM
* <p>
* Style of JSON-RPC parameters representation (map or array)
*/
public enum ParamsType {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
/**
* Date: 10/12/14
* Time: 6:48 PM
* <p>
* Abstract builder for JSON-RPC requests
*/
public class AbstractBuilder {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@
/**
* Date: 10/12/14
* Time: 6:23 PM
* <p> Fluent builder of batch JSON-RPC requests</p>
* <p> It provides facility to create a list of requests, set expected response types,
* <p>Fluent builder of batch JSON-RPC requests</p>
* <p>It provides facility to create a list of requests, set expected response types,
* execute the JSON-RPC request and process the JSON-RPC response.</p>
* <p> Return type is a map of responses (Java objects) by request ids. In cases of errors it throws
* <p>Return type is a map of responses (Java objects) by request ids. In cases of errors it throws
* {@link JsonRpcBatchException} with detailed status of success and failed requests.</p>
* <p> It delegates JSON processing to Jackson {@link ObjectMapper} and actual request performing to
* {@link Transport}.</p>
* <p> The basic pattern is following:</p>
* <p>The basic pattern is following:</p>
* <pre>{@code
* Map<String, Player> result = client.createBatchRequest()
* .add("43121", "findByInitials", "Steven", "Stamkos")
Expand Down Expand Up @@ -562,7 +562,6 @@ private void checkIdType(Object id) {
}
}


private List<?> requestIds() {
List<Object> ids = new ArrayList<Object>(requests.size());
for (ObjectNode request : requests) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
/**
* Date: 24.08.14
* Time: 17:33
* Proxy for accessing a remote JSON-RPC service trough an interface.
* <p>
* Proxy for accessing a remote JSON-RPC service through an interface.
*/
public class ObjectApiBuilder extends AbstractBuilder implements InvocationHandler {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
/**
* Date: 11/17/14
* Time: 8:04 PM
* <p>
* Utility class for gathering meta-information about client proxies through reflection
*/
class Reflections {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@
/**
* Date: 8/9/14
* Time: 9:04 PM
* <p> Type-safe builder of JSON-RPC requests.</p>
* <p> It introduces fluent API to build a request, set an expected response type and perform the request.
* <p>Type-safe builder of JSON-RPC requests.</p>
* <p>It introduces fluent API to build a request, set an expected response type and perform the request.
* Builder is immutable: every mutation creates a new object, so it's safe to use
* in multi-threaded environment.</p>
* <p> It delegates JSON processing to Jackson {@link ObjectMapper} and actual request performing
* <p>It delegates JSON processing to Jackson {@link ObjectMapper} and actual request performing
* to {@link Transport}.</p>
*/
public class RequestBuilder<T> extends AbstractBuilder {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
/**
* Date: 10/13/14
* Time: 8:17 PM
* <p>
* Exception that occurs when batch JSON-RPC request is not completely successful
*/
public class JsonRpcBatchException extends RuntimeException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
/**
* Date: 8/9/14
* Time: 10:08 PM
* <p>
* Represents JSON-RPC error returned by a server
*/
public class JsonRpcException extends RuntimeException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
/**
* Date: 8/1/14
* Time: 7:42 PM
* <p>
* Metadata about a Java class
*/
public class ClassMetadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Date: 8/1/14
* Time: 7:42 PM
* <p>
* Metadata about a Java method
*/
public class MethodMetadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/**
* Date: 8/1/14
* Time: 7:44 PM
* <p>
* Method parameter metadata
*/
public class ParameterMetadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
/**
* Date: 8/1/14
* Time: 7:42 PM
* <p>
* Metadata about a Java class
*/
public class ClassMetadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Date: 8/1/14
* Time: 7:42 PM
* <p>
* Metadata about a Java method
*/
public class MethodMetadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
/**
* Date: 8/1/14
* Time: 7:44 PM
* <p>
* Method parameter metadata
*/
public class ParameterMetadata {
Expand Down

0 comments on commit 2d07a50

Please sign in to comment.