com.graphhopper.util

Class InstructionList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Instruction>

com.graphhopper.util.InstructionList

All Implemented Interfaces:

Iterable<Instruction>, Collection<Instruction>, List<Instruction>

public class InstructionList
extends AbstractList<Instruction>

List of instructions.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
InstructionList(int cap, Translation tr)
InstructionList(Translation tr)

Method Summary

Modifier and Type	Method and Description
void	add(int index, Instruction element)
String	createGPX(String version) Creates the standard GPX string out of the points according to the schema found here: https://graphhopper.com/public/schema/gpx-1.1.xsd
String	createGPX(String trackName, long startTimeMillis, boolean includeElevation, boolean withRoute, boolean withTrack, boolean withWayPoints, String version)
String	createGPX(String trackName, long startTimeMillis, String version)
List<GPXEntry>	createGPXList()
List<Map<String,Object>>	createJson()
void	createRteptBlock(StringBuilder output, Instruction instruction, Instruction nextI, DecimalFormat decimalFormat)
Instruction	find(double lat, double lon, double maxDistance) This method is useful for navigation devices to find the next instruction for the specified coordinate (e.g.
Instruction	get(int index)
Instruction	remove(int index)
void	replaceLast(Instruction instr)
Instruction	set(int index, Instruction element)
int	size()

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

InstructionList

public InstructionList(Translation tr)

InstructionList

public InstructionList(int cap,
                       Translation tr)

Method Detail

size

public int size()

Specified by:

size in interface Collection<Instruction>

Specified by:

size in interface List<Instruction>

Specified by:

size in class AbstractCollection<Instruction>

get

public Instruction get(int index)

Specified by:

get in interface List<Instruction>

Specified by:

get in class AbstractList<Instruction>

set

public Instruction set(int index,
                       Instruction element)

Specified by:

set in interface List<Instruction>

Overrides:

set in class AbstractList<Instruction>

add

public void add(int index,
                Instruction element)

Specified by:

add in interface List<Instruction>

Overrides:

add in class AbstractList<Instruction>

remove

public Instruction remove(int index)

Specified by:

remove in interface List<Instruction>

Overrides:

remove in class AbstractList<Instruction>

replaceLast

public void replaceLast(Instruction instr)

createJson

public List<Map<String,Object>> createJson()

createGPXList

public List<GPXEntry> createGPXList()

Returns:

This method returns a list of gpx entries where the time (in millis) is relative to the first which is 0.

createGPX

public String createGPX(String version)

Creates the standard GPX string out of the points according to the schema found here: https://graphhopper.com/public/schema/gpx-1.1.xsd

Returns:

string to be stored as gpx file

createGPX

public String createGPX(String trackName,
                        long startTimeMillis,
                        String version)

createGPX

public String createGPX(String trackName,
                        long startTimeMillis,
                        boolean includeElevation,
                        boolean withRoute,
                        boolean withTrack,
                        boolean withWayPoints,
                        String version)

createRteptBlock

public void createRteptBlock(StringBuilder output,
                             Instruction instruction,
                             Instruction nextI,
                             DecimalFormat decimalFormat)

find

public Instruction find(double lat,
                        double lon,
                        double maxDistance)

This method is useful for navigation devices to find the next instruction for the specified coordinate (e.g. the current position).

Parameters:

maxDistance - the maximum acceptable distance to the instruction (in meter)

Returns:

the next Instruction or null if too far away.