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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Florian Koeberle <florianskarten@xxxxxx>
---
 .../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

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux