git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[JGIT PATCH 03/22] Added a class Project which represents a project directory and it's repository.

From
FKFlorian Koeberle <florianskarten@web.de>
Date
May 10, 2008, 13:00 UTC
Message-ID
<1210424440-13886-4-git-send-email-florianskarten@web.de>
In-Reply-To
<1210424440-13886-1-git-send-email-florianskarten@web.de>
Signed-off-by: Florian Koeberle <florianskarten@web.de>
---
 .../src/org/spearce/jgit/lib/GitPathConstants.java |   28 +++++++++
 .../src/org/spearce/jgit/lib/Project.java          |   63 ++++++++++++++++++++
 .../src/org/spearce/jgit/lib/ProjectFactory.java   |   57 ++++++++++++++++++
 3 files changed, 148 insertions(+), 0 deletions(-)
 create mode 100644 org.spearce.jgit/src/org/spearce/jgit/lib/GitPathConstants.java
 create mode 100644 org.spearce.jgit/src/org/spearce/jgit/lib/Project.java
 create mode 100644 org.spearce.jgit/src/org/spearce/jgit/lib/ProjectFactory.java
diff --git a/org.spearce.jgit/src/org/spearce/jgit/lib/GitPathConstants.java b/org.spearce.jgit/src/org/spearce/jgit/lib/GitPathConstants.java
new file mode 100644
index 0000000..3d99d33
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/lib/GitPathConstants.java
@@ -0,0 +1,28 @@
+package org.spearce.jgit.lib;
+
+/**
+ * Collection of constants related to the git repository directory layout.
+ * 
+ */
+public class GitPathConstants {
+	/**
+	 * The name of the repository directory in the project directory.
+	 */
+	public static final String REPOSITORY_DIRECTORY_NAME = ".git";
+
+	/**
+	 * Contains the name of the objects directory in the repository directory.
+	 */
+	public static final String OBJECTS_DIRECTORY_NAME = "objects";
+
+	/**
+	 * Contains the name of the refs directory in the repository directory.
+	 */
+	public static final String REFS_DIRECTORY_NAME = "refs";
+	
+	/**
+	 * Contains the name of the HEAD file in the repository directory.
+	 */
+	public static final String HEAD_FILE_NAME = "HEAD";
+
+}
diff --git a/org.spearce.jgit/src/org/spearce/jgit/lib/Project.java b/org.spearce.jgit/src/org/spearce/jgit/lib/Project.java
new file mode 100644
index 0000000..6e72486
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/lib/Project.java
@@ -0,0 +1,63 @@
+/*
+ *  Copyright (C) 2008 Florian Köberle
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU General Public
+ *  License, version 2, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ */
+package org.spearce.jgit.lib;
+
+import java.io.File;
+
+/**
+ * Represents a project controlled by git. Use {@link ProjectFactory} in order to create an object of this class.
+ * @author Florian Köberle
+ *
+ */
+public class Project {
+	private final File directory;
+
+	private final Repository repository;
+
+	/**
+	 * This constructor should be only used by the class {@link ProjectFactory}.
+	 * @param directory defines the value of the directory field.
+	 * @param repository defines the value of the repository field.
+	 */
+	Project(File directory, Repository repository) {
+		this.directory = directory;
+		this.repository = repository;
+	}
+
+	/**
+	 * 
+	 * @return the directory which contains the files of the project. Usually this directory contain a .git directory with the repository.
+	 */
+	public File getDirectory() {
+		return directory;
+	}
+
+	/**
+	 * @return the {@link Repository} object of the project.
+	 */
+	public Repository getRepository() {
+		return repository;
+	}
+
+	/**
+	 * Closes the git repository of this project.
+	 */
+	public void closeRepository() {
+		repository.close();
+	}
+
+}
diff --git a/org.spearce.jgit/src/org/spearce/jgit/lib/ProjectFactory.java b/org.spearce.jgit/src/org/spearce/jgit/lib/ProjectFactory.java
new file mode 100644
index 0000000..b4e5660
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/lib/ProjectFactory.java
@@ -0,0 +1,57 @@
+/*
+ *  Copyright (C) 2008 Florian Köberle
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU General Public
+ *  License, version 2, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ */
+package org.spearce.jgit.lib;
+
+import java.io.File;
+import java.io.IOException;
+import static org.spearce.jgit.lib.GitPathConstants.REPOSITORY_DIRECTORY_NAME;
+
+/**
+ * Creates a new {@link Project} and initialize a repository for it. 
+ * 
+ * @author Florian Köberle
+ * 
+ */
+public class ProjectFactory {
+
+	/**
+	 * @param projectDirectory
+	 *            the directory with the project files.
+	 * @return a new project with a new and open repository.
+	 * @throws IOException
+	 *             thrown by {@link Repository#create()}
+	 */
+	public Project createProject(File projectDirectory) throws IOException {
+		final File gitDirectory = new File(projectDirectory, REPOSITORY_DIRECTORY_NAME);
+		if (gitDirectory.exists()) {
+			throw new IllegalArgumentException(
+					"Repository exists in given project directory.");
+		}
+		final Repository repository = new Repository(gitDirectory);
+		try {
+			repository.create();
+			return new Project(projectDirectory, repository);
+		} catch (RuntimeException e) {
+			repository.close();
+			throw e;
+		} catch (IOException e) {
+			repository.close();
+			throw e;
+		}
+	}
+
+}
-- 
1.5.2.5
Previous: Florian KoeberleNext: Robin Rosenberg
Message 4 of 35 in “Implementation of a file tree iteration using ignore rules.”
  1. Implementation of a file tree iteration using ignore rules.Florian Koeberle, May 10, 2008
  2. 01/22 Start of an implementation of a git like command line tool.Florian Koeberle, May 10, 2008
  3. 02/22 Replaced Java 6 API useage with Java 5 equivalent.Florian Koeberle, May 10, 2008
  4. 03/22 Added a class Project which represents a project directory and it's repository.Florian Koeberle, May 10, 2008
  5. Robin RosenbergMay 10, 2008
  6. 04/22 Added a "init" command to the git like command line tool.Florian Koeberle, May 10, 2008
  7. 05/22 Added ProjectSeeker class.Florian Koeberle, May 10, 2008
  8. Robin RosenbergMay 10, 2008
  9. 06/22 Added the interface FilePattern.Florian Koeberle, May 10, 2008
  10. 07/22 Added the class Rule.Florian Koeberle, May 10, 2008
  11. 08/22 Added the iterface Rules.Florian Koeberle, May 10, 2008
  12. Robin RosenbergMay 10, 2008
  13. 09/22 Added the class FileTreeIterator and a test for it.Florian Koeberle, May 10, 2008
  14. 10/22 Added class FileTreeIterable.Florian Koeberle, May 10, 2008
  15. 11/22 Added the class StarPattern.Florian Koeberle, May 10, 2008
  16. Robin RosenbergMay 10, 2008
  17. 12/22 Added the class GlobalFilePatternFlorian Koeberle, May 10, 2008
  18. 13/22 Added the class ComplexFilePattern.Florian Koeberle, May 10, 2008
  19. Robin RosenbergMay 10, 2008
  20. 14/22 Added the class IgnoreRuleListFactory.Florian Koeberle, May 10, 2008
  21. Robin RosenbergMay 10, 2008
  22. 15/22 Added a Rules interface implementation and a factory for it.Florian Koeberle, May 10, 2008
  23. 16/22 Added test class OverallIgnoreRulestest.Florian Koeberle, May 10, 2008
  24. 17/22 Added the class TreeFilePattern.Florian Koeberle, May 10, 2008
  25. 18/22 Added InvalidPatternException and PathNotInProjectDirectoryExceptionFlorian Koeberle, May 10, 2008
  26. Robin RosenbergMay 10, 2008
  27. 19/22 Added the class AddRuleListFactory.Florian Koeberle, May 10, 2008
  28. Robin RosenbergMay 10, 2008
  29. 20/22 Added class FileIterableFactoryForAddCommand.Florian Koeberle, May 10, 2008
  30. 21/22 Added test class FileIterableFactoryForAddCommandTest.Florian Koeberle, May 10, 2008
  31. Robin RosenbergMay 10, 2008
  32. 22/22 Added a "add" command to the git like command line tool.Florian Koeberle, May 10, 2008
  33. Robin RosenbergMay 10, 2008
  34. Robin RosenbergMay 10, 2008
  35. Shawn O. PearceMay 11, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.