Skip to content

Commit 6a05201

Browse files
committed
documentation: add some notes about Spring classes + nonnull by default return value
- fix #3458 - fix #3459
1 parent 7826ddd commit 6a05201

File tree

6 files changed

+59
-0
lines changed

6 files changed

+59
-0
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/** Supported annotations for creating MVC routes. */
2+
@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
3+
package io.jooby.annotation;
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Generic abstraction for working with byte buffer implementations.
2+
3+
Copy from: https://github.com/spring-projects/spring-framework/tree/main/spring-core/src/main/java/org/springframework/core/io/buffer.
4+
5+
- Copy all package inside io.jooby.byffer
6+
- remove all Assert/ObjectUtils import references
7+
- remove Netty5DataBuffer references
8+
- replace reactive stream classes references by JDK reactive streams
9+
- DataBufferUtils is a limited version of original - remove Deprecated methods
10+
- Remove all deprecated since 6.0 from DataBuffer and DataBufferFactory

jooby/src/main/java/io/jooby/buffer/package-info.java

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
/*
2+
* This file is part of Jooby.
3+
*
4+
* It is derived from Spring Framework, originally available at: https://github.com/spring-projects/spring-framework
5+
*
6+
* Spring Framework is licensed under the Apache License, Version 2.0.
7+
*
8+
* Modifications:
9+
* - Code live inside of io.jooby.buffer package
10+
* - Added DataBuffer.duplicate
11+
* - Added DataBufferFactory.wrap(byte[] bytes, int offset, int length)
12+
*
13+
* Jooby is also licensed under the Apache License, Version 2.0.
14+
*
15+
* See the LICENSE file in the root of this repository for details.
16+
*/
17+
118
/**
219
* Generic abstraction for working with byte buffer implementations.
320
*
@@ -13,4 +30,5 @@
1330
* <li>Remove all deprecated since 6.0 from DataBuffer and DataBufferFactory
1431
* </ul>
1532
*/
33+
@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
1634
package io.jooby.buffer;
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/** Built-in exceptions for common HTTP error codes. */
2+
package io.jooby.exception;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/** Built-in middleware. */
2+
@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
3+
package io.jooby.handler;
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/**
2+
* Welcome to Jooby!
3+
*
4+
* <p>Hello World:
5+
*
6+
* <pre>{@code
7+
* public class App extends Jooby {
8+
*
9+
* {
10+
* get("/", ctx -> "Hello World!");
11+
* }
12+
*
13+
* public static void main(String[] args) {
14+
* runApp(args, App::new);
15+
* }
16+
* }
17+
*
18+
* }</pre>
19+
*
20+
* More documentation at <a href="https://jooby.io">jooby.io</a>
21+
*/
22+
@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
23+
package io.jooby;

0 commit comments

Comments
 (0)