1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
* Copyright (C) 2009, Google Inc. and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.lib;
import java.io.IOException;
import org.eclipse.jgit.errors.IncorrectObjectTypeException;
import org.eclipse.jgit.errors.MissingObjectException;
/**
* Abstraction of arbitrary object storage.
* <p>
* An object database stores one or more Git objects, indexed by their unique
* {@link org.eclipse.jgit.lib.ObjectId}.
*/
public abstract class ObjectDatabase implements AutoCloseable {
/**
* Initialize a new database instance for access.
*/
protected ObjectDatabase() {
// Protected to force extension.
}
/**
* Does this database exist yet?
*
* @return true if this database is already created; false if the caller
* should invoke {@link #create()} to create this database location.
*/
public boolean exists() {
return true;
}
/**
* Initialize a new object database at this location.
*
* @throws java.io.IOException
* the database could not be created.
*/
public void create() throws IOException {
// Assume no action is required.
}
/**
* Create a new {@code ObjectInserter} to insert new objects.
* <p>
* The returned inserter is not itself thread-safe, but multiple concurrent
* inserter instances created from the same {@code ObjectDatabase} must be
* thread-safe.
*
* @return writer the caller can use to create objects in this database.
*/
public abstract ObjectInserter newInserter();
/**
* Create a new {@code ObjectReader} to read existing objects.
* <p>
* The returned reader is not itself thread-safe, but multiple concurrent
* reader instances created from the same {@code ObjectDatabase} must be
* thread-safe.
*
* @return reader the caller can use to load objects from this database.
*/
public abstract ObjectReader newReader();
/**
* Close any resources held by this database.
*/
@Override
public abstract void close();
/**
* Does the requested object exist in this database?
* <p>
* This is a one-shot call interface which may be faster than allocating a
* {@link #newReader()} to perform the lookup.
*
* @param objectId
* identity of the object to test for existence of.
* @return true if the specified object is stored in this database.
* @throws java.io.IOException
* the object store cannot be accessed.
*/
public boolean has(AnyObjectId objectId) throws IOException {
try (ObjectReader or = newReader()) {
return or.has(objectId);
}
}
/**
* Open an object from this database.
* <p>
* This is a one-shot call interface which may be faster than allocating a
* {@link #newReader()} to perform the lookup.
*
* @param objectId
* identity of the object to open.
* @return a {@link org.eclipse.jgit.lib.ObjectLoader} for accessing the object.
* @throws MissingObjectException
* the object does not exist.
* @throws java.io.IOException
* the object store cannot be accessed.
*/
public ObjectLoader open(AnyObjectId objectId)
throws IOException {
return open(objectId, ObjectReader.OBJ_ANY);
}
/**
* Open an object from this database.
* <p>
* This is a one-shot call interface which may be faster than allocating a
* {@link #newReader()} to perform the lookup.
*
* @param objectId
* identity of the object to open.
* @param typeHint
* hint about the type of object being requested, e.g.
* {@link org.eclipse.jgit.lib.Constants#OBJ_BLOB};
* {@link org.eclipse.jgit.lib.ObjectReader#OBJ_ANY} if the
* object type is not known, or does not matter to the caller.
* @return a {@link org.eclipse.jgit.lib.ObjectLoader} for accessing the
* object.
* @throws org.eclipse.jgit.errors.MissingObjectException
* the object does not exist.
* @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
* typeHint was not OBJ_ANY, and the object's actual type does
* not match typeHint.
* @throws java.io.IOException
* the object store cannot be accessed.
*/
public ObjectLoader open(AnyObjectId objectId, int typeHint)
throws MissingObjectException, IncorrectObjectTypeException,
IOException {
try (ObjectReader or = newReader()) {
return or.open(objectId, typeHint);
}
}
/**
* Create a new cached database instance over this database. This instance might
* optimize queries by caching some information about database. So some modifications
* done after instance creation might fail to be noticed.
*
* @return new cached database instance
*/
public ObjectDatabase newCachedDatabase() {
return this;
}
/**
* Get a quick, rough count of objects in this repository. Ignores loose
* objects. Returns {@code -1} if an exception occurs.
*
* @return quick, rough count of objects in this repository, {@code -1} if
* an exception occurs
* @since 6.1
*/
public abstract long getApproximateObjectCount();
}
|
