1 /*
2 * Copyright (C) 2018, Google LLC.
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 package org.eclipse.jgit.transport;
44
45 import java.util.Collections;
46 import java.util.List;
47
48 /**
49 * ls-refs protocol v2 request.
50 *
51 * <p>
52 * This is used as an input to {@link ProtocolV2Hook}.
53 *
54 * @since 5.1
55 */
56 public final class LsRefsV2Request {
57 private final List<String> refPrefixes;
58
59 private final boolean symrefs;
60
61 private final boolean peel;
62
63 private LsRefsV2Request(List<String> refPrefixes, boolean symrefs,
64 boolean peel) {
65 this.refPrefixes = refPrefixes;
66 this.symrefs = symrefs;
67 this.peel = peel;
68 }
69
70 /** @return ref prefixes that the client requested. */
71 public List<String> getRefPrefixes() {
72 return refPrefixes;
73 }
74
75 /** @return true if the client requests symbolic references. */
76 public boolean getSymrefs() {
77 return symrefs;
78 }
79
80 /** @return true if the client requests tags to be peeled. */
81 public boolean getPeel() {
82 return peel;
83 }
84
85 /** @return A builder of {@link LsRefsV2Request}. */
86 public static Builder builder() {
87 return new Builder();
88 }
89
90 /** A builder for {@link LsRefsV2Request}. */
91 public static final class Builder {
92 private List<String> refPrefixes = Collections.emptyList();
93
94 private boolean symrefs;
95
96 private boolean peel;
97
98 private Builder() {
99 }
100
101 /**
102 * @param value
103 * @return the Builder
104 */
105 public Builder setRefPrefixes(List<String> value) {
106 refPrefixes = value;
107 return this;
108 }
109
110 /**
111 * @param value
112 * @return the Builder
113 */
114 public Builder setSymrefs(boolean value) {
115 symrefs = value;
116 return this;
117 }
118
119 /**
120 * @param value
121 * @return the Builder
122 */
123 public Builder setPeel(boolean value) {
124 peel = value;
125 return this;
126 }
127
128 /** @return LsRefsV2Request */
129 public LsRefsV2Request build() {
130 return new LsRefsV2Request(
131 Collections.unmodifiableList(refPrefixes), symrefs, peel);
132 }
133 }
134 }