org.openstreetmap.josm.command
Class AddCommand

java.lang.Object
  org.openstreetmap.josm.command.PseudoCommand
      org.openstreetmap.josm.command.Command
          org.openstreetmap.josm.command.AddCommand

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.

Field Summary

private OsmPrimitive

osm The primitive to add to the dataset.

Constructor Summary

AddCommand(OsmDataLayer layer, OsmPrimitive osm)
Create the command and specify the element to add.

AddCommand(OsmPrimitive osm)
Create the command and specify the element to add.

Method Summary

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.
void	undoCommand() Undoes the command.

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

checkAndConfirmOutlyingOperation, getLayer, getOrig, invalidBecauselayerRemoved

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

getChildren

Methods inherited from class java.lang.Object

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

Field Detail

osm

private final OsmPrimitive osm

The primitive to add to the dataset.

Constructor Detail

AddCommand

public AddCommand(OsmPrimitive osm)

Create the command and specify the element to add.

AddCommand

public AddCommand(OsmDataLayer layer,
                  OsmPrimitive osm)

Create the command and specify the element to add.

Method Detail

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.

Overrides:

executeCommand in class Command

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 class: PseudoCommand

Provides a description text representing this command.

Specified by:

getDescriptionText in class PseudoCommand

getDescriptionIcon

public javax.swing.Icon getDescriptionIcon()

Description copied from class: PseudoCommand

Provides a descriptive icon of this command.

Overrides:

getDescriptionIcon in class PseudoCommand

getParticipatingPrimitives

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

Description copied from class: Command

Return the primitives that take part in this command.

Overrides:

getParticipatingPrimitives in class Command