fr.arakne.utils.maps.path

Class Decoder<C extends MapCell>

java.lang.Object

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

public final class Decoder<C extends MapCell>
extends Object

Decode map data like paths or directions

Constructor Summary

Constructors

Constructor and Description
Decoder(DofusMap<C> map)

Method Summary

Modifier and Type	Method and Description
Path<C>	decode(String encoded) Decode compressed path without a start cell
Path<C>	decode(String encoded, C start) Decode compressed path
String	encode(Path<C> path) Encode the computed path, without the start cell To decode this path, the start cell must be provided on the decode method This method should be used by the client to send a path to the server String encoded = encoder.encode(myPath); Path decoded = encoder.decode(encoded, startCell);
String	encodeWithStartCell(Path<C> path) Encode the computed path, including the start cell To decode this path, the start cell should not be provided on the decode method This method should be used by server to send a path to the client String encoded = encoder.encodeWithStartCell(myPath); Path decoded = encoder.decode(encoded);
Optional<C>	nextCellByDirection(C start, Direction direction) Get the immediately next cell if we move by the given direction If the next cell is out of the map, an empty optional is returned
Pathfinder<C>	pathfinder() Get the pathfinder related to this decoder

Methods inherited from class java.lang.Object

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

Constructor Detail

Decoder

public Decoder(DofusMap<C> map)

Parameters:

map - The map to handle

Method Detail

nextCellByDirection

public Optional<C> nextCellByDirection(C start,
                                       Direction direction)

Get the immediately next cell if we move by the given direction If the next cell is out of the map, an empty optional is returned

Parameters:

start - The start cell

direction - The direction to follow

Returns:

The next cell, wrapped into an optional. If the next cell is outside map, return an empty optional

decode

public Path<C> decode(String encoded,
                      C start)
               throws PathException

Decode compressed path

Parameters:

encoded - The encoded path

start - The start cell. Can be null. Set a value is the encoded path do not contains the start cell (ex: use encode(Path, boolean) with includeStartCell)

Returns:

The path, with list of cells

Throws:

PathException - When an invalid path is given

decode

public Path<C> decode(String encoded)
               throws PathException

Decode compressed path without a start cell

Parameters:

encoded - The encoded path. Must contains the start cell

Returns:

The path, with list of cells

Throws:

PathException - When an invalid path is given

encodeWithStartCell

public String encodeWithStartCell(Path<C> path)

Encode the computed path, including the start cell To decode this path, the start cell should not be provided on the decode method This method should be used by server to send a path to the client String encoded = encoder.encodeWithStartCell(myPath); Path decoded = encoder.decode(encoded);

Parameters:

path - The path to encode

Returns:

The encoded path

encode

public String encode(Path<C> path)

Encode the computed path, without the start cell To decode this path, the start cell must be provided on the decode method This method should be used by the client to send a path to the server String encoded = encoder.encode(myPath); Path decoded = encoder.decode(encoded, startCell);

Parameters:

path - The path to encode

Returns:

The encoded path

See Also:

Set to false to generate a path without the start cell

pathfinder

public Pathfinder<C> pathfinder()

Get the pathfinder related to this decoder

Returns:

The pathfinder instance