1 /*
2 * Copyright (C) 2011, GitHub Inc.
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.submodule;
44
45 import org.eclipse.jgit.lib.ObjectId;
46
47 /**
48 * Status class containing the type, path, and commit id of the submodule.
49 */
50 public class SubmoduleStatus {
51
52 private final SubmoduleStatusType type;
53
54 private final String path;
55
56 private final ObjectId indexId;
57
58 private final ObjectId headId;
59
60 /**
61 * Create submodule status
62 *
63 * @param type
64 * @param path
65 * @param indexId
66 */
67 public SubmoduleStatus(final SubmoduleStatusType type, final String path,
68 final ObjectId indexId) {
69 this(type, path, indexId, null);
70 }
71
72 /**
73 * Create submodule status
74 *
75 * @param type
76 * @param path
77 * @param indexId
78 * @param headId
79 */
80 public SubmoduleStatus(final SubmoduleStatusType type, final String path,
81 final ObjectId indexId, final ObjectId headId) {
82 this.type = type;
83 this.path = path;
84 this.indexId = indexId;
85 this.headId = headId;
86 }
87
88 /**
89 * @return type
90 */
91 public SubmoduleStatusType getType() {
92 return type;
93 }
94
95 /**
96 * @return path
97 */
98 public String getPath() {
99 return path;
100 }
101
102 /**
103 * @return index object id
104 */
105 public ObjectId getIndexId() {
106 return indexId;
107 }
108
109 /**
110 * @return HEAD object id
111 */
112 public ObjectId getHeadId() {
113 return headId;
114 }
115 }