1 /*
2 * #%L
3 * JavaHg
4 * %%
5 * Copyright (C) 2011 aragost Trifork ag
6 * %%
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 * #L%
25 */
26 package com.aragost.javahg.commands;
27
28 import java.io.File;
29 import java.util.List;
30
31 import com.aragost.javahg.Repository;
32 import com.aragost.javahg.commands.flags.RemoveCommandFlags;
33 import com.aragost.javahg.internals.AddRemoveCommandHelper;
34
35 /**
36 * Command class for executing <tt>hg remove</tt>. Set flags from
37 * {@link RemoveCommandFlags} and call the {@link #execute} method.
38 */
39 public class RemoveCommand extends RemoveCommandFlags {
40
41 private AddRemoveCommandHelper helper;
42
43 /**
44 * @param repository
45 * the repository associated with this command.
46 */
47 public RemoveCommand(Repository repository) {
48 super(repository);
49 helper = new AddRemoveCommandHelper(this, "removing ");
50 withDebugFlag();
51 }
52
53 /**
54 * Check if the command ended successfully.
55 * <p>
56 * In contrast with Mercurial, a return code of 1 is considered to
57 * be successful. Mercurial returns 1 if some files could not be
58 * found, but at the same time it does remove the files that could
59 * be found.
60 *
61 * @return true if the command exited with 0 or 1.
62 */
63 @Override
64 public boolean isSuccessful() {
65 return super.isSuccessful() || getReturnCode() == 1;
66 }
67
68 /**
69 * Execute the remove command, and return list of files removed.
70 *
71 * @param files
72 * the files and directories to remove.
73 * @return list of removed files.
74 */
75 public List<String> execute(String... files) {
76 return this.helper.execute(files);
77 }
78
79 /**
80 * Execute the remove command, and return list of files removed.
81 *
82 * @param files
83 * the files and directories to remove.
84 * @return list of removed files.
85 */
86 public List<File> execute(File... files) {
87 return this.helper.execute(files);
88 }
89
90 public List<File> execute() {
91 return this.helper.execute();
92 }
93 }