1 /*
2 * Copyright (C) 2010, Google 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
44 package org.eclipse.jgit.storage.file;
45
46 import java.io.File;
47 import java.io.IOException;
48
49 import org.eclipse.jgit.errors.RepositoryNotFoundException;
50 import org.eclipse.jgit.internal.storage.file.FileRepository;
51 import org.eclipse.jgit.lib.BaseRepositoryBuilder;
52 import org.eclipse.jgit.lib.Repository;
53
54 /**
55 * Constructs a {@link FileRepository}.
56 * <p>
57 * Applications must set one of {@link #setGitDir(File)} or
58 * {@link #setWorkTree(File)}, or use {@link #readEnvironment()} or
59 * {@link #findGitDir()} in order to configure the minimum property set
60 * necessary to open a repository.
61 * <p>
62 * Single repository applications trying to be compatible with other Git
63 * implementations are encouraged to use a model such as:
64 *
65 * <pre>
66 * new FileRepositoryBuilder() //
67 * .setGitDir(gitDirArgument) // --git-dir if supplied, no-op if null
68 * .readEnviroment() // scan environment GIT_* variables
69 * .findGitDir() // scan up the file system tree
70 * .build()
71 * </pre>
72 */
73 public class FileRepositoryBuilder extends
74 BaseRepositoryBuilder<FileRepositoryBuilder, Repository> {
75 /**
76 * Create a repository matching the configuration in this builder.
77 * <p>
78 * If an option was not set, the build method will try to default the option
79 * based on other options. If insufficient information is available, an
80 * exception is thrown to the caller.
81 *
82 * @return a repository matching this configuration.
83 * @throws IllegalArgumentException
84 * insufficient parameters were set.
85 * @throws IOException
86 * the repository could not be accessed to configure the rest of
87 * the builder's parameters.
88 * @since 3.0
89 */
90 @Override
91 public Repository build() throws IOException {
92 FileRepository repo = new FileRepository(setup());
93 if (isMustExist() && !repo.getObjectDatabase().exists())
94 throw new RepositoryNotFoundException(getGitDir());
95 return repo;
96 }
97
98 /**
99 * Convenience factory method to construct a {@link FileRepository}.
100 *
101 * @param gitDir
102 * {@code GIT_DIR}, the repository meta directory.
103 * @return a repository matching this configuration.
104 * @throws IOException
105 * the repository could not be accessed to configure the rest of
106 * the builder's parameters.
107 * @since 3.0
108 */
109 public static Repository create(File gitDir) throws IOException {
110 return new FileRepositoryBuilder().setGitDir(gitDir).readEnvironment()
111 .build();
112 }
113 }