=Introduction=

In object-oriented programming, the Command pattern is a Design pattern (computer science) in which objects are used to represent actions. A command object Information Hiding an action and its parameters.

For example, a printing library might include a PrintJob class. A user would typically create a new PrintJob object, set its properties (the document to be printed, the number of copies, and so on), and finally call a method to send the job to the printer.

In this case, the same functionality could be exposed via a single SendJobToPrinter() procedure with many parameters. As it takes more code to write a command class than to write a procedure, there must be some reason to use a class. There are many possible reasons:

=Uses for the Command pattern=

Command objects are useful for implementing:

Multi-level undo. If all user actions in a program are implemented as command objects, the program can keep a stack of the most recently executed commands. When the user wants to undo a command, the program simply pops the most recent command object and executes its undo() method.

database transaction behavior. Undo is perhaps even more essential when it s called rollback and happens automatically when an operation fails partway through. Installers need this. So do databases. Command objects can also be used to implement two-phase commit.

Progress bars. Suppose a program has a sequence of commands that it executes in order. If each command object has a getEstimatedDuration() method, the program can easily estimate the total duration. It can show a progress bar that meaningfully reflects how close the program is to completing all the tasks.

wizard (software)s. Often a wizard presents several pages of configuration for a single action that happens only when the user clicks the Finish button on the last page. In these cases, a natural way to separate user interface code from application code is to implement the wizard using a command object. The command object is created when the wizard is first displayed. Each wizard page stores its GUI changes in the command object, so the object is populated as the user progresses. Finish simply triggers a call to execute(). This way, the command class contains no user interface code.

GUI buttons and menu items. In Swing (Java) programming, an Action is a command object. In addition to the ability to perform the desired command, an Action may have an associated icon, keyboard shortcut, tooltip text, and so on. A toolbar button or menu item component may be completely initialized using only the Action object.

Thread pools. A typical, general-purpose thread pool class might have a public addTask() method that adds a work item to an internal queue of tasks waiting to be done. It maintains a pool of threads that execute commands from the queue. The items in the queue are command objects. Typically these objects implement a common interface such as java.lang.Runnable that allows the thread pool to execute the command even though the thread pool class itself was written without any knowledge of the specific tasks for which it would be used.

Macro recording. If all user actions are represented by command objects, a program can record a sequence of actions simply by keeping a list of the command objects as they are executed. It can then play back the same actions by executing the same command objects again in sequence. If the program embeds a scripting engine, each command object can implement a toScript() method, and user actions can then be easily recorded as scripts.

=Examples=

This Python program defines a command class for sending a simple SMTP mail message. The test() function demonstrates how the command class can be used to send a message.

import email.MIMEText, smtplib class SendMailCommand: A simple command object for sending SMTP mail. def __init__(self): self.server = mail self.port = smtplib.SMTP_PORT self.sender = None self.recipient = None self.subject = self.message = def execute(self): Send the message via SMTP. msg = email.MIMEText.MIMEText(self.message) msg[ Subject ] = self.subject msg[ From ] = self.sender msg[ To ] = self.recipient s = smtplib.SMTP(self.server, self.port) s.sendmail(self.sender, [self.recipient], msg.as_string()) s.close() def test(): smc = SendMailCommand() smc.sender = smc.recipient = smc.subject = Design patterns smc.message = file( dp.txt ).read() smc.execute()

The next example defines a class, ThreadPool, for executing commands asynchronously.

import threading, Queue class _WorkerThread(threading.Thread): def __init__(self, queue): self.queue = queue def run(self): while True: cmd = self.queue.get() cmd.execute() class ThreadPool: A simple thread pool for executing commands asynchronously. def __init__(self, N=4): self.queue = Queue.Queue() self.threads = [] for i in range(N): t = _WorkerThread(self.queue) t.start() self.threads.append(t) def addCommand(self, cmd): Add a command to the queue of tasks. The command will be executed in a worker thread. Commands are executed in first-come-first-served order. cmd - Any object with an .execute() method that accepts 0 arguments. self.queue.put(cmd)

This generic thread pool works with any command object. It could be passed SendMailCommand objects, for example. Generic code that operates on command objects can be powerful and flexible while providing a simple API.

(Note: For brevity, this example omits many features that a real-world thread pool should have, such as exception handling.)

=References=

= External links =