ConfiguredAffordance
instead. Will be made private in 1.4.@Deprecated public static class Affordances.AffordanceBuilder extends Object implements ConfigurableAffordance, ConfiguredAffordance
Affordance
instances.ConfigurableAffordance
,
ConfiguredAffordance
Modifier and Type | Method and Description |
---|---|
Affordances.AffordanceBuilder |
addParameters(QueryParameter... parameters)
Deprecated.
Adds the given
QueryParameter s to the Affordance to build. |
Affordances.AffordanceBuilder |
andAfford(HttpMethod method)
Deprecated.
Concludes the creation of the current
Affordance to build and starts a new one. |
Affordances |
build()
Deprecated.
Builds the
Affordance currently under construction and returns in alongside the ones already contained in
the Link the buildup started from. |
AffordanceModel.InputPayloadMetadata |
getInputMetadata()
Deprecated.
Metadata about the input payload.
|
HttpMethod |
getMethod()
Deprecated.
The
HttpMethod of the affordance. |
String |
getNameOrDefault()
Deprecated.
Returns the explicitly configured name of the
Affordance or calculates a default based on the
HttpMethod and type backing it. |
AffordanceModel.PayloadMetadata |
getOutputMetadata()
Deprecated.
Metadata about the output payload.
|
List<QueryParameter> |
getQueryParameters()
Deprecated.
The parameters of the affordance.
|
Link |
getTarget()
Deprecated.
Returns the affordance's target.
|
Link |
toLink()
Deprecated.
Returns a
Link equipped with the Affordance currently under construction. |
Affordances.AffordanceBuilder |
withInput(AffordanceModel.PayloadMetadata metadata)
Deprecated.
Registers the given
AffordanceModel.PayloadMetadata as input model. |
Affordances.AffordanceBuilder |
withInput(Class<?> type)
Deprecated.
Registers the given type as input model for the affordance.
|
Affordances.AffordanceBuilder |
withInput(ResolvableType type)
Deprecated.
Registers the given
ResolvableType as input model for the affordance. |
Affordances.AffordanceBuilder |
withInputAndOutput(AffordanceModel.PayloadMetadata metadata)
Deprecated.
Registers the given
AffordanceModel.PayloadMetadata as input and output model. |
Affordances.AffordanceBuilder |
withInputAndOutput(Class<?> type)
Deprecated.
Registers the given type as input and output model for the affordance.
|
Affordances.AffordanceBuilder |
withInputAndOutput(ResolvableType type)
Deprecated.
Registers the given
ResolvableType as input and output model for the affordance. |
ConfigurableAffordance |
withInputMediaType(MediaType inputMediaType)
Deprecated.
Registers the input to expect to be of the given
MediaType . |
ConfigurableAffordance |
withInputMediaTypes(List<MediaType> inputMediaTypes)
Deprecated.
Registers the given
MediaType s as input payload media types. |
ConfigurableAffordance |
withName(String name)
Deprecated.
Create a new
Affordances.AffordanceBuilder by copying all attributes and replacing the name. |
Affordances.AffordanceBuilder |
withOutput(AffordanceModel.PayloadMetadata metadata)
Deprecated.
Registers the given
AffordanceModel.PayloadMetadata as output model. |
Affordances.AffordanceBuilder |
withOutput(Class<?> type)
Deprecated.
Registers the given type as the output model.
|
Affordances.AffordanceBuilder |
withOutput(ResolvableType type)
Deprecated.
Registers the given
ResolvableType as the output model. |
Affordances.AffordanceBuilder |
withParameters(List<QueryParameter> parameters)
Deprecated.
Replaces the current
QueryParameter list with the given ones. |
Affordances.AffordanceBuilder |
withParameters(QueryParameter... parameters)
Deprecated.
Replaces the current
QueryParameter list with the given ones. |
ConfigurableAffordance |
withTarget(Link target)
Deprecated.
Create a new
Affordances.AffordanceBuilder by copying all attributes and replacing the target. |
public Affordances.AffordanceBuilder withInputAndOutput(Class<?> type)
ConfigurableAffordance
withInputAndOutput
in interface ConfigurableAffordance
type
- must not be null.public Affordances.AffordanceBuilder withInputAndOutput(ResolvableType type)
ConfigurableAffordance
ResolvableType
as input and output model for the affordance.withInputAndOutput
in interface ConfigurableAffordance
type
- must not be null.public Affordances.AffordanceBuilder withInputAndOutput(AffordanceModel.PayloadMetadata metadata)
ConfigurableAffordance
AffordanceModel.PayloadMetadata
as input and output model.withInputAndOutput
in interface ConfigurableAffordance
metadata
- must not be null.public Affordances.AffordanceBuilder withInput(Class<?> type)
ConfigurableAffordance
withInput
in interface ConfigurableAffordance
type
- must not be null.public Affordances.AffordanceBuilder withInput(ResolvableType type)
ConfigurableAffordance
ResolvableType
as input model for the affordance.withInput
in interface ConfigurableAffordance
type
- must not be null.public Affordances.AffordanceBuilder withInput(AffordanceModel.PayloadMetadata metadata)
ConfigurableAffordance
AffordanceModel.PayloadMetadata
as input model.withInput
in interface ConfigurableAffordance
metadata
- must not be null.public Affordances.AffordanceBuilder withOutput(Class<?> type)
ConfigurableAffordance
withOutput
in interface ConfigurableAffordance
type
- must not be null.public Affordances.AffordanceBuilder withOutput(ResolvableType type)
ConfigurableAffordance
ResolvableType
as the output model.withOutput
in interface ConfigurableAffordance
type
- must not be null.public Affordances.AffordanceBuilder withOutput(AffordanceModel.PayloadMetadata metadata)
ConfigurableAffordance
AffordanceModel.PayloadMetadata
as output model.withOutput
in interface ConfigurableAffordance
metadata
- must not be null.public ConfigurableAffordance withInputMediaType(MediaType inputMediaType)
ConfigurableAffordance
MediaType
.withInputMediaType
in interface ConfigurableAffordance
inputMediaType
- can be null.public ConfigurableAffordance withInputMediaTypes(List<MediaType> inputMediaTypes)
ConfigurableAffordance
MediaType
s as input payload media types.withInputMediaTypes
in interface ConfigurableAffordance
inputMediaTypes
- must not be null.public Affordances.AffordanceBuilder withParameters(QueryParameter... parameters)
ConfigurableAffordance
QueryParameter
list with the given ones.withParameters
in interface ConfigurableAffordance
parameters
- must not be null.public Affordances.AffordanceBuilder withParameters(List<QueryParameter> parameters)
ConfigurableAffordance
QueryParameter
list with the given ones.withParameters
in interface ConfigurableAffordance
parameters
- must not be null.public Affordances.AffordanceBuilder addParameters(QueryParameter... parameters)
ConfigurableAffordance
QueryParameter
s to the Affordance
to build.addParameters
in interface ConfigurableAffordance
parameters
- must not be null.public ConfigurableAffordance withTarget(Link target)
ConfigurableAffordance
Affordances.AffordanceBuilder
by copying all attributes and replacing the target.withTarget
in interface ConfigurableAffordance
public ConfigurableAffordance withName(@Nullable String name)
ConfigurableAffordance
Affordances.AffordanceBuilder
by copying all attributes and replacing the name.withName
in interface ConfigurableAffordance
name
- can be null.public Affordances.AffordanceBuilder andAfford(HttpMethod method)
ConfigurableAffordance
Affordance
to build and starts a new one.andAfford
in interface ConfigurableAffordance
method
- must not be null.ConfigurableAffordance.build()
,
AffordanceOperations.toLink()
public Affordances build()
ConfigurableAffordance
Affordance
currently under construction and returns in alongside the ones already contained in
the Link
the buildup started from.build
in interface ConfigurableAffordance
public Link toLink()
AffordanceOperations
Link
equipped with the Affordance
currently under construction.toLink
in interface AffordanceOperations
public String getNameOrDefault()
ConfiguredAffordance
Affordance
or calculates a default based on the
HttpMethod
and type backing it.getNameOrDefault
in interface ConfiguredAffordance
public HttpMethod getMethod()
ConfiguredAffordance
HttpMethod
of the affordance.getMethod
in interface ConfiguredAffordance
public AffordanceModel.InputPayloadMetadata getInputMetadata()
ConfiguredAffordance
getInputMetadata
in interface ConfiguredAffordance
public AffordanceModel.PayloadMetadata getOutputMetadata()
ConfiguredAffordance
getOutputMetadata
in interface ConfiguredAffordance
public Link getTarget()
ConfiguredAffordance
getTarget
in interface ConfiguredAffordance
public List<QueryParameter> getQueryParameters()
ConfiguredAffordance
getQueryParameters
in interface ConfiguredAffordance
Copyright © 2011–2021 Pivotal, Inc.. All rights reserved.