Add Nonnull annotations

jknack · jknack · commit ba297bfc7f8f · 2019-02-18T11:47:23.000-03:00
diff --git a/jooby/src/main/java/io/jooby/Jooby.java b/jooby/src/main/java/io/jooby/Jooby.java
@@ -83,11 +83,11 @@ public Jooby() {
 
   }
 
-  public Env environment() {
+  public @Nonnull Env environment() {
     return environment;
   }
 
-  public Jooby environment(@Nonnull Env environment) {
+  public @Nonnull Jooby environment(@Nonnull Env environment) {
     this.environment = environment;
     if (tmpdir == null) {
       tmpdir = Paths.get(environment.get("application.tmpdir").value()).toAbsolutePath();
@@ -105,23 +105,23 @@ public Jooby environment(@Nonnull Env environment) {
     return this;
   }
 
-  public Jooby onStart(@Nonnull Throwing.Runnable task) {
+  public @Nonnull Jooby onStart(@Nonnull Throwing.Runnable task) {
     if (startCallbacks == null) {
       startCallbacks = new ArrayList<>();
     }
     startCallbacks.add(task);
     return this;
   }
 
-  public Jooby onStarted(@Nonnull Throwing.Runnable task) {
+  public @Nonnull Jooby onStarted(@Nonnull Throwing.Runnable task) {
     if (readyCallbacks == null) {
       readyCallbacks = new ArrayList<>();
     }
     readyCallbacks.add(task);
     return this;
   }
 
-  public Jooby onStop(@Nonnull Throwing.Runnable task) {
+  public @Nonnull Jooby onStop(@Nonnull Throwing.Runnable task) {
     if (stopCallbacks == null) {
       stopCallbacks = new LinkedList<>();
     }
@@ -246,7 +246,7 @@ public Jooby errorCode(@Nonnull Class<? extends Throwable> type,
     return router.worker();
   }
 
-  @Nonnull @Override public Jooby worker(Executor worker) {
+  @Nonnull @Override public Jooby worker(@Nonnull Executor worker) {
     this.router.worker(worker);
     if (worker instanceof ExecutorService) {
       onStop(((ExecutorService) worker)::shutdown);
@@ -260,64 +260,64 @@ public Jooby errorCode(@Nonnull Class<? extends Throwable> type,
   }
 
   /** Log: */
-  public Logger log() {
+  public @Nonnull Logger log() {
     return LoggerFactory.getLogger(getClass());
   }
 
   @Nonnull @Override public ErrorHandler errorHandler() {
     return router.errorHandler();
   }
 
-  public Path tmpdir() {
+  public @Nonnull Path tmpdir() {
     return tmpdir;
   }
 
-  public Jooby tmpdir(@Nonnull Path tmpdir) {
+  public @Nonnull Jooby tmpdir(@Nonnull Path tmpdir) {
     this.tmpdir = tmpdir;
     return this;
   }
 
-  public ExecutionMode mode() {
-    return mode;
+  public @Nonnull ExecutionMode mode() {
+    return mode == null ? ExecutionMode.DEFAULT : mode;
   }
 
-  public Jooby mode(ExecutionMode mode) {
+  public @Nonnull Jooby mode(@Nonnull ExecutionMode mode) {
     this.mode = mode;
     return this;
   }
 
-  public <T> T require(Class<T> type) {
+  public @Nonnull <T> T require(@Nonnull Class<T> type) {
     return findService(type, type.getName());
   }
 
-  public <T> T require(Class<T> type, String name) {
+  public @Nonnull <T> T require(@Nonnull Class<T> type, @Nonnull String name) {
     return findService(type, type.getName() + "." + name);
   }
 
-  private <T> T findService(Class<T> type, String key) {
+  private @Nonnull <T> T findService(@Nonnull Class<T> type, @Nonnull String key) {
     Object service = services.get(key);
     if (service == null) {
       throw new IllegalStateException("Service not found: " + type);
     }
     return type.cast(service);
   }
 
-  public <T> Jooby addService(@Nonnull Class<T> type, @Nonnull T service) {
+  public @Nonnull <T> Jooby addService(@Nonnull Class<T> type, @Nonnull T service) {
     putService(type, null, service);
     return this;
   }
 
-  public <T> Jooby addService(@Nonnull T service) {
+  public @Nonnull <T> Jooby addService(@Nonnull T service) {
     putService(service.getClass(), null, service);
     return this;
   }
 
-  public <T> Jooby addService(@Nonnull String name, @Nonnull T service) {
+  public @Nonnull <T> Jooby addService(@Nonnull String name, @Nonnull T service) {
     putService(service.getClass(), name, service);
     return this;
   }
 
-  public <T> Jooby addService(@Nonnull Class<T> type, @Nonnull String name, @Nonnull T service) {
+  public @Nonnull <T> Jooby addService(@Nonnull Class<T> type, @Nonnull String name, @Nonnull T service) {
     putService(type, name, service);
     return this;
   }
@@ -333,7 +333,7 @@ private void putService(@Nonnull Class type, String name, @Nonnull Object servic
   }
 
   /** Boot: */
-  public Server start() {
+  public @Nonnull Server start() {
     List<Server> servers = stream(
         spliteratorUnknownSize(
             ServiceLoader.load(Server.class).iterator(),
@@ -356,7 +356,7 @@ public Server start() {
     return server.start(this);
   }
 
-  public Jooby start(Server server) {
+  public @Nonnull Jooby start(@Nonnull Server server) {
     /** Start router: */
     ensureTmpdir(tmpdir);
     Logger log = log();
@@ -372,7 +372,7 @@ public Jooby start(Server server) {
     return this;
   }
 
-  public Jooby ready(Server server) {
+  public @Nonnull Jooby ready(@Nonnull Server server) {
     Logger log = log();
 
     fireStarted();
@@ -393,7 +393,7 @@ public Jooby ready(Server server) {
     return this;
   }
 
-  public Jooby stop() {
+  public @Nonnull Jooby stop() {
     if (router != null) {
       router.destroy();
       router = null;
@@ -403,7 +403,7 @@ public Jooby stop() {
     return this;
   }
 
-  public Jooby configureServer(Consumer<Server> configurer) {
+  public @Nonnull Jooby configureServer(@Nonnull Consumer<Server> configurer) {
     this.serverConfigurer = configurer;
     return this;
   }
@@ -412,15 +412,15 @@ public Jooby configureServer(Consumer<Server> configurer) {
     return router.toString();
   }
 
-  public static void setEnv(Env environment) {
+  public static void setEnv(@Nonnull Env environment) {
     ENV.set(environment);
   }
 
-  public static void run(Supplier<Jooby> provider, String... args) {
+  public static void run(@Nonnull Supplier<Jooby> provider, String... args) {
     run(provider, ExecutionMode.DEFAULT, args);
   }
 
-  public static void run(Supplier<Jooby> provider, ExecutionMode mode, String... args) {
+  public static void run(@Nonnull Supplier<Jooby> provider, @Nonnull ExecutionMode mode, String... args) {
     Server server;
     try {
       Env environment = Env.defaultEnvironment(args);
@@ -440,7 +440,7 @@ public static void run(Supplier<Jooby> provider, ExecutionMode mode, String... a
     server.join();
   }
 
-  public static void logback(Env env) {
+  public static void logback(@Nonnull Env env) {
     String setfile = env.get("logback.configurationFile").value((String) null);
     if (setfile != null) {
       System.setProperty("logback.configurationFile", setfile);
diff --git a/jooby/src/main/java/io/jooby/Router.java b/jooby/src/main/java/io/jooby/Router.java
@@ -35,11 +35,11 @@ public interface Router {
   interface Match {
     boolean matches();
 
-    Route route();
+    @Nonnull Route route();
 
-    void execute(Context context);
+    void execute(@Nonnull Context context);
 
-    Map<String, String> pathMap();
+    @Nonnull Map<String, String> pathMap();
   }
 
   /** HTTP Methods: */
@@ -203,9 +203,9 @@ default Router error(@Nonnull Predicate<StatusCode> predicate,
 
   @Nonnull ErrorHandler errorHandler();
 
-  Logger log();
+  @Nonnull Logger log();
 
-  static String normalizePath(@Nonnull String path, boolean caseSensitive,
+  static @Nonnull String normalizePath(@Nonnull String path, boolean caseSensitive,
       boolean ignoreTrailingSlash) {
     if (path == null || path.length() == 0 || path.equals("/")) {
       return "/";
@@ -247,7 +247,7 @@ static String normalizePath(@Nonnull String path, boolean caseSensitive,
     return path;
   }
 
-  static List<String> pathKeys(String pattern) {
+  static @Nonnull List<String> pathKeys(@Nonnull String pattern) {
     List<String> result = new ArrayList<>();
     int start = -1;
     int end = Integer.MAX_VALUE;

Original file line number	Diff line number	Diff line change
`@@ -83,11 +83,11 @@ public Jooby() {`
`83`	`83`
`84`	`84`	`}`
`85`	`85`
`86`		`- public Env environment() {`
	`86`	`+ public @Nonnull Env environment() {`
`87`	`87`	`return environment;`
`88`	`88`	`}`
`89`	`89`
`90`		`- public Jooby environment(@Nonnull Env environment) {`
	`90`	`+ public @Nonnull Jooby environment(@Nonnull Env environment) {`
`91`	`91`	`this.environment = environment;`
`92`	`92`	`if (tmpdir == null) {`
`93`	`93`	`tmpdir = Paths.get(environment.get("application.tmpdir").value()).toAbsolutePath();`
`@@ -105,23 +105,23 @@ public Jooby environment(@Nonnull Env environment) {`
`105`	`105`	`return this;`
`106`	`106`	`}`
`107`	`107`
`108`		`- public Jooby onStart(@Nonnull Throwing.Runnable task) {`
	`108`	`+ public @Nonnull Jooby onStart(@Nonnull Throwing.Runnable task) {`
`109`	`109`	`if (startCallbacks == null) {`
`110`	`110`	`startCallbacks = new ArrayList<>();`
`111`	`111`	`}`
`112`	`112`	`startCallbacks.add(task);`
`113`	`113`	`return this;`
`114`	`114`	`}`
`115`	`115`
`116`		`- public Jooby onStarted(@Nonnull Throwing.Runnable task) {`
	`116`	`+ public @Nonnull Jooby onStarted(@Nonnull Throwing.Runnable task) {`
`117`	`117`	`if (readyCallbacks == null) {`
`118`	`118`	`readyCallbacks = new ArrayList<>();`
`119`	`119`	`}`
`120`	`120`	`readyCallbacks.add(task);`
`121`	`121`	`return this;`
`122`	`122`	`}`
`123`	`123`
`124`		`- public Jooby onStop(@Nonnull Throwing.Runnable task) {`
	`124`	`+ public @Nonnull Jooby onStop(@Nonnull Throwing.Runnable task) {`
`125`	`125`	`if (stopCallbacks == null) {`
`126`	`126`	`stopCallbacks = new LinkedList<>();`
`127`	`127`	`}`
`@@ -246,7 +246,7 @@ public Jooby errorCode(@Nonnull Class<? extends Throwable> type,`
`246`	`246`	`return router.worker();`
`247`	`247`	`}`
`248`	`248`
`249`		`- @Nonnull @Override public Jooby worker(Executor worker) {`
	`249`	`+ @Nonnull @Override public Jooby worker(@Nonnull Executor worker) {`
`250`	`250`	`this.router.worker(worker);`
`251`	`251`	`if (worker instanceof ExecutorService) {`
`252`	`252`	`onStop(((ExecutorService) worker)::shutdown);`
`@@ -260,64 +260,64 @@ public Jooby errorCode(@Nonnull Class<? extends Throwable> type,`
`260`	`260`	`}`
`261`	`261`
`262`	`262`	`/** Log: */`
`263`		`- public Logger log() {`
	`263`	`+ public @Nonnull Logger log() {`
`264`	`264`	`return LoggerFactory.getLogger(getClass());`
`265`	`265`	`}`
`266`	`266`
`267`	`267`	`@Nonnull @Override public ErrorHandler errorHandler() {`
`268`	`268`	`return router.errorHandler();`
`269`	`269`	`}`
`270`	`270`
`271`		`- public Path tmpdir() {`
	`271`	`+ public @Nonnull Path tmpdir() {`
`272`	`272`	`return tmpdir;`
`273`	`273`	`}`
`274`	`274`
`275`		`- public Jooby tmpdir(@Nonnull Path tmpdir) {`
	`275`	`+ public @Nonnull Jooby tmpdir(@Nonnull Path tmpdir) {`
`276`	`276`	`this.tmpdir = tmpdir;`
`277`	`277`	`return this;`
`278`	`278`	`}`
`279`	`279`
`280`		`- public ExecutionMode mode() {`
`281`		`- return mode;`
	`280`	`+ public @Nonnull ExecutionMode mode() {`
	`281`	`+ return mode == null ? ExecutionMode.DEFAULT : mode;`
`282`	`282`	`}`
`283`	`283`
`284`		`- public Jooby mode(ExecutionMode mode) {`
	`284`	`+ public @Nonnull Jooby mode(@Nonnull ExecutionMode mode) {`
`285`	`285`	`this.mode = mode;`
`286`	`286`	`return this;`
`287`	`287`	`}`
`288`	`288`
`289`		`- public <T> T require(Class<T> type) {`
	`289`	`+ public @Nonnull <T> T require(@Nonnull Class<T> type) {`
`290`	`290`	`return findService(type, type.getName());`
`291`	`291`	`}`
`292`	`292`
`293`		`- public <T> T require(Class<T> type, String name) {`
	`293`	`+ public @Nonnull <T> T require(@Nonnull Class<T> type, @Nonnull String name) {`
`294`	`294`	`return findService(type, type.getName() + "." + name);`
`295`	`295`	`}`
`296`	`296`
`297`		`- private <T> T findService(Class<T> type, String key) {`
	`297`	`+ private @Nonnull <T> T findService(@Nonnull Class<T> type, @Nonnull String key) {`
`298`	`298`	`Object service = services.get(key);`
`299`	`299`	`if (service == null) {`
`300`	`300`	`throw new IllegalStateException("Service not found: " + type);`
`301`	`301`	`}`
`302`	`302`	`return type.cast(service);`
`303`	`303`	`}`
`304`	`304`
`305`		`- public <T> Jooby addService(@Nonnull Class<T> type, @Nonnull T service) {`
	`305`	`+ public @Nonnull <T> Jooby addService(@Nonnull Class<T> type, @Nonnull T service) {`
`306`	`306`	`putService(type, null, service);`
`307`	`307`	`return this;`
`308`	`308`	`}`
`309`	`309`
`310`		`- public <T> Jooby addService(@Nonnull T service) {`
	`310`	`+ public @Nonnull <T> Jooby addService(@Nonnull T service) {`
`311`	`311`	`putService(service.getClass(), null, service);`
`312`	`312`	`return this;`
`313`	`313`	`}`
`314`	`314`
`315`		`- public <T> Jooby addService(@Nonnull String name, @Nonnull T service) {`
	`315`	`+ public @Nonnull <T> Jooby addService(@Nonnull String name, @Nonnull T service) {`
`316`	`316`	`putService(service.getClass(), name, service);`
`317`	`317`	`return this;`
`318`	`318`	`}`
`319`	`319`
`320`		`- public <T> Jooby addService(@Nonnull Class<T> type, @Nonnull String name, @Nonnull T service) {`
	`320`	`+ public @Nonnull <T> Jooby addService(@Nonnull Class<T> type, @Nonnull String name, @Nonnull T service) {`
`321`	`321`	`putService(type, name, service);`
`322`	`322`	`return this;`
`323`	`323`	`}`
`@@ -333,7 +333,7 @@ private void putService(@Nonnull Class type, String name, @Nonnull Object servic`
`333`	`333`	`}`
`334`	`334`
`335`	`335`	`/** Boot: */`
`336`		`- public Server start() {`
	`336`	`+ public @Nonnull Server start() {`
`337`	`337`	`List<Server> servers = stream(`
`338`	`338`	`spliteratorUnknownSize(`
`339`	`339`	`ServiceLoader.load(Server.class).iterator(),`
`@@ -356,7 +356,7 @@ public Server start() {`
`356`	`356`	`return server.start(this);`
`357`	`357`	`}`
`358`	`358`
`359`		`- public Jooby start(Server server) {`
	`359`	`+ public @Nonnull Jooby start(@Nonnull Server server) {`
`360`	`360`	`/** Start router: */`
`361`	`361`	`ensureTmpdir(tmpdir);`
`362`	`362`	`Logger log = log();`
`@@ -372,7 +372,7 @@ public Jooby start(Server server) {`
`372`	`372`	`return this;`
`373`	`373`	`}`
`374`	`374`
`375`		`- public Jooby ready(Server server) {`
	`375`	`+ public @Nonnull Jooby ready(@Nonnull Server server) {`
`376`	`376`	`Logger log = log();`
`377`	`377`
`378`	`378`	`fireStarted();`
`@@ -393,7 +393,7 @@ public Jooby ready(Server server) {`
`393`	`393`	`return this;`
`394`	`394`	`}`
`395`	`395`
`396`		`- public Jooby stop() {`
	`396`	`+ public @Nonnull Jooby stop() {`
`397`	`397`	`if (router != null) {`
`398`	`398`	`router.destroy();`
`399`	`399`	`router = null;`
`@@ -403,7 +403,7 @@ public Jooby stop() {`
`403`	`403`	`return this;`
`404`	`404`	`}`
`405`	`405`
`406`		`- public Jooby configureServer(Consumer<Server> configurer) {`
	`406`	`+ public @Nonnull Jooby configureServer(@Nonnull Consumer<Server> configurer) {`
`407`	`407`	`this.serverConfigurer = configurer;`
`408`	`408`	`return this;`
`409`	`409`	`}`
`@@ -412,15 +412,15 @@ public Jooby configureServer(Consumer<Server> configurer) {`
`412`	`412`	`return router.toString();`
`413`	`413`	`}`
`414`	`414`
`415`		`- public static void setEnv(Env environment) {`
	`415`	`+ public static void setEnv(@Nonnull Env environment) {`
`416`	`416`	`ENV.set(environment);`
`417`	`417`	`}`
`418`	`418`
`419`		`- public static void run(Supplier<Jooby> provider, String... args) {`
	`419`	`+ public static void run(@Nonnull Supplier<Jooby> provider, String... args) {`
`420`	`420`	`run(provider, ExecutionMode.DEFAULT, args);`
`421`	`421`	`}`
`422`	`422`
`423`		`- public static void run(Supplier<Jooby> provider, ExecutionMode mode, String... args) {`
	`423`	`+ public static void run(@Nonnull Supplier<Jooby> provider, @Nonnull ExecutionMode mode, String... args) {`
`424`	`424`	`Server server;`
`425`	`425`	`try {`
`426`	`426`	`Env environment = Env.defaultEnvironment(args);`
`@@ -440,7 +440,7 @@ public static void run(Supplier<Jooby> provider, ExecutionMode mode, String... a`
`440`	`440`	`server.join();`
`441`	`441`	`}`
`442`	`442`
`443`		`- public static void logback(Env env) {`
	`443`	`+ public static void logback(@Nonnull Env env) {`
`444`	`444`	`String setfile = env.get("logback.configurationFile").value((String) null);`
`445`	`445`	`if (setfile != null) {`
`446`	`446`	`System.setProperty("logback.configurationFile", setfile);`