Skip to content

Javadoc and serialVersionUID #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion http-api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
<relativePath>..</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
package io.avaje.http.api;

class DefaultException extends Exception {}
class DefaultException extends Exception {

private static final long serialVersionUID = 1;

}
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
* This also serves as a mapping hint if the annotation itself does not narrow the exception
* types through its {@link #value()}.
* <li>Request and/or response objects (typically from the microframework). You may choose any
* specific request/response type, e.g. Javalin's {@link io.javalin.Context} or Helidon's
* Request/ServerResponse.
* specific request/response type, e.g. Javalin's {@code io.javalin.Context} or Helidon's
* ServerRequest/ServerResponse.
* </ol>
*
* <p>Handler methods may be void or return an object for serialization.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
*/
public class InvalidPathArgumentException extends InvalidTypeArgumentException {

private static final long serialVersionUID = 1;

/**
* Construct with a message.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
*/
public class InvalidTypeArgumentException extends IllegalArgumentException {

private static final long serialVersionUID = 1;

/**
* Construct with a message.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ public static int asInt(String value) {
}

/** Convert to enum. */
@SuppressWarnings({"unchecked", "rawtypes"})
public static <T> Enum asEnum(Class<T> clazz, String value) {
checkNull(value);
try {
Expand Down
3 changes: 2 additions & 1 deletion http-api/src/main/java/io/avaje/http/api/Post.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
*
* @Post
* void save(Customer customer) {
...
* ...
* }
* }</pre>
*/
@Target(METHOD)
@Retention(RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
*/
public class RequiredArgumentException extends IllegalArgumentException {

private static final long serialVersionUID = 1;

private String property;

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.avaje.http.api;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

Expand Down Expand Up @@ -67,7 +68,9 @@ public void setErrors(List<Violation> errors) {
}

/** Error details including the field, error message and path */
public static class Violation {
public static class Violation implements Serializable {

private static final long serialVersionUID = 1;

protected String path;
protected String field;
Expand Down
4 changes: 2 additions & 2 deletions http-client-gson-adapter/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>avaje-http-client-gson</artifactId>
Expand All @@ -20,7 +20,7 @@
<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-client</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
<scope>provided</scope>
</dependency>

Expand Down
2 changes: 1 addition & 1 deletion http-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>avaje-http-client</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion http-generator-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>avaje-http-client-generator</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion http-generator-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>avaje-http-generator-core</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ public Segment segment(String varName) {
}

/**
* Return full path with <code>{}</code for named path params.
* Return full path with <code>{}</code> for named path params.
*/
public String fullPath() {
return fullPath("{", "}");
Expand Down
2 changes: 1 addition & 1 deletion http-generator-helidon/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<artifactId>avaje-http-parent</artifactId>
<groupId>io.avaje</groupId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>avaje-http-helidon-generator</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion http-generator-javalin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>avaje-http-javalin-generator</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@
*
* @After
* void save(Customer customer) {
* ...
* ...
* }
*
* }</pre>
*/
@Target(METHOD)
@Retention(SOURCE)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@
*
* @Before
* void save(Customer customer) {
* ...
* ...
* }
*
* }</pre>
*/
@Target(METHOD)
@Retention(SOURCE)
Expand Down
2 changes: 1 addition & 1 deletion http-generator-jex/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>avaje-http-jex-generator</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion http-inject-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
<relativePath>..</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<groupId>io.avaje</groupId>
<artifactId>avaje-http-parent</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
<packaging>pom</packaging>

<scm>
Expand Down
2 changes: 1 addition & 1 deletion tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<artifactId>avaje-http-parent</artifactId>
<groupId>io.avaje</groupId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion tests/test-client-generation/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>tests</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>test-client-generation</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion tests/test-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>tests</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>test-client</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion tests/test-javalin-jsonb/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>tests</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>test-javalin-jsonb</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion tests/test-javalin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>tests</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>test-javalin</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion tests/test-jex/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>tests</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>test-jex</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion tests/test-nima-jsonb/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>tests</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>test-nima-jsonb</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion tests/test-nima/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>tests</artifactId>
<version>2.0-RC2</version>
<version>2.0-RC3</version>
</parent>

<artifactId>test-nima</artifactId>
Expand Down