org.optaweb.vehiclerouting.service.vehicle

Interface VehicleRepository

All Known Implementing Classes:

VehicleRepositoryImpl

public interface VehicleRepository

Defines repository operations on vehicles.

Method Summary

Modifier and Type	Method and Description
Vehicle	createVehicle(String name, int capacity) Create a vehicle with a unique ID.
Optional<Vehicle>	find(Long vehicleId)
long	nextId() Temporary hack needed for vehicle name auto-generation.
void	removeAll() Remove all vehicles from the repository.
Vehicle	removeVehicle(long id) Remove vehicle.
void	update(Vehicle vehicle)
List<Vehicle>	vehicles() Get all vehicles.

Method Detail

createVehicle

Vehicle createVehicle(String name,
                      int capacity)

Create a vehicle with a unique ID.

Parameters:

name - vehicle name

capacity - vehicle's capacity

Returns:

a new vehicle

vehicles

List<Vehicle> vehicles()

Get all vehicles.

Returns:

all vehicles

removeVehicle

Vehicle removeVehicle(long id)

Remove vehicle.

Parameters:

id - vehicle's id

Returns:

the removed vehicle

removeAll

void removeAll()

Remove all vehicles from the repository.

find

Optional<Vehicle> find(Long vehicleId)

nextId

long nextId()

Temporary hack needed for vehicle name auto-generation.

Returns:

unique ID that will be used for the next new vehicle.

update

void update(Vehicle vehicle)