Package org.springframework.data.rest.core

Class ResolvingAggregateReference<T,ID>

java.lang.Object

org.springframework.data.rest.core.ResolvingAggregateReference<T,ID>

All Implemented Interfaces:

AggregateReference<T,ID>

public class ResolvingAggregateReference<T,ID>
extends Object
implements AggregateReference<T,ID>

An AggregateReference implementation that resolves the source URI given a Function or into a fixed value.

Since:

4.1

Author:

Oliver Drotbohm

Constructor Summary

Constructors

Modifier	Constructor	Description
	ResolvingAggregateReference(URI source, Function<Object,? extends T> aggregateResolver, Function<Object,? extends ID> identifierResolver)	Creates a new ResolvingAggregateReference for the given URI to eventually resolve the final value against the given resolver function.
protected	ResolvingAggregateReference(URI source, Function<Object,? extends T> aggregateResolver, Function<Object,? extends ID> identifierResolver, Function<URI,? extends Object> extractor)
	ResolvingAggregateReference(URI source, T value, ID identifier)	Creates a new ResolvingAggregateReference for the given URI resolving in the given fixed value.

Method Summary

Modifier and Type	Method	Description
URI	getUri()	Returns the source URI.
T	resolveAggregate()	Resolves the underlying URI into a full aggregate, potentially applying the configured identifier extractor.
ID	resolveId()	Resolves the underlying URI into an aggregate identifier, potentially applying the registered identifier extractor.
AggregateReference<T,ID>	withIdSource(Function<UriComponents,Object> extractor)	Creates a new AggregateReference resolving the identifier source value from the given UriComponents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.rest.core.AggregateReference

resolveRequiredAggregate, resolveRequiredId

Constructor Details

ResolvingAggregateReference

public ResolvingAggregateReference(URI source,
 Function<Object,? extends T> aggregateResolver,
 Function<Object,? extends ID> identifierResolver)

Creates a new ResolvingAggregateReference for the given URI to eventually resolve the final value against the given resolver function.

Parameters:

source - must not be null.

aggregateResolver - must not be null.

identifierResolver - must not be null.

ResolvingAggregateReference

protected ResolvingAggregateReference(URI source,
 Function<Object,? extends T> aggregateResolver,
 Function<Object,? extends ID> identifierResolver,
 Function<URI,? extends Object> extractor)

ResolvingAggregateReference

public ResolvingAggregateReference(URI source,
 @Nullable
 T value,
 ID identifier)

Creates a new ResolvingAggregateReference for the given URI resolving in the given fixed value. Primarily for testing purposes.

Parameters:

source - must not be null.

value - can be null.

identifier - must not be null.

Method Details

getUri

public URI getUri()

Description copied from interface: AggregateReference

Returns the source URI.

Specified by:

getUri in interface AggregateReference<T,ID>

Returns:

will never be null.

resolveId

public ID resolveId()

Description copied from interface: AggregateReference

Resolves the underlying URI into an aggregate identifier, potentially applying the registered identifier extractor.

Specified by:

resolveId in interface AggregateReference<T,ID>

Returns:

can be null.

See Also:

• AggregateReference.withIdSource(Function)

resolveAggregate

public T resolveAggregate()

Description copied from interface: AggregateReference

Resolves the underlying URI into a full aggregate, potentially applying the configured identifier extractor.

Specified by:

resolveAggregate in interface AggregateReference<T,ID>

Returns:

can be null.

See Also:

• AggregateReference.withIdSource(Function)

withIdSource

public AggregateReference<T,ID> withIdSource(Function<UriComponents,Object> extractor)

Description copied from interface: AggregateReference

Creates a new AggregateReference resolving the identifier source value from the given UriComponents.

Specified by:

withIdSource in interface AggregateReference<T,ID>

Parameters:

extractor - must not be null.

Returns:

will never be null.