1 /*
2 * Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com> and
3 * other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Distribution License v1.0 which accompanies this
7 * distribution, is reproduced below, and is available at
8 * http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * - Redistributions of source code must retain the above copyright notice, this
16 * list of conditions and the following disclaimer.
17 *
18 * - Redistributions in binary form must reproduce the above copyright notice,
19 * this list of conditions and the following disclaimer in the documentation
20 * and/or other materials provided with the distribution.
21 *
22 * - Neither the name of the Eclipse Foundation, Inc. nor the names of its
23 * contributors may be used to endorse or promote products derived from this
24 * software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
30 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38 package org.eclipse.jgit.api.errors;
39
40 import java.text.MessageFormat;
41
42 import org.eclipse.jgit.internal.JGitText;
43 import org.eclipse.jgit.lib.Ref;
44 import org.eclipse.jgit.lib.RefUpdate;
45
46 /**
47 * Exception thrown when a command wants to update a ref but failed because
48 * another process is accessing (or even also updating) the ref.
49 *
50 * @see org.eclipse.jgit.lib.RefUpdate.Result#LOCK_FAILURE
51 */
52 public class ConcurrentRefUpdateException extends GitAPIException {
53 private static final long serialVersionUID = 1L;
54 private RefUpdate.Result rc;
55 private Ref ref;
56
57 /**
58 * Constructor for ConcurrentRefUpdateException.
59 *
60 * @param message
61 * error message
62 * @param ref
63 * a {@link org.eclipse.jgit.lib.Ref}
64 * @param rc
65 * a {@link org.eclipse.jgit.lib.RefUpdate.Result}
66 * @param cause
67 * a {@link java.lang.Throwable}
68 */
69 public ConcurrentRefUpdateException(String message, Ref ref,
70 RefUpdate.Result rc, Throwable cause) {
71 super((rc == null) ? message : message + ". " //$NON-NLS-1$
72 + MessageFormat.format(JGitText.get().refUpdateReturnCodeWas, rc), cause);
73 this.rc = rc;
74 this.ref = ref;
75 }
76
77 /**
78 * Constructor for ConcurrentRefUpdateException.
79 *
80 * @param message
81 * error message
82 * @param ref
83 * a {@link org.eclipse.jgit.lib.Ref}
84 * @param rc
85 * a {@link org.eclipse.jgit.lib.RefUpdate.Result}
86 */
87 public ConcurrentRefUpdateException(String message, Ref ref,
88 RefUpdate.Result rc) {
89 super((rc == null) ? message : message + ". " //$NON-NLS-1$
90 + MessageFormat.format(JGitText.get().refUpdateReturnCodeWas, rc));
91 this.rc = rc;
92 this.ref = ref;
93 }
94
95 /**
96 * Get <code>Ref</code>
97 *
98 * @return the {@link org.eclipse.jgit.lib.Ref} which was tried to by
99 * updated
100 */
101 public Ref getRef() {
102 return ref;
103 }
104
105 /**
106 * Get result
107 *
108 * @return the result which was returned by
109 * {@link org.eclipse.jgit.lib.RefUpdate#update()} and which caused
110 * this error
111 */
112 public RefUpdate.Result getResult() {
113 return rc;
114 }
115 }