Package org.goplanit.path

Class SimpleDirectedPathImpl

java.lang.Object

org.goplanit.path.SimpleDirectedPathImpl

All Implemented Interfaces:

Iterable<EdgeSegment>, SimpleDirectedPath

public class SimpleDirectedPathImpl
extends Object
implements SimpleDirectedPath

This object represents a simple directed path based on a number of consecutive LinkSegments

Author:

markr

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleDirectedPathImpl()	Constructor
protected	SimpleDirectedPathImpl(Deque<? extends EdgeSegment> pathEdgeSegments)	Constructor
protected	SimpleDirectedPathImpl(SimpleDirectedPathImpl other)	Copy constructor (shallow copy)

Method Summary

Modifier and Type	Method	Description
void	append(EdgeSegment... edgeSegments)	Append given edge segments to the simple path
boolean	containsSubPath(Collection<? extends EdgeSegment> subPath)	Verify if the path contains the provided subpath.
boolean	containsSubPath(Iterator<? extends EdgeSegment> subPathIter)	Verify if the path contains the provided subpath.
EdgeSegment	getFirstSegment()	Collect first segment on path
EdgeSegment	getLastSegment()	Collect last segment on path
int	hashCode()	Hash code taken over all edge segments
Iterator<EdgeSegment>	iterator()
void	prepend(EdgeSegment... edgeSegments)	Prepend given edge segments to the simple path
long	size()	The size of the path is given by the number of edge segments it holds

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.goplanit.utils.path.SimpleDirectedPath

computeLengthKm, isEmpty

Constructor Detail

SimpleDirectedPathImpl

protected SimpleDirectedPathImpl()

Constructor

SimpleDirectedPathImpl

protected SimpleDirectedPathImpl(SimpleDirectedPathImpl other)

Copy constructor (shallow copy)

Parameters:

other - to copy

SimpleDirectedPathImpl

protected SimpleDirectedPathImpl(Deque<? extends EdgeSegment> pathEdgeSegments)

Constructor

Parameters:

pathEdgeSegments - the path to set (not copied)

Method Detail

iterator

public Iterator<EdgeSegment> iterator()

Specified by:

iterator in interface Iterable<EdgeSegment>

size

public long size()

The size of the path is given by the number of edge segments it holds

Specified by:

size in interface SimpleDirectedPath

Returns:

size

containsSubPath

public boolean containsSubPath(Collection<? extends EdgeSegment> subPath)

Verify if the path contains the provided subpath. It is only a subpath of the subpath is present continguously

Specified by:

containsSubPath in interface SimpleDirectedPath

Parameters:

subPath - to verify

Returns:

true when it contains the subpath, false otherwise.

containsSubPath

public boolean containsSubPath(Iterator<? extends EdgeSegment> subPathIter)

Verify if the path contains the provided subpath. It is only a subpath of the subpath is present contiguously

Specified by:

containsSubPath in interface SimpleDirectedPath

Parameters:

subPathIter - to verify

Returns:

true when it contains the subpath, false otherwise.

getFirstSegment

public EdgeSegment getFirstSegment()

Collect first segment on path

Specified by:

getFirstSegment in interface SimpleDirectedPath

Returns:

initial segment

getLastSegment

public EdgeSegment getLastSegment()

Collect last segment on path

Specified by:

getLastSegment in interface SimpleDirectedPath

Returns:

last segment

append

public void append(EdgeSegment... edgeSegments)

Append given edge segments to the simple path

Parameters:

edgeSegments - to add

prepend

public void prepend(EdgeSegment... edgeSegments)

Prepend given edge segments to the simple path

Parameters:

edgeSegments - to add

hashCode

public int hashCode()

Hash code taken over all edge segments

Specified by:

hashCode in interface SimpleDirectedPath

Overrides:

hashCode in class Object

Returns:

hashcode