From 16ef06d210bec7dd5b44d82f70d9f7bb9e4dbf6f Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Thu, 01 May 2014 14:26:28 -0400
Subject: [PATCH] Documentation

---
 src/main/java/com/gitblit/manager/IRuntimeManager.java |   26 +++++++++++++++++++++++++-
 1 files changed, 25 insertions(+), 1 deletions(-)

diff --git a/src/main/java/com/gitblit/manager/IRuntimeManager.java b/src/main/java/com/gitblit/manager/IRuntimeManager.java
index 178b93c..29e7368 100644
--- a/src/main/java/com/gitblit/manager/IRuntimeManager.java
+++ b/src/main/java/com/gitblit/manager/IRuntimeManager.java
@@ -17,6 +17,7 @@
 
 import java.io.File;
 import java.util.Date;
+import java.util.Locale;
 import java.util.Map;
 import java.util.TimeZone;
 
@@ -24,7 +25,7 @@
 import com.gitblit.models.ServerSettings;
 import com.gitblit.models.ServerStatus;
 
-public interface IRuntimeManager {
+public interface IRuntimeManager extends IManager {
 
 	void setBaseFolder(File folder);
 
@@ -34,14 +35,24 @@
 	 * Returns the preferred timezone for the Gitblit instance.
 	 *
 	 * @return a timezone
+ 	 * @since 1.4.0
 	 */
 	TimeZone getTimezone();
+
+	/**
+	 * Returns the fixed locale for clients, or null if clients may choose their locale
+	 *
+	 * @return a fixed locale or null if clients are allowed to specify locale preference
+ 	 * @since 1.5.1
+	 */
+	Locale getLocale();
 
 	/**
 	 * Determine if this Gitblit instance is actively serving git repositories
 	 * or if it is merely a repository viewer.
 	 *
 	 * @return true if Gitblit is serving repositories
+ 	 * @since 1.4.0
 	 */
 	boolean isServingRepositories();
 
@@ -49,6 +60,7 @@
 	 * Determine if this Gitblit instance is running in debug mode
 	 *
 	 * @return true if Gitblit is running in debug mode
+ 	 * @since 1.4.0
 	 */
 	boolean isDebugMode();
 
@@ -56,15 +68,23 @@
 	 * Returns the boot date of the Gitblit server.
 	 *
 	 * @return the boot date of Gitblit
+ 	 * @since 1.4.0
 	 */
 	Date getBootDate();
 
+	/**
+	 * Returns the server status.
+	 *
+	 * @return the server status
+  	 * @since 1.4.0
+	 */
 	ServerStatus getStatus();
 
 	/**
 	 * Returns the descriptions/comments of the Gitblit config settings.
 	 *
 	 * @return SettingsModel
+ 	 * @since 1.4.0
 	 */
 	ServerSettings getSettingsModel();
 
@@ -72,6 +92,7 @@
 	 * Returns the file object for the specified configuration key.
 	 *
 	 * @return the file
+ 	 * @since 1.4.0
 	 */
 	File getFileOrFolder(String key, String defaultFileOrFolder);
 
@@ -83,6 +104,7 @@
 	 * access based on environment or some other indicator.
 	 *
 	 * @return the file
+ 	 * @since 1.4.0
 	 */
 	File getFileOrFolder(String fileOrFolder);
 
@@ -90,6 +112,7 @@
 	 * Returns the runtime settings.
 	 *
 	 * @return settings
+ 	 * @since 1.4.0
 	 */
 	IStoredSettings getSettings();
 
@@ -98,6 +121,7 @@
 	 *
 	 * @param settings
 	 * @return true if the update succeeded
+ 	 * @since 1.4.0
 	 */
 	boolean updateSettings(Map<String, String> updatedSettings);
 }
\ No newline at end of file

--
Gitblit v1.9.1