fr.arakne.utils.maps.path

Class Path<C extends MapCell>

java.lang.Object

fr.arakne.utils.maps.path.Path<C>

Type Parameters:

C - The cell type

All Implemented Interfaces:

Iterable<PathStep<C>>, Collection<PathStep<C>>

public final class Path<C extends MapCell>
extends Object
implements Collection<PathStep<C>>

Path for dofus map

Constructor Summary

Constructors

Constructor and Description
Path(Decoder<C> decoder) Create an empty path
Path(Decoder<C> decoder, List<PathStep<C>> steps)

Method Summary

Modifier and Type	Method and Description
boolean	add(PathStep<C> step)
boolean	addAll(Collection<? extends PathStep<C>> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
String	encode() Encode the path to string
String	encodeWithStartCell() Encode the path to string, including the start cell
PathStep<C>	first() Get the first step of the path
PathStep<C>	get(int step) Get one step
boolean	isEmpty()
Iterator<PathStep<C>>	iterator()
Path<C>	keepWhile(Predicate<PathStep<C>> condition) Keep the path steps while the condition is valid The path will be stop when an invalid step is found
PathStep<C>	last() Get the last step
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
@LengthOf(value="this") int	size()
C	start() Get the start cell
C	target() Get the last cell
Object[]	toArray()
<T> T[]	toArray(T[] a)
Path<C>	truncate(int newSize) Truncate the path, to the new size

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Path

public Path(Decoder<C> decoder,
            List<PathStep<C>> steps)

Parameters:

decoder - The decoder instance

steps - The list of steps

Path

public Path(Decoder<C> decoder)

Create an empty path

Parameters:

decoder - The decoder instance

Method Detail

get

@Pure
public PathStep<C> get(int step)

Get one step

Parameters:

step - The step number. The step zero is the current cell, The step (size - 1) is the last step (target)

Returns:

The required step

first

@Pure
public PathStep<C> first()

Get the first step of the path

Returns:

The first step

See Also:

For get the start cell

last

@Pure
public PathStep<C> last()

Get the last step

Returns:

The last step

See Also:

For get the last cell

start

@Pure
public C start()

Get the start cell

Returns:

The start cell

target

@Pure
public C target()

Get the last cell

Returns:

The end cell

encode

@SideEffectFree
public String encode()

Encode the path to string

Returns:

The encoded path

encodeWithStartCell

@SideEffectFree
public String encodeWithStartCell()

Encode the path to string, including the start cell

Returns:

The encoded path

See Also:

Decoder.encodeWithStartCell(Path)

keepWhile

public Path<C> keepWhile(Predicate<PathStep<C>> condition)

Keep the path steps while the condition is valid The path will be stop when an invalid step is found

Parameters:

condition - The condition to apply on all steps. If returns false, the path will be stopped

Returns:

The new path instance

truncate

public Path<C> truncate(int newSize)

Truncate the path, to the new size

Parameters:

newSize - The required size

Returns:

The new path instance

size

@Pure
 @LengthOf(value="this")
public @LengthOf(value="this") int size()

Specified by:

size in interface Collection<PathStep<C extends MapCell>>

isEmpty

@Pure
public boolean isEmpty()

Specified by:

isEmpty in interface Collection<PathStep<C extends MapCell>>

contains

@Pure
public boolean contains(Object o)

Specified by:

contains in interface Collection<PathStep<C extends MapCell>>

iterator

public Iterator<PathStep<C>> iterator()

Specified by:

iterator in interface Iterable<PathStep<C extends MapCell>>

Specified by:

iterator in interface Collection<PathStep<C extends MapCell>>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<PathStep<C extends MapCell>>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<PathStep<C extends MapCell>>

add

public boolean add(PathStep<C> step)

Specified by:

add in interface Collection<PathStep<C extends MapCell>>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<PathStep<C extends MapCell>>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<PathStep<C extends MapCell>>

addAll

public boolean addAll(Collection<? extends PathStep<C>> c)

Specified by:

addAll in interface Collection<PathStep<C extends MapCell>>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<PathStep<C extends MapCell>>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<PathStep<C extends MapCell>>

clear

public void clear()

Specified by:

clear in interface Collection<PathStep<C extends MapCell>>