Cookie.Definition (jooby 1.2.3 API)

java.lang.Object
- org.jooby.Cookie.Definition

Enclosing interface:

Cookie
```
public static class Cookie.Definition
extends Object
```
Build a Cookie.

Since:

0.1.0

Author:

edgar

Constructor Summary

Constructors
Constructor and Description
`Definition(Cookie.Definition def)` Clone a new `cookie's definition`.
`Definition(String name)` Creates a new `cookie's definition`.
`Definition(String name, String value)` Creates a new `cookie's definition`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<String>`	`comment()`
`Cookie.Definition`	`comment(String comment)` Set cookie's comment.
`Optional<String>`	`domain()`
`Cookie.Definition`	`domain(String domain)` Set the cookie's domain.
`Optional<Boolean>`	`httpOnly()`
`Cookie.Definition`	`httpOnly(boolean httpOnly)` Set HttpOnly flag.
`Optional<Integer>`	`maxAge()` Gets the maximum age in seconds for this Cookie.
`Cookie.Definition`	`maxAge(int maxAge)` Sets the maximum age in seconds for this Cookie.
`Optional<String>`	`name()`
`Cookie.Definition`	`name(String name)` Set/Override the cookie's name.
`Optional<String>`	`path()`
`Cookie.Definition`	`path(String path)` Set the cookie's path.
`Optional<Boolean>`	`secure()`
`Cookie.Definition`	`secure(boolean secure)` True, ensure that the session cookie is only transmitted via HTTPS.
`Cookie`	`toCookie()` Produces a cookie from current definition.
`String`	`toString()`
`Optional<String>`	`value()`
`Cookie.Definition`	`value(String value)` Set the cookie's value.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Definition
```
public Definition(Cookie.Definition def)
```
    Clone a new cookie's definition.
    
    Parameters:
    
    def - A cookie's definition.
  - Definition
```
public Definition(String name,
                  String value)
```
    Creates a new cookie's definition.
    
    Parameters:
    
    name - Cookie's name.
    
    value - Cookie's value.
  - Definition
```
public Definition(String name)
```
    Creates a new cookie's definition.
    
    Parameters:
    
    name - Cookie's name.
- Method Detail
  - toCookie
```
@Nonnull
public Cookie toCookie()
```
    Produces a cookie from current definition.
    
    Returns:
    
    A new cookie.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - name
```
@Nonnull
public Cookie.Definition name(String name)
```
    Set/Override the cookie's name.
    
    Parameters:
    
    name - A cookie's name.
    
    Returns:
    
    This definition.
  - name
```
@Nonnull
public Optional<String> name()
```
    Returns:
    
    Cookie's name.
  - value
```
@Nonnull
public Cookie.Definition value(String value)
```
    Set the cookie's value.
    
    Parameters:
    
    value - A value.
    
    Returns:
    
    This definition.
  - value
```
@Nonnull
public Optional<String> value()
```
    Returns:
    
    Cookie's value.
  - domain
```
@Nonnull
public Cookie.Definition domain(String domain)
```
    Set the cookie's domain.
    
    Parameters:
    
    domain - Cookie's domain.
    
    Returns:
    
    This definition.
  - domain
```
@Nonnull
public Optional<String> domain()
```
    Returns:
    
    A cookie's domain.
  - path
```
@Nonnull
public Cookie.Definition path(String path)
```
    Set the cookie's path.
    
    Parameters:
    
    path - Cookie's path.
    
    Returns:
    
    This definition.
  - path
```
@Nonnull
public Optional<String> path()
```
    Returns:
    
    Get cookie's path.
  - comment
```
@Nonnull
public Cookie.Definition comment(String comment)
```
    Set cookie's comment.
    
    Parameters:
    
    comment - A cookie's comment.
    
    Returns:
    
    This definition.
  - comment
```
@Nonnull
public Optional<String> comment()
```
    Returns:
    
    Cookie's comment.
  - httpOnly
```
@Nonnull
public Cookie.Definition httpOnly(boolean httpOnly)
```
    Set HttpOnly flag.
    
    Parameters:
    
    httpOnly - True, for HTTP Only.
    
    Returns:
    
    This definition.
  - httpOnly
```
@Nonnull
public Optional<Boolean> httpOnly()
```
    Returns:
    
    HTTP only flag.
  - secure
```
@Nonnull
public Cookie.Definition secure(boolean secure)
```
    True, ensure that the session cookie is only transmitted via HTTPS.
    
    Parameters:
    
    secure - True, ensure that the session cookie is only transmitted via HTTPS.
    
    Returns:
    
    This definition.
  - secure
```
@Nonnull
public Optional<Boolean> secure()
```
    Returns:
    
    True, ensure that the session cookie is only transmitted via HTTPS.
  - maxAge
```
@Nonnull
public Cookie.Definition maxAge(int maxAge)
```
    Sets the maximum age in seconds for this Cookie.
    A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.
    
    A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.
    
    Parameters:
    
    maxAge - an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie.
    
    Returns:
    
    This definition.
  - maxAge
```
@Nonnull
public Optional<Integer> maxAge()
```
    Gets the maximum age in seconds for this Cookie.
    A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.
    
    A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.
    
    Returns:
    
    Cookie's max age in seconds.

Class Cookie.Definition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Definition

Definition

Definition

Method Detail

toCookie

toString

name

name

value

value

domain

domain

path

path

comment

comment

httpOnly

httpOnly

secure

secure

maxAge

maxAge