Skip to content

Commit

Permalink
docs: javadocs adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
tribiec committed Mar 21, 2024
1 parent 1d7f31f commit a4befe7
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/main/java/cl/transbank/common/IntegrationTypeHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ public class IntegrationTypeHelper {

/**
* Returns the Webpay integration type based on the provided integration type.
* @param integrationType The integration type.
* @return The Webpay integration URL.
*/
public static String getWebpayIntegrationType(
IntegrationType integrationType
Expand All @@ -27,6 +29,8 @@ public static String getWebpayIntegrationType(

/**
* Returns the Patpass integration type based on the provided integration type.
* @param integrationType The integration type.
* @return The Patpass integration URL.
*/
public static String getPatpassIntegrationType(
IntegrationType integrationType
Expand Down
12 changes: 12 additions & 0 deletions src/main/java/cl/transbank/exception/TransbankException.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ public TransbankException(String message) {

/**
* Constructs a new TransbankException with the specified detail message and error code.
* @param code The error code.
* @param message The detail message.
*/
public TransbankException(int code, String message) {
super(message);
Expand All @@ -35,6 +37,8 @@ public TransbankException(int code, String message) {

/**
* Constructs a new TransbankException with the specified detail message, error code, and cause.
* @param code The error code.
* @param message The detail message.
*/
public TransbankException(int code, String message, Throwable cause) {
super(message, cause);
Expand All @@ -43,13 +47,16 @@ public TransbankException(int code, String message, Throwable cause) {

/**
* Constructs a new TransbankException with the specified cause.
* @param cause The cause.
*/
public TransbankException(Throwable cause) {
super(cause);
}

/**
* Constructs a new TransbankException with the specified Ccode and cause.
* @param code The error code.
* @param cause The cause.
*/
public TransbankException(int code, Throwable cause) {
super(cause);
Expand All @@ -58,6 +65,11 @@ public TransbankException(int code, Throwable cause) {

/**
* Constructs a new TransbankException with the specified error code and cause.
* @param code The error code.
* @param message The detail message.
* @param cause The cause.
* @param enableSuppression Whether or not suppression is enabled or disabled.
* @param writableStackTrace Whether or not the stack trace should be writable.
*/
public TransbankException(
int code,
Expand Down
1 change: 1 addition & 0 deletions src/main/java/cl/transbank/util/HttpUtilImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,7 @@ private HttpUtilImpl() {
/**
* Returns the singleton instance of HttpUtilImpl.
* If the instance does not exist, it is created.
* @return The singleton instance of HttpUtilImpl.
*/
public static HttpUtilImpl getInstance() {
if (null == instance) synchronized (HttpUtilImpl.class) {
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/cl/transbank/util/WebpayApiResource.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public static Map<String, String> buildHeaders(Options options) {
* @param options The options for the request.
* @param clazz The class of the response.
* @return The response to the request.
* @throws TransbankException If an error occurs during the request.
*/
public static <T> T execute(
final String endpoint,
Expand All @@ -66,6 +67,7 @@ public static <T> T execute(
* @param request The request body.
* @param options The options for the request.
* @return The response to the request.
* @throws TransbankException If an error occurs during the request.
*/
public static <T> T execute(
final String endpoint,
Expand All @@ -84,6 +86,7 @@ public static <T> T execute(
* @param options The options for the request.
* @param clazz The class of the response.
* @return The response to the request.
* @throws TransbankException If an error occurs during the request.
*/
public static <T> T execute(
final String endpoint,
Expand Down Expand Up @@ -130,6 +133,7 @@ public static <T> T execute(
* @param options The options for the request.
* @param clazz The class of the response.
* @return A list of responses to the request.
* @throws TransbankException If an error occurs during the request.
*/
public static <T> List<T> executeToList(
final String endpoint,
Expand All @@ -148,6 +152,7 @@ public static <T> List<T> executeToList(
* @param options The options for the request.
* @param clazz The class of the response.
* @return A list of responses to the request.
* @throws TransbankException If an error occurs during the request.
*/
public static <T> List<T> executeToList(
final String endpoint,
Expand Down

0 comments on commit a4befe7

Please sign in to comment.