View Javadoc
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.lib;
44  
45  import org.eclipse.jgit.lib.AnyObjectId;
46  
47  /**
48   * A .gitmodules file found in the pack. Store the blob of the file itself (e.g.
49   * to access its contents) and the tree where it was found (e.g. to check if it
50   * is in the root)
51   *
52   * @since 4.7.5
53   */
54  public final class GitmoduleEntry {
55  	private final AnyObjectId treeId;
56  
57  	private final AnyObjectId blobId;
58  
59  	/**
60  	 * A record of (tree, blob) for a .gitmodule file in a pack
61  	 *
62  	 * @param treeId
63  	 *            tree id containing a .gitmodules entry
64  	 * @param blobId
65  	 *            id of the blob of the .gitmodules file
66  	 */
67  	public GitmoduleEntry(AnyObjectId../../../org/eclipse/jgit/lib/AnyObjectId.html#AnyObjectId">AnyObjectId treeId, AnyObjectId blobId) {
68  		// AnyObjectId's are reused, must keep a copy.
69  		this.treeId = treeId.copy();
70  		this.blobId = blobId.copy();
71  	}
72  
73  	/**
74  	 * @return Id of a .gitmodules file found in the pack
75  	 */
76  	public AnyObjectId getBlobId() {
77  		return blobId;
78  	}
79  
80  	/**
81  	 * @return Id of a tree object where the .gitmodules file was found
82  	 */
83  	public AnyObjectId getTreeId() {
84  		return treeId;
85  	}
86  }