Package org.openstreetmap.josm.command

Class AddCommand

java.lang.Object

org.openstreetmap.josm.command.Command

org.openstreetmap.josm.command.AddCommand

All Implemented Interfaces:

PseudoCommand

public class AddCommand
extends Command

A command that adds an osm primitive to a dataset. Keys cannot be added this way. See ChangeCommand for comments on relation back references.

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.command.Command

Command.OldNodeState

Field Summary

Fields

Modifier and Type	Field	Description
private OsmPrimitive	osm	The primitive to add to the dataset.

Fields inherited from class org.openstreetmap.josm.command.Command

IS_INCOMPLETE, IS_OK, IS_OUTSIDE

Constructor Summary

Constructors

Constructor	Description
AddCommand(DataSet data, OsmPrimitive osm)	Creates the command and specify the element to add in the context of the given data set.

Method Summary

Modifier and Type	Method	Description
protected static void	checkNodeStyles(OsmPrimitive osm)
boolean	equals(java.lang.Object obj)
boolean	executeCommand()	Executes the command on the dataset.
void	fillModifiedData(java.util.Collection<OsmPrimitive> modified, java.util.Collection<OsmPrimitive> deleted, java.util.Collection<OsmPrimitive> added)	Fill in the changed data this command operates on.
javax.swing.Icon	getDescriptionIcon()	Provides a descriptive icon of this command.
java.lang.String	getDescriptionText()	Provides a description text representing this command.
java.util.Collection<OsmPrimitive>	getParticipatingPrimitives()	Return the primitives that take part in this command.
int	hashCode()
void	undoCommand()	Undoes the command.

Methods inherited from class org.openstreetmap.josm.command.Command

checkOutlyingOrIncompleteOperation, ensurePrimitivesAreInDataset, getAffectedDataSet, getOrig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.command.PseudoCommand

getChildren

Field Detail

osm

private final OsmPrimitive osm

The primitive to add to the dataset.

Constructor Detail

AddCommand

public AddCommand(DataSet data,
                  OsmPrimitive osm)

Creates the command and specify the element to add in the context of the given data set.

Parameters:

data - The data set. Must not be null

osm - The primitive to add

Since:

11240

Method Detail

checkNodeStyles

protected static final void checkNodeStyles(OsmPrimitive osm)

executeCommand

public boolean executeCommand()

Description copied from class: Command

Executes the command on the dataset. This implementation will remember all primitives returned by fillModifiedData for restoring them on undo.

The layer should be invalidated after execution so that it can be re-painted.

Overrides:

executeCommand in class Command

Returns:

true

undoCommand

public void undoCommand()

Description copied from class: Command

Undoes the command. It can be assumed that all objects are in the same state they were before. It can also be assumed that executeCommand was called exactly once before. This implementation undoes all objects stored by a former call to executeCommand.

Overrides:

undoCommand in class Command

fillModifiedData

public void fillModifiedData(java.util.Collection<OsmPrimitive> modified,
                             java.util.Collection<OsmPrimitive> deleted,
                             java.util.Collection<OsmPrimitive> added)

Description copied from class: Command

Fill in the changed data this command operates on. Add to the lists, don't clear them.

Specified by:

fillModifiedData in class Command

Parameters:

modified - The modified primitives

deleted - The deleted primitives

added - The added primitives

getDescriptionText

public java.lang.String getDescriptionText()

Description copied from interface: PseudoCommand

Provides a description text representing this command.

Returns:

description text representing this command

getDescriptionIcon

public javax.swing.Icon getDescriptionIcon()

Description copied from interface: PseudoCommand

Provides a descriptive icon of this command.

Returns:

descriptive icon of this command

getParticipatingPrimitives

public java.util.Collection<OsmPrimitive> getParticipatingPrimitives()

Description copied from class: Command

Return the primitives that take part in this command. The collection is computed during execution.

Specified by:

getParticipatingPrimitives in interface PseudoCommand

Overrides:

getParticipatingPrimitives in class Command

Returns:

primitives that take part in this command

hashCode

public int hashCode()

Overrides:

hashCode in class Command

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Command