Binding Annotations

All of the binding annotations support customization of the name of the variable being bound from with their name member.

The following table summarizes the annotations, their purpose and provides an example:

When a value is not specified to any binding annotation then the parameter name is used. In other words the following two methods are equivalent and both bind from a cookie called myCookie:

    @Get("/cookieName")
    public String cookieName(@CookieValue("myCookie") String myCookie) {
        // ...
    }
    @Get("/cookieInferred")
    public String cookieInferred(@CookieValue String myCookie) {
        // ...
    }

    @Get("/cookieName")
    String cookieName(@CookieValue("myCookie") String myCookie) {
        // ...
    }
    @Get("/cookieInferred")
    String cookieInferred(@CookieValue String myCookie) {
        // ...
    }

    @Get("/cookieName")
    fun cookieName(@CookieValue("myCookie") myCookie: String): String {
        // ...
    }
    @Get("/cookieInferred")
    fun cookieInferred(@CookieValue myCookie: String): String {
        // ...
    }

Because hyphens are not allowed in variable names it may be necessary to set the name in the annotation. The following two definitions are equivalent:

    @Get("/headerName")
    public String headerName(@Header("Content-Type") String contentType) {
        // ...
    }
    @Get("/headerInferred")
    public String headerInferred(@Header String contentType) {
        // ...
    }

    @Get("/headerName")
    String headerName(@Header("Content-Type") String contentType) {
        // ...
    }
    @Get("/headerInferred")
    String headerInferred(@Header String contentType) {
        // ...
    }

    @Get("/headerName")
    fun headerName(@Header("Content-Type") contentType: String): String {
        // ...
    }
    @Get("/headerInferred")
    fun headerInferred(@Header contentType: String): String {
        // ...
    }