org.openstreetmap.josm.data.osm

Interface IWay<N extends INode>

Type Parameters:

N - type of OSM node

All Superinterfaces:

java.lang.Comparable<IPrimitive>, IPrimitive, PrimitiveId, Stylable, Tagged

All Known Implementing Classes:

Way, WayData

public interface IWay<N extends INode>
extends IPrimitive

IWay captures the common functions of Way and WayData.

Since:

4098

Field Summary

Fields inherited from interface org.openstreetmap.josm.data.osm.Tagged

MAX_TAG_LENGTH

Method Summary

Modifier and Type	Method and Description
default int	compareTo(IPrimitive o)
N	firstNode() Returns the first node of this way.
default java.lang.String	getDisplayName(NameFormatter formatter) Replies the display name of a primitive formatted by formatter
N	getNode(int index) Replies the node at position index.
long	getNodeId(int idx) Returns id of the node at given index.
java.util.List<java.lang.Long>	getNodeIds() Returns the list of node ids in this way.
java.util.List<N>	getNodes() Returns the list of nodes in this way.
int	getNodesCount() Replies the number of nodes in this way.
default int	getRealNodesCount() Replies the real number of nodes in this way (full number of nodes minus one if this way is closed)
boolean	isClosed() Determines if this way is closed.
boolean	isFirstLastNode(INode n) Replies true if the given node is the first or the last one of this way, false otherwise.
boolean	isInnerNode(INode n) Replies true if the given node is an inner node of this way, false otherwise.
N	lastNode() Returns the last node of this way.
void	setNodes(java.util.List<N> nodes) Set new list of nodes to way.

Methods inherited from interface org.openstreetmap.josm.data.osm.IPrimitive

accept, getBBox, getChangesetId, getDataSet, getDisplayType, getId, getInterestingTags, getLocalName, getName, getOsmId, getOsmPrimitiveId, getPrimitiveId, getRawTimestamp, getReferrers, getReferrers, getTimestamp, getUser, getVersion, hasDirectionKeys, hasSameInterestingTags, isAnnotated, isDeleted, isDisabled, isDisabledAndHidden, isDrawable, isHighlighted, isIncomplete, isMemberOfSelected, isModified, isMultipolygon, isNewOrUndeleted, isOuterMemberOfSelected, isPreserved, isSelectable, isSelected, isTagged, isTimestampEmpty, isUndeleted, isUsable, isVisible, reversedDirection, setChangesetId, setDeleted, setHighlighted, setModified, setOsmId, setRawTimestamp, setTimestamp, setUser, setVisible, visitReferrers

Methods inherited from interface org.openstreetmap.josm.data.osm.Tagged

get, getKeys, getNumKeys, hasKey, hasKeys, hasTag, hasTag, hasTag, hasTag, hasTagDifferent, hasTagDifferent, hasTagDifferent, isKeyFalse, isKeyTrue, keySet, put, put, remove, removeAll, setKeys, visitKeys

Methods inherited from interface org.openstreetmap.josm.data.osm.PrimitiveId

getType, getUniqueId, isNew

Methods inherited from interface org.openstreetmap.josm.data.osm.Stylable

clearCachedStyle, declareCachedStyleUpToDate, getCachedStyle, isCachedStyleUpToDate, setCachedStyle

Method Detail

getNodesCount

int getNodesCount()

Replies the number of nodes in this way.

Returns:

the number of nodes in this way.

getRealNodesCount

default int getRealNodesCount()

Replies the real number of nodes in this way (full number of nodes minus one if this way is closed)

Returns:

the real number of nodes in this way.

Since:

5847, 13564 (IWay)

See Also:

getNodesCount(), isClosed()

getNode

N getNode(int index)

Replies the node at position index.

Parameters:

index - the position

Returns:

the node at position index

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index < 0 or index >= getNodesCount()

Since:

1862, 13717 (IWay)

getNodes

java.util.List<N> getNodes()

Returns the list of nodes in this way.

Returns:

the list of nodes in this way

Since:

1862, 13717 (IWay)

getNodeIds

java.util.List<java.lang.Long> getNodeIds()

Returns the list of node ids in this way.

Returns:

the list of node ids in this way

Since:

13717

getNodeId

long getNodeId(int idx)

Returns id of the node at given index.

Parameters:

idx - node index

Returns:

id of the node at given index

setNodes

void setNodes(java.util.List<N> nodes)

Set new list of nodes to way. This method is preferred to multiple calls to addNode/removeNode and similar methods because nodes are internally saved as array which means lower memory overhead but also slower modifying operations.

Parameters:

nodes - New way nodes. Can be null, in that case all way nodes are removed

isClosed

boolean isClosed()

Determines if this way is closed.

Returns:

true if this way is closed, false otherwise

compareTo

default int compareTo(IPrimitive o)

Specified by:

compareTo in interface java.lang.Comparable<IPrimitive>

getDisplayName

default java.lang.String getDisplayName(NameFormatter formatter)

Description copied from interface: IPrimitive

Replies the display name of a primitive formatted by formatter

Specified by:

getDisplayName in interface IPrimitive

Parameters:

formatter - formatter to use

Returns:

the display name

firstNode

N firstNode()

Returns the first node of this way. The result equals getNode(0).

Returns:

the first node of this way

Since:

13922

lastNode

N lastNode()

Returns the last node of this way. The result equals getNode(getNodesCount - 1).

Returns:

the last node of this way

Since:

13922

isFirstLastNode

boolean isFirstLastNode(INode n)

Replies true if the given node is the first or the last one of this way, false otherwise.

Parameters:

n - The node to test

Returns:

true if the n is the first or the last node, false otherwise.

Since:

13922

isInnerNode

boolean isInnerNode(INode n)

Replies true if the given node is an inner node of this way, false otherwise.

Parameters:

n - The node to test

Returns:

true if the n is an inner node, false otherwise.

Since:

13922