1 /*
2 * Copyright (C) 2017 Two Sigma Open Source
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at 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
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.transport;
45
46 import java.io.Serializable;
47
48 /**
49 * Describes the expected value for a ref being pushed.
50 *
51 * @since 4.7
52 */
53 public class RefLeaseSpec implements Serializable {
54 private static final long serialVersionUID = 1L;
55
56 /** Name of the ref whose value we want to check. */
57 private final String ref;
58
59 /** Local commitish to get expected value from. */
60 private final String expected;
61
62 /**
63 * <p>Constructor for RefLeaseSpec.</p>
64 *
65 * @param ref
66 * ref being pushed
67 * @param expected
68 * the expected value of the ref
69 */
70 public RefLeaseSpec(String ref, String expected) {
71 this.ref = ref;
72 this.expected = expected;
73 }
74
75 /**
76 * Get the ref to protect.
77 *
78 * @return name of ref to check.
79 */
80 public String getRef() {
81 return ref;
82 }
83
84 /**
85 * Get the expected value of the ref, in the form
86 * of a local committish
87 *
88 * @return expected ref value.
89 */
90 public String getExpected() {
91 return expected;
92 }
93
94 /** {@inheritDoc} */
95 @Override
96 public String toString() {
97 final StringBuilder r = new StringBuilder();
98 r.append(getRef());
99 r.append(':');
100 r.append(getExpected());
101 return r.toString();
102 }
103 }