From 91f24a2b73729e7c79db653561b0b34b8ca60d2d Mon Sep 17 00:00:00 2001
From: felmer <felmer>
Date: Thu, 11 Oct 2007 15:57:39 +0000
Subject: [PATCH] LMS-103 add Javadoc
SVN: 2137
---
.../java/ch/systemsx/cisd/bds/Utilities.java | 23 ++++++++++++++++++-
.../java/ch/systemsx/cisd/bds/Version.java | 3 +++
2 files changed, 25 insertions(+), 1 deletion(-)
diff --git a/bds/source/java/ch/systemsx/cisd/bds/Utilities.java b/bds/source/java/ch/systemsx/cisd/bds/Utilities.java
index fe35444a159..bacac1b89dc 100644
--- a/bds/source/java/ch/systemsx/cisd/bds/Utilities.java
+++ b/bds/source/java/ch/systemsx/cisd/bds/Utilities.java
@@ -22,12 +22,19 @@ import ch.systemsx.cisd.bds.storage.INode;
import ch.systemsx.cisd.common.exceptions.UserFailureException;
/**
- *
+ * Storage utility methods.
*
* @author Franz-Josef Elmer
*/
public class Utilities
{
+ /**
+ * Returns a subdirectory from the specified directory.
+ *
+ * @param directory Parent directory of the requested directory.
+ * @param name Name of the requested directory.
+ * @throws UserFailureException if requested directory not found.
+ */
public static IDirectory getSubDirectory(IDirectory directory, String name)
{
INode node = directory.getNode(name);
@@ -38,11 +45,21 @@ public class Utilities
return (IDirectory) node;
}
+ /**
+ * Convenient short cut for <code>{@link #getString(IDirectory, String)}.trim()</code>.
+ */
public static String getTrimmedString(IDirectory directory, String name)
{
return getString(directory, name).trim();
}
+ /**
+ * Returns the string content of a file from the specified directory.
+ *
+ * @param directory Directory of the requested file.
+ * @param name Name of the file.
+ * @throws UserFailureException if the requested file does not exist.
+ */
public static String getString(IDirectory directory, String name)
{
INode node = directory.getNode(name);
@@ -58,4 +75,8 @@ public class Utilities
return file.getStringContent();
}
+ private Utilities()
+ {
+ }
+
}
diff --git a/bds/source/java/ch/systemsx/cisd/bds/Version.java b/bds/source/java/ch/systemsx/cisd/bds/Version.java
index 3a3eb319295..e71459aa7c2 100644
--- a/bds/source/java/ch/systemsx/cisd/bds/Version.java
+++ b/bds/source/java/ch/systemsx/cisd/bds/Version.java
@@ -30,6 +30,9 @@ public final class Version
private static final String MAJOR = "major";
private static final String MINOR = "minor";
+ /**
+ * Loads the version from the specified directory.
+ */
public static Version loadFrom(IDirectory directory)
{
IDirectory versionFolder = Utilities.getSubDirectory(directory, VERSION);
--
GitLab