update doc at github

jknack · jknack · commit e2bb4f41d546 · 2016-03-14T09:42:30.000-03:00
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 [![Build Status](https://travis-ci.org/jooby-project/jooby.svg?branch=master)](https://travis-ci.org/jooby-project/jooby)
 [![Coverage Status](https://img.shields.io/coveralls/jooby-project/jooby.svg)](https://coveralls.io/r/jooby-project/jooby?branch=master)
+[![Issue Stats](http://issuestats.com/github/jooby-project/jooby/badge/issue?style=flat)](http://issuestats.com/github/jooby-project/jooby)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby)
-[![Slack Channel](https://img.shields.io/badge/slack-join chat-orange.svg)](https://jooby.slack.com)
+[![Dependency Status](https://www.versioneye.com/user/projects/56e6afbcdf573d00495abe4c/badge.svg?style=flat)](https://www.versioneye.com/user/projects/56e6afbcdf573d00495abe4c)
 [![Google Group](https://img.shields.io/badge/google-group-orange.svg)](https://groups.google.com/forum/#!forum/jooby-project)
 [![ASF2](http://img.shields.io/badge/license-ASF2-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
 [![Twitter](https://img.shields.io/badge/twitter--blue.svg)](https://twitter.com/joobyproject)
diff --git a/jooby-assets/README.md b/jooby-assets/README.md
@@ -122,7 +122,7 @@ assets {
 
 ## processors
 
-An [AssetProcessor](/apidocs/assets/AssetProcessor.html) usually checks or modify an asset content in one way or another. They are defined in the ```assets.conf``` files using the ```pipeline``` construction:
+An [AssetProcessor](/apidocs/org/jooby/assets/AssetProcessor.html) usually checks or modify an asset content in one way or another. They are defined in the ```assets.conf``` files using the ```pipeline``` construction:
 
 ```text
 assets {
@@ -152,7 +152,7 @@ If you want to turn it off, just set the ```assets.watch = false```.
 
 # asset processor
 
-Checks, validate and/or modify asset contents. An [AssetProcessor](/apidocs/assets/AssetProcessor.html) is usually provided as a separated dependency.
+Checks, validate and/or modify asset contents. An [AssetProcessor](/apidocs/org/jooby/assets/AssetProcessor.html) is usually provided as a separated dependency.
 
 ## how to use it?
 
diff --git a/jooby-ehcache/README.md b/jooby-ehcache/README.md
@@ -113,7 +113,7 @@ Please note the ```default``` cache works as a template and isn't a real/usable
 
 ## usage
 
-This module provides an [EhSessionStore](/apidocs/ehcache/EhSessionStore.html). In order to use the [EhSessionStore](/apidocs/ehcache/EhSessionStore.html) all
+This module provides an [EhSessionStore](/apidocs/org/jooby/ehcache/EhSessionStore.html). In order to use the [EhSessionStore](/apidocs/org/jooby/ehcache/EhSessionStore.html) all
 you have to do is define a ```session``` cache:
 
 ```properties
@@ -123,7 +123,7 @@ ehcache.cache.session {
 }
 ```
 
-And then register the [EhSessionStore](/apidocs/ehcache/EhSessionStore.html):
+And then register the [EhSessionStore](/apidocs/org/jooby/ehcache/EhSessionStore.html):
 
 ```java
 {
diff --git a/jooby-ftl/README.md b/jooby-ftl/README.md
@@ -1,6 +1,6 @@
 # freemarker
 
-[Freemarker](http://freemarker.org) templates for [Jooby](/). Exposes a Configuration and [renderer](/apidocs/Renderer.html).
+[Freemarker](http://freemarker.org) templates for [Jooby](/). Exposes a Configuration and [renderer](/apidocs/org/jooby/Renderer.html).
 
 ## dependency
 
diff --git a/jooby-hazelcast/README.md b/jooby-hazelcast/README.md
@@ -1,6 +1,6 @@
 # hazelcast
 
-Exports a [Hazelcast](http://hazelcast.org) instances and optionally a [session store](/apidocs/hazelcast/HcastSessionStore.html) session store.
+Exports a [Hazelcast](http://hazelcast.org) instances and optionally a [session store](/apidocs/org/jooby/hazelcast/HcastSessionStore.html) session store.
 
 ## dependency
 
diff --git a/jooby-hbs/README.md b/jooby-hbs/README.md
@@ -1,6 +1,6 @@
 # handlebars
 
-Mustache/Handlebars templates for [Jooby](/). Exposes a [Handlebars](https://github.com/jknack/handlebars.java) and [renderer](/apidocs/Renderer.html).
+Mustache/Handlebars templates for [Jooby](/). Exposes a [Handlebars](https://github.com/jknack/handlebars.java) and [renderer](/apidocs/org/jooby/Renderer.html).
 
 ## dependency
 
diff --git a/jooby-hbv/README.md b/jooby-hbv/README.md
@@ -55,7 +55,7 @@ The previous example can be rewritten as:
 }
 ```
 
-Here a [Parser](/apidocs/Parser.html) will do the boilerplate part and throws a ```ConstraintViolationException```.
+Here a [Parser](/apidocs/org/jooby/Parser.html) will do the boilerplate part and throws a ```ConstraintViolationException```.
 
 ### rendering a ```ConstraintViolationException```
 
diff --git a/jooby-jongo/README.md b/jooby-jongo/README.md
@@ -1,5 +1,5 @@
 # jongo
-Exposes [Jongo](http://jongo.org) instances to a default database. Or [JongoFactory](/apidocs/mongodb/JongoFactory.html) to use alternative databases.
+Exposes [Jongo](http://jongo.org) instances to a default database. Or [JongoFactory](/apidocs/org/jooby/mongodb/JongoFactory.html) to use alternative databases.
 
 Please note, this module depends on: [mongodb](https://github.com/jooby-project/jooby/tree/master/jooby-mongodb) module.
 
@@ -27,7 +27,7 @@ Please note, this module depends on: [mongodb](https://github.com/jooby-project/
 
 Previous example will give you a [Jongo](http://jongo.org) instance connected to the default database, provided by the [mongodb](https://github.com/jooby-project/jooby/tree/master/jooby-mongodb)  module.
 
-Access to alternate database is provided via: [JongoFactory](/apidocs/mongodb/JongoFactory.html).
+Access to alternate database is provided via: [JongoFactory](/apidocs/org/jooby/mongodb/JongoFactory.html).
 
 ```java
 {
diff --git a/jooby-metrics/README.md b/jooby-metrics/README.md
@@ -58,7 +58,7 @@ Health checks are available at ```/sys/healthCheck``` via:
 
 ## instrumented requests
 
-Captures request information (like active requests or min/mean/max execution time) and a breakdown of the response codes being returned: [InstrumentedHandler](/apidocs/assets/InstrumentedHandler.html).
+Captures request information (like active requests or min/mean/max execution time) and a breakdown of the response codes being returned: [InstrumentedHandler](/apidocs/org/jooby/assets/InstrumentedHandler.html).
 
 ```java
  use(new Metrics()
@@ -89,6 +89,6 @@ Reporters are appended via a callback API:
  }
 ```
 
-You can add all the reporters you want. Keep in mind you have to start them (if need it), but you don't have to stop them as long they implements the [Closeable](/apidocs/assets/Closeable.html) interface.
+You can add all the reporters you want. Keep in mind you have to start them (if need it), but you don't have to stop them as long they implements the [Closeable](/apidocs/org/jooby/assets/Closeable.html) interface.
 
 That's all folks!
diff --git a/jooby-mongodb/README.md b/jooby-mongodb/README.md
@@ -2,7 +2,7 @@
 
 [MongoDB](http://mongodb.github.io/mongo-java-driver/) driver for Jooby.
 
-Exposes a [MongoClient](http://api.mongodb.org/java/2.13/com/mongodb/MongoClient.html), a [MongoDatabase](http://api.mongodb.org/java/2.13/com/mongodb/DB.html) and a [Session Store](/apidocs/mongodb/MongoSessionStore.html)
+Exposes a [MongoClient](http://api.mongodb.org/java/2.13/com/mongodb/MongoClient.html), a [MongoDatabase](http://api.mongodb.org/java/2.13/com/mongodb/DB.html) and a [Session Store](/apidocs/org/jooby/mongodb/MongoSessionStore.html)
 
 ## dependency
 
@@ -85,7 +85,7 @@ For more detailed information please check: [MongoClientURI](http://api.mongodb.
 
 ## two or more connections
 
-Use [named](/apidocs/mongodb/Mongodb.html#-named) when you need two or more ```mongodb``` connections:
+Use [named](/apidocs/org/jooby/mongodb/Mongodb.html#-named) when you need two or more ```mongodb``` connections:
 
 ```java
 {
diff --git a/jooby-morphia/README.md b/jooby-morphia/README.md
@@ -1,6 +1,6 @@
 # morphia
 
-Extends the [mongodb](https://github.com/jooby-project/jooby/tree/master/jooby-mongodb) module with object-document mapping via [Morphia](https://github.com/mongodb/morphia).
+Extends the [mongodb](https://github.com/jooby-project/jooby/tree/master/jooby-mongodb) module with object-document mapping via [Morphia]([Morphia](https://github.com/mongodb/morphia)).
 
 Exposes a [Morphia](https://rawgit.com/wiki/mongodb/morphia/javadoc/0.111/org/mongodb/morphia/Morphia.html) and [Datastore](https://rawgit.com/wiki/mongodb/morphia/javadoc/0.111/org/mongodb/morphia/Datastore.html) services.
 
@@ -54,7 +54,7 @@ The [Morphia](https://rawgit.com/wiki/mongodb/morphia/javadoc/0.111/org/mongodb/
 }
 ```
 
-For more detailed information, check [here](https://github.com/mongodb/morphia/wiki/MappingObjects)
+For more detailed information, check [here]([Morphia](https://github.com/mongodb/morphia)/wiki/MappingObjects)
 
 ### datastore callback
 
@@ -72,7 +72,7 @@ This [Datastore](https://rawgit.com/wiki/mongodb/morphia/javadoc/0.111/org/mongo
 }
 ```
 
-For more detailed information, check [here](https://github.com/mongodb/morphia/wiki/Datastore#ensure-indexes-and-caps)
+For more detailed information, check [here]([Morphia](https://github.com/mongodb/morphia)/wiki/Datastore#ensure-indexes-and-caps)
 
 ### auto-incremental ID
 This modules comes with auto-incremental ID generation, usage:
@@ -83,7 +83,7 @@ This modules comes with auto-incremental ID generation, usage:
 }
 ```
 
-ID must be of type: ```Long``` and annotated with [GeneratedValue](/apidocs/GeneratedValue.html):
+ID must be of type: ```Long``` and annotated with [GeneratedValue](/apidocs/org/jooby/GeneratedValue.html):
 
 ```java
 @Entity
diff --git a/jooby-pac4j/README.md b/jooby-pac4j/README.md
@@ -5,9 +5,9 @@ Authentication module via: [Pac4j](https://github.com/pac4j/pac4j).
 ## exposes
 
 * ```Clients```
-* ```WebContext``` as [RequestScoped](/apidocs/RequestedScoped.html)
-* [auth filter](/apidocs/Route.Filter.html) per ```Client```
-* [auth callback](/apidocs/Route.Filter.html)
+* ```WebContext``` as [RequestScoped](/apidocs/org/jooby/RequestedScoped.html)
+* [auth filter](/apidocs/org/jooby/Route.Filter.html) per ```Client```
+* [auth callback](/apidocs/org/jooby/Route.Filter.html)
 
 ## dependency
 
@@ -83,7 +83,7 @@ Like basic auth, form auth depends on a ```UsernamePasswordAuthenticator```.
 
 A login form will be ready under the path: ```/login```. Again, it is a very basic login
 form useful for development. If you need a custom login page, just add a route before the
-[Auth](/apidocs/pack4j/Auth.html) module, like:
+[Auth](/apidocs/org/jooby/pack4j/Auth.html) module, like:
 </p>
 
 ```java
@@ -134,7 +134,7 @@ under ```/private```.
 
 ## user profile
 
-[Jooby](http://jooby.org) relies on [AuthStore](/apidocs/pac4j/AuthStore.html) for saving and retrieving an ```UserProfile```. By default,
+[Jooby](http://jooby.org) relies on [AuthStore](/apidocs/org/jooby/pac4j/AuthStore.html) for saving and retrieving an ```UserProfile```. By default,
 the ```UserProfile``` is stored in the [Session]({{defcods}}/Session.html) via [auth session store]({{defcods}}/pack4j/AuthSessionStore.html)
 
 After a successful authentication the ```UserProfile``` is accessible as a request scoped attribute:
@@ -157,7 +157,7 @@ facebook (or any oauth, openid, etc...)
 }
 ```
 
-Custom [AuthStore](/apidocs/pac4j/AuthStore.html) is provided via [Auth#store](/apidocs/pac4j/Auth.html) method:
+Custom [AuthStore](/apidocs/org/jooby/pac4j/AuthStore.html) is provided via [Auth#store](/apidocs/org/jooby/pac4j/Auth.html) method:
 
 ```java
 {
@@ -170,7 +170,7 @@ Custom [AuthStore](/apidocs/pac4j/AuthStore.html) is provided via [Auth#store](/
 ## logout
 
 A default ```/logout``` handler is provided it too. The handler will remove the profile
-from [AuthStore](/apidocs/pac4j/AuthStore.html) by calling the [AuthStore#unset](/apidocs/pac4j/AuthStore.html) method. The default login
+from [AuthStore](/apidocs/org/jooby/pac4j/AuthStore.html) by calling the [AuthStore#unset](/apidocs/org/jooby/pac4j/AuthStore.html) method. The default login
 will redirect to ```/```.
 
 A custom logout and redirect urls can be set via ```.conf``` file or programmatically:
diff --git a/jooby/src/main/java/org/jooby/Request.java b/jooby/src/main/java/org/jooby/Request.java
@@ -637,7 +637,7 @@ default <T> T require(final TypeLiteral<T> type) {
   /**
    * Get a list of locale that best matches the current request as per {@link Locale::filter}.
    *
-   * @return A list of matching locales.
+   * @return A list of matching locales or empty list.
    */
   default List<Locale> locales() {
     return locales(Locale::filter);
@@ -657,6 +657,7 @@ default List<Locale> locales() {
    * req.locales(Locale::filter)
    * }</pre>
    *
+   * @param filter A locale filter.
    * @return A list of matching locales.
    */
   List<Locale> locales(BiFunction<List<Locale.LanguageRange>, List<Locale>, List<Locale>> filter);
@@ -675,6 +676,7 @@ default List<Locale> locales() {
    * req.locale(Locale::lookup)
    * }</pre>
    *
+   * @param filter A locale filter.
    * @return A matching locale.
    */
   Locale locale(BiFunction<List<Locale.LanguageRange>, List<Locale>, Locale> filter);
@@ -686,8 +688,7 @@ default List<Locale> locales() {
    * @return A matching locale.
    */
   default Locale locale() {
-    return locale((ranges, locales) ->
-      Locale.filter(ranges, locales).stream()
+    return locale((ranges, locales) -> Locale.filter(ranges, locales).stream()
         .findFirst()
         .orElse(locales.get(0)));
   }
diff --git a/jooby/src/main/java/org/jooby/internal/RequestImpl.java b/jooby/src/main/java/org/jooby/internal/RequestImpl.java
@@ -23,7 +23,6 @@
 import java.io.File;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
diff --git a/jooby/src/main/resources/org/jooby/jooby.conf b/jooby/src/main/resources/org/jooby/jooby.conf
@@ -36,8 +36,7 @@ application {
   # number format, system default. set it at runtime
   # numberFormat = DecimalFormat.getInstance(${application.lang})).toPattern()
 
-  # lang (a.k.a locale), system default. set it at runtime
-  # use tag format, for example en-us but not en_US
+  # comma separated list of locale using the language tag format. Default to: Locale.getDefault()
   # lang = Locale.getDefault()
 
   # timezone, system default. set it at runtime
diff --git a/md/README.md b/md/README.md
@@ -1,7 +1,8 @@
 [![Build Status](https://travis-ci.org/jooby-project/jooby.svg?branch=master)](https://travis-ci.org/jooby-project/jooby)
 [![Coverage Status](https://img.shields.io/coveralls/jooby-project/jooby.svg)](https://coveralls.io/r/jooby-project/jooby?branch=master)
+[![Issue Stats](http://issuestats.com/github/jooby-project/jooby/badge/issue?style=flat)](http://issuestats.com/github/jooby-project/jooby)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby)
-[![Slack Channel](https://img.shields.io/badge/slack-join chat-orange.svg)](https://jooby.slack.com)
+[![Dependency Status](https://www.versioneye.com/user/projects/56e6afbcdf573d00495abe4c/badge.svg?style=flat)](https://www.versioneye.com/user/projects/56e6afbcdf573d00495abe4c)
 [![Google Group](https://img.shields.io/badge/google-group-orange.svg)](https://groups.google.com/forum/#!forum/jooby-project)
 [![ASF2](http://img.shields.io/badge/license-ASF2-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
 [![Twitter](https://img.shields.io/badge/twitter--blue.svg)](https://twitter.com/joobyproject)

Original file line number	Diff line number	Diff line change
@@ -113,7 +113,7 @@ Please note the ```default``` cache works as a template and isn't a real/usable
`113`	`113`
`114`	`114`	`## usage`
`115`	`115`
`116`		`-This module provides an [EhSessionStore](/apidocs/ehcache/EhSessionStore.html). In order to use the [EhSessionStore](/apidocs/ehcache/EhSessionStore.html) all`
	`116`	`+This module provides an [EhSessionStore](/apidocs/org/jooby/ehcache/EhSessionStore.html). In order to use the [EhSessionStore](/apidocs/org/jooby/ehcache/EhSessionStore.html) all`
`117`	`117`	you have to do is define a ```session``` cache:
`118`	`118`
`119`	`119`	```properties
`@@ -123,7 +123,7 @@ ehcache.cache.session {`
`123`	`123`	`}`
`124`	`124`	```
`125`	`125`
`126`		`-And then register the [EhSessionStore](/apidocs/ehcache/EhSessionStore.html):`
	`126`	`+And then register the [EhSessionStore](/apidocs/org/jooby/ehcache/EhSessionStore.html):`
`127`	`127`
`128`	`128`	```java
`129`	`129`	`{`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ The previous example can be rewritten as:`
`55`	`55`	`}`
`56`	`56`	```
`57`	`57`
`58`		-Here a [Parser](/apidocs/Parser.html) will do the boilerplate part and throws a ```ConstraintViolationException```.
	`58`	+Here a [Parser](/apidocs/org/jooby/Parser.html) will do the boilerplate part and throws a ```ConstraintViolationException```.
`59`	`59`
`60`	`60`	### rendering a ```ConstraintViolationException```
`61`	`61`