Header (Speedment - Common - REST 3.2.10 API)

java.lang.Object
- com.speedment.common.rest.Header

All Implemented Interfaces:

Option
```
public final class Header
extends Object
```
A header parameter that will become part of the connection header. This can be used to pass configuration options such as expected result type and the format of the input.

Since:

1.0.0

Author:

Emil Forslund

Nested Class Summary
- Nested classes/interfaces inherited from interface com.speedment.common.rest.Option
  Option.Type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`String`	`getKey()`	The key of this option.
`Option.Type`	`getType()`	What type of option this is.
`String`	`getValue()`	The value of this option.
`int`	`hashCode()`
`static Header`	`header(String key, String value)`	Returns a new `Header` option.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - header
```
public static Header header(String key,
                            String value)
```
    Returns a new Header option. This method is intended to be imported statically.
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    the created header
  - getType
```
public Option.Type getType()
```
    Description copied from interface: Option
    
    What type of option this is.
    
    Returns:
    
    the option type
  - getKey
```
public final String getKey()
```
    Description copied from interface: Option
    
    The key of this option.
    
    Specified by:
    
    getKey in interface Option
    
    Returns:
    
    the key
  - getValue
```
public final String getValue()
```
    Description copied from interface: Option
    
    The value of this option.
    
    Specified by:
    
    getValue in interface Option
    
    Returns:
    
    the value
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object