com.aragost.javahg.commands
Class AddCommand

java.lang.Object
  com.aragost.javahg.internals.AbstractCommand
      com.aragost.javahg.commands.flags.AddCommandFlags
          com.aragost.javahg.commands.AddCommand

public class AddCommand
extends AddCommandFlags

Command class for executing hg add. Set flags from AddCommandFlags and see the execute(String...) method for how to run the command.

Nested Class Summary

Nested classes/interfaces inherited from class com.aragost.javahg.internals.AbstractCommand

AbstractCommand.State

Constructor Summary

AddCommand(Repository repository)

Method Summary

List<File>	execute()
List<File>	execute(File... paths)
List<String>	execute(String... paths) Execute the add command, and return list of files added.
boolean	isSuccessful() Check if the command ended successfully.

Methods inherited from class com.aragost.javahg.commands.flags.AddCommandFlags

exclude, getCommandName, include, on

Methods inherited from class com.aragost.javahg.internals.AbstractCommand

cancel, clear, cmdAppend, cmdAppend, cmdAppend, cmdAppend, cmdAppend, doneHook, getErrorString, getRepository, getReturnCode, launchIterator, launchStream, launchString, needsInputLine, reopenOutputChannelStream, sendLine, toString, withDebugAndChangesetStyle, withDebugFlag

Methods inherited from class java.lang.Object

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

Constructor Detail

AddCommand

public AddCommand(Repository repository)

Parameters:

repository - the repository associated with this command.

Method Detail

isSuccessful

public boolean isSuccessful()

Check if the command ended successfully.

In contrast with Mercurial, a return code of 1 is considered to be successful. Mercurial returns 1 if some files could not be found, but at the same time it does add the files that could be found.

Overrides:

isSuccessful in class AbstractCommand

Returns:

true if the command exited with 0 or 1.

execute

public List<String> execute(String... paths)

Execute the add command, and return list of files added.

If a file could not be found, then Mercurial adds the other files and exit with a return code of 1. As described in isSuccessful(), we don't treat that as an error and the caller should instead inspect the returned list to see if all files were added.

Parameters:

paths - the files or directories to add. Leave empty to add all untracked files.

Returns:

list of files added actually.

execute

public List<File> execute(File... paths)

execute

public List<File> execute()