View Javadoc

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.IOException;
29  import java.util.List;
30  
31  import com.aragost.javahg.Changeset;
32  import com.aragost.javahg.Repository;
33  import com.aragost.javahg.commands.flags.PullCommandFlags;
34  import com.aragost.javahg.internals.PullPushHelper;
35  
36  /**
37   * Command class for executing <tt>hg pull</tt>. Set flags from
38   * {@link PullCommandFlags} and call the {@link #execute} method.
39   */
40  public class PullCommand extends PullCommandFlags {
41  
42      /**
43       * @param repository
44       *            the repository associated with this command.
45       */
46      public PullCommand(Repository repository) {
47          super(repository);
48          withDebugFlag();
49          cmdAppend("-y");
50      }
51  
52      @Override
53      public boolean isSuccessful() {
54          return super.isSuccessful() || getReturnCode() == 1;
55      }
56  
57      private List<Changeset> run(String source) throws IOException {
58          if (source != null) {
59              cmdAppend(source);
60          }
61          // TODO: handle pushing multiple heads
62          return PullPushHelper.parseStream(this, launchStream());
63      }
64  
65      /**
66       * Run <tt>hg pull</tt> using the default path.
67       * 
68       * @return list of pulled changesets.
69       * @throws IOException
70       */
71      public List<Changeset> execute() throws IOException {
72          return run(null);
73      }
74  
75      /**
76       * Run <tt>hg pull source</tt> with an explicit source path.
77       * 
78       * @param source
79       *            the source path. Cannot be null.
80       * 
81       * @return list of pulled changesets.
82       * @throws IOException
83       */
84      public List<Changeset> execute(String source) throws IOException {
85          if (source == null) {
86              throw new NullPointerException("source cannot be null");
87          }
88          return run(source);
89      }
90  
91  }