Package es.situm.sdk.directions

Class DirectionsModifier

java.lang.Object

es.situm.sdk.directions.DirectionsModifier

public class DirectionsModifier
extends java.lang.Object

It represents a modification applied to a graph in order to compute a @{link Route} The basic modifier is considered to be an Action represented by a @{link Actions} options and elements represented by a list of @{link TagModifier} instances where this action would be applied. An example of modifier could be:

 
     List<TagModifier> prioritizeTags = new ArrayList<>();
     prioritizeTags.add(new TagModifier.Builder().tag("Public").build());
     DirectionsModifier modifier =  new DirectionsModifier.Builder()
                                      .action(DirectionsModifier.Actions.PRIORITIZE)
                                      .tags(prioritizeTags)
                                      .build()
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DirectionsModifier.Actions	Actions to be processed when computing a route
static class	DirectionsModifier.Builder	Helper class to create well formed instances of DirectionsModifier class.
static class	DirectionsModifier.LEGACY_OPTIONS	Additional options to keep compatibility with previous versions.

Method Summary

Modifier and Type	Method	Description
DirectionsModifier.Actions	getAction()	Returns the action option that will be applied with this modifier.
java.util.List<TagModifier>	getTags()	List of elements (tags) that identify the links taking into consideration when applying DirectionsModifier operations.
java.util.List<java.lang.String>	getTagsString()	List of tags as strings
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getAction

public DirectionsModifier.Actions getAction()

Returns the action option that will be applied with this modifier.

Returns:

one of DirectionsModifier.Actions value

getTags

public java.util.List<TagModifier> getTags()

List of elements (tags) that identify the links taking into consideration when applying DirectionsModifier operations.

getTagsString

public java.util.List<java.lang.String> getTagsString()

List of tags as strings

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object