org.eclipse.jgit/src/org/eclipse/jgit/lib/RepositoryBuilder.java

   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.lib;
  45
  46 import java.io.File;
  47
  48 /**
  49  * Base class to support constructing a {@link Repository}.
  50  * <p>
  51  * Applications must set one of {@link #setGitDir(File)} or
  52  * {@link #setWorkTree(File)}, or use {@link #readEnvironment()} or
  53  * {@link #findGitDir()} in order to configure the minimum property set
  54  * necessary to open a repository.
  55  * <p>
  56  * Single repository applications trying to be compatible with other Git
  57  * implementations are encouraged to use a model such as:
  58  *
  59  * <pre>
  60  * new RepositoryBuilder() //
  61  *              .setGitDir(gitDirArgument) // --git-dir if supplied, no-op if null
  62  *              .readEnviroment() // scan environment GIT_* variables
  63  *              .findGitDir() // scan up the file system tree
  64  *              .build()
  65  * </pre>
  66  *
  67  * @see FileRepositoryBuilder
  68  */
  69 public class RepositoryBuilder extends
  70                 BaseRepositoryBuilder<RepositoryBuilder, Repository> {
  71         // Empty implementation, everything is inherited.
  72 }