ConfigurableAffordance (Spring HATEOAS 1.4.0-SNAPSHOT API)

All Superinterfaces:

AffordanceOperations
```
public interface ConfigurableAffordance
extends AffordanceOperations
```
An affordance in creation. API to build up affordances manually to clearly distinguish between building the affordance and consuming the configured state.

Since:

1.3

Author:

Oliver Drotbohm

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ConfigurableAffordance`	`addParameters(QueryParameter... parameters)` Adds the given `QueryParameter`s to the `Affordance` to build.
`ConfigurableAffordance`	`andAfford(HttpMethod method)` Concludes the creation of the current `Affordance` to build and starts a new one.
`Affordances`	`build()` Builds the `Affordance` currently under construction and returns in alongside the ones already contained in the `Link` the buildup started from.
`ConfigurableAffordance`	`withInput(AffordanceModel.PayloadMetadata metadata)` Registers the given `AffordanceModel.PayloadMetadata` as input model.
`ConfigurableAffordance`	`withInput(Class<?> type)` Registers the given type as input model for the affordance.
`ConfigurableAffordance`	`withInput(ResolvableType type)` Registers the given `ResolvableType` as input model for the affordance.
`ConfigurableAffordance`	`withInputAndOutput(AffordanceModel.PayloadMetadata metadata)` Registers the given `AffordanceModel.PayloadMetadata` as input and output model.
`ConfigurableAffordance`	`withInputAndOutput(Class<?> type)` Registers the given type as input and output model for the affordance.
`ConfigurableAffordance`	`withInputAndOutput(ResolvableType type)` Registers the given `ResolvableType` as input and output model for the affordance.
`ConfigurableAffordance`	`withInputMediaType(MediaType inputMediaType)` Registers the input to expect to be of the given `MediaType`.
`ConfigurableAffordance`	`withInputMediaTypes(List<MediaType> inputMediaTypes)` Registers the given `MediaType`s as input payload media types.
`ConfigurableAffordance`	`withName(String name)` Create a new `AffordanceBuilder` by copying all attributes and replacing the name.
`ConfigurableAffordance`	`withOutput(AffordanceModel.PayloadMetadata metadata)` Registers the given `AffordanceModel.PayloadMetadata` as output model.
`ConfigurableAffordance`	`withOutput(Class<?> type)` Registers the given type as the output model.
`ConfigurableAffordance`	`withOutput(ResolvableType type)` Registers the given `ResolvableType` as the output model.
`ConfigurableAffordance`	`withParameters(List<QueryParameter> parameters)` Replaces the current `QueryParameter` list with the given ones.
`ConfigurableAffordance`	`withParameters(QueryParameter... parameters)` Replaces the current `QueryParameter` list with the given ones.
`ConfigurableAffordance`	`withTarget(Link target)` Create a new `AffordanceBuilder` by copying all attributes and replacing the target.

Methods inherited from interface org.springframework.hateoas.mediatype.AffordanceOperations
toLink

- Method Detail
  - withInputAndOutput
```
ConfigurableAffordance withInputAndOutput(Class<?> type)
```
    Registers the given type as input and output model for the affordance.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
    
    will never be null.
  - withInputAndOutput
```
ConfigurableAffordance withInputAndOutput(ResolvableType type)
```
    Registers the given ResolvableType as input and output model for the affordance.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
    
    will never be null.
  - withInputAndOutput
```
ConfigurableAffordance withInputAndOutput(AffordanceModel.PayloadMetadata metadata)
```
    Registers the given AffordanceModel.PayloadMetadata as input and output model.
    
    Parameters:
    
    metadata - must not be null.
    
    Returns:
    
    will never be null.
  - withInput
```
ConfigurableAffordance withInput(Class<?> type)
```
    Registers the given type as input model for the affordance.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
    
    will never be null.
  - withInput
```
ConfigurableAffordance withInput(ResolvableType type)
```
    Registers the given ResolvableType as input model for the affordance.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
    
    will never be null.
  - withInput
```
ConfigurableAffordance withInput(AffordanceModel.PayloadMetadata metadata)
```
    Registers the given AffordanceModel.PayloadMetadata as input model.
    
    Parameters:
    
    metadata - must not be null.
    
    Returns:
    
    will never be null.
  - withOutput
```
ConfigurableAffordance withOutput(Class<?> type)
```
    Registers the given type as the output model.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
    
    will never be null.
  - withOutput
```
ConfigurableAffordance withOutput(ResolvableType type)
```
    Registers the given ResolvableType as the output model.
    
    Parameters:
    
    type - must not be null.
    
    Returns:
    
    will never be null.
  - withOutput
```
ConfigurableAffordance withOutput(AffordanceModel.PayloadMetadata metadata)
```
    Registers the given AffordanceModel.PayloadMetadata as output model.
    
    Parameters:
    
    metadata - must not be null.
    
    Returns:
    
    will never be null.
  - withInputMediaType
```
ConfigurableAffordance withInputMediaType(MediaType inputMediaType)
```
    Registers the input to expect to be of the given MediaType.
    
    Parameters:
    
    inputMediaType - can be null.
    
    Returns:
    
    will never be null.
  - withInputMediaTypes
```
ConfigurableAffordance withInputMediaTypes(List<MediaType> inputMediaTypes)
```
    Registers the given MediaTypes as input payload media types.
    
    Parameters:
    
    inputMediaTypes - must not be null.
    
    Returns:
    
    will never be null.
  - withParameters
```
ConfigurableAffordance withParameters(QueryParameter... parameters)
```
    Replaces the current QueryParameter list with the given ones.
    
    Parameters:
    
    parameters - must not be null.
    
    Returns:
    
    will never be null.
  - withParameters
```
ConfigurableAffordance withParameters(List<QueryParameter> parameters)
```
    Replaces the current QueryParameter list with the given ones.
    
    Parameters:
    
    parameters - must not be null.
    
    Returns:
    
    will never be null.
  - addParameters
```
ConfigurableAffordance addParameters(QueryParameter... parameters)
```
    Adds the given QueryParameters to the Affordance to build.
    
    Parameters:
    
    parameters - must not be null.
    
    Returns:
    
    will never be null.
  - andAfford
```
ConfigurableAffordance andAfford(HttpMethod method)
```
    Concludes the creation of the current Affordance to build and starts a new one.
    
    Parameters:
    
    method - must not be null.
    
    Returns:
    
    See Also:
    
    build(), AffordanceOperations.toLink()
  - build
```
Affordances build()
```
    Builds the Affordance currently under construction and returns in alongside the ones already contained in the Link the buildup started from.
    
    Returns:
    
    will never be null.
  - withTarget
```
ConfigurableAffordance withTarget(Link target)
```
    Create a new AffordanceBuilder by copying all attributes and replacing the target.
    
    Parameters:
    
    target -
    
    Returns:
  - withName
```
ConfigurableAffordance withName(@Nullable
                                String name)
```
    Create a new AffordanceBuilder by copying all attributes and replacing the name.
    
    Parameters:
    
    name - can be null.
    
    Returns:

Interface ConfigurableAffordance

Method Summary

Methods inherited from interface org.springframework.hateoas.mediatype.AffordanceOperations

Method Detail

withInputAndOutput

withInputAndOutput

withInputAndOutput

withInput

withInput

withInput

withOutput

withOutput

withOutput

withInputMediaType

withInputMediaTypes

withParameters

withParameters

addParameters

andAfford

build

withTarget

withName