Package software.amazon.smithy.model.neighbor

Interface NeighborProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface NeighborProvider

Provides the neighbor relationships for a given shape.

Method Summary

Modifier and Type	Method	Description
static NeighborProvider	bottomUp(Model model)
static NeighborProvider	bottomUp(ShapeIndex index)	Deprecated.
java.util.List<Relationship>	getNeighbors(Shape shape)	Gets the neighbor relationships of a shape.
static NeighborProvider	of(Model model)	Creates a default NeighborProvider for the given model.
static NeighborProvider	of(ShapeIndex index)	Deprecated.
static NeighborProvider	precomputed(Model model)	Creates a NeighborProvider that precomputes the neighbors of a model.
static NeighborProvider	precomputed(Model model, NeighborProvider provider)	Creates a NeighborProvider that precomputes the neighbors of a model.
static NeighborProvider	precomputed(ShapeIndex index)	Deprecated.
static NeighborProvider	precomputed(ShapeIndex index, NeighborProvider provider)	Deprecated.
static NeighborProvider	reverse(Model model, NeighborProvider topDown)
static NeighborProvider	reverse(ShapeIndex index, NeighborProvider topDown)	Deprecated.

Method Detail

getNeighbors

java.util.List<Relationship> getNeighbors(Shape shape)

Gets the neighbor relationships of a shape.

Parameters:

shape - Shape to get neighbors for.

Returns:

Returns the found neighbors.

of

@Deprecated
static NeighborProvider of(ShapeIndex index)

Deprecated.

of

static NeighborProvider of(Model model)

Creates a default NeighborProvider for the given model.

Parameters:

model - Model to create a neighbor provider for.

Returns:

Returns the created neighbor provider.

precomputed

@Deprecated
static NeighborProvider precomputed(ShapeIndex index)

Deprecated.

precomputed

static NeighborProvider precomputed(Model model)

Creates a NeighborProvider that precomputes the neighbors of a model.

Parameters:

model - Model to create a neighbor provider for.

Returns:

Returns the created neighbor provider.

precomputed

@Deprecated
static NeighborProvider precomputed(ShapeIndex index,
                                    NeighborProvider provider)

Deprecated.

precomputed

static NeighborProvider precomputed(Model model,
                                    NeighborProvider provider)

Creates a NeighborProvider that precomputes the neighbors of a model.

Parameters:

model - Model to create a neighbor provider for.

provider - Provider to use when precomputing.

Returns:

Returns the created neighbor provider.

bottomUp

@Deprecated
static NeighborProvider bottomUp(ShapeIndex index)

Deprecated.

bottomUp

static NeighborProvider bottomUp(Model model)

reverse

@Deprecated
static NeighborProvider reverse(ShapeIndex index,
                                NeighborProvider topDown)

Deprecated.

reverse

static NeighborProvider reverse(Model model,
                                NeighborProvider topDown)