-package uk.ac.vamsas.client.simpleclient;
-
-import java.io.File;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-/**
- * methods for setting and checking
- * binary flags in a vamsas session directory.
- * all methods apart from the constructor will
- * throw a fatal error if the flagFile is not
- * a valid java.io.File object.
- * LATER: extract SessionFlag interface for generalizing the vamsas session code
- * @author jimp
- *
- */
-public class SessionFlagFile {
- private static Log log = LogFactory.getLog(SessionFlagFile.class);
- protected File flagFile=null;
- private void checkFlagFile() {
- if (flagFile==null) {
- log.fatal("Implementation error - uninitialized SessionFlagFile",
- new Error("Implementation error - uninitialized SessionFlagFile"));
- }
- }
- /**
- * will log a warning if exceptions occur during flag creation.
- * @return true if flag was set successfully
- */
- public boolean setFlag() {
- checkFlagFile();
- try {
- if (flagFile.createNewFile()) {
- log.debug("Set session flag "+flagFile);
- } else {
- log.debug("Session flag already set "+flagFile);
- }
- return true;
- }
- catch (Exception e) {
- log.warn("Couldn't set session flag "+flagFile, e);
- }
- return false;
- }
- /**
- *
- * @return true if flag was cleared successfully
- */
- public boolean clearFlag() {
- checkFlagFile();
- if (flagFile.exists()) {
- log.debug("clearing session flag "+flagFile);
- if (!flagFile.delete()) {
- log.warn("failed to clear session flag "+flagFile);
- return false;
- }
- } else {
- log.debug("clearFlag called for already cleared flag "+flagFile);
- }
- return true;
- }
- /**
- *
- * @return state of session flag
- */
- public boolean checkFlag() {
- checkFlagFile();
- if (flagFile.exists()) {
- if (log.isDebugEnabled())
- log.debug("Flag '"+flagFile+"' is set.");
- return true;
- }
- if (log.isDebugEnabled())
- log.debug("Flag '"+flagFile+"' is not set.");
- return false;
- }
- /**
- * @param flagFile
- */
- public SessionFlagFile(File flagFile) {
- super();
- this.flagFile = flagFile;
- };
-}
+/*\r
+ * This file is part of the Vamsas Client version 0.1. \r
+ * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite, \r
+ * Andrew Waterhouse and Dominik Lindner.\r
+ * \r
+ * Earlier versions have also been incorporated into Jalview version 2.4 \r
+ * since 2008, and TOPALi version 2 since 2007.\r
+ * \r
+ * The Vamsas Client is free software: you can redistribute it and/or modify\r
+ * it under the terms of the GNU Lesser General Public License as published by\r
+ * the Free Software Foundation, either version 3 of the License, or\r
+ * (at your option) any later version.\r
+ * \r
+ * The Vamsas Client is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU Lesser General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU Lesser General Public License\r
+ * along with the Vamsas Client. If not, see <http://www.gnu.org/licenses/>.\r
+ */\r
+package uk.ac.vamsas.client.simpleclient;\r
+\r
+import java.io.File;\r
+\r
+import org.apache.commons.logging.Log;\r
+import org.apache.commons.logging.LogFactory;\r
+\r
+/**\r
+ * methods for setting and checking binary flags in a vamsas session directory.\r
+ * all methods apart from the constructor will throw a fatal error if the\r
+ * flagFile is not a valid java.io.File object. LATER: extract SessionFlag\r
+ * interface for generalizing the vamsas session code\r
+ * \r
+ * @author jimp\r
+ * \r
+ */\r
+public class SessionFlagFile {\r
+ private static Log log = LogFactory.getLog(SessionFlagFile.class);\r
+\r
+ protected File flagFile = null;\r
+\r
+ private void checkFlagFile() {\r
+ if (flagFile == null) {\r
+ log.fatal("Implementation error - uninitialized SessionFlagFile",\r
+ new Error("Implementation error - uninitialized SessionFlagFile"));\r
+ }\r
+ }\r
+\r
+ /**\r
+ * will log a warning if exceptions occur during flag creation.\r
+ * \r
+ * @return true if flag was set successfully\r
+ */\r
+ public boolean setFlag() {\r
+ checkFlagFile();\r
+ try {\r
+ if (flagFile.createNewFile()) {\r
+ log.debug("Set session flag " + flagFile);\r
+ } else {\r
+ log.debug("Session flag already set " + flagFile);\r
+ }\r
+ return true;\r
+ } catch (Exception e) {\r
+ log.warn("Couldn't set session flag " + flagFile, e);\r
+ }\r
+ return false;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * @return true if flag was cleared successfully\r
+ */\r
+ public boolean clearFlag() {\r
+ checkFlagFile();\r
+ if (flagFile.exists()) {\r
+ log.debug("clearing session flag " + flagFile);\r
+ if (!flagFile.delete()) {\r
+ log.warn("failed to clear session flag " + flagFile);\r
+ return false;\r
+ }\r
+ } else {\r
+ log.debug("clearFlag called for already cleared flag " + flagFile);\r
+ }\r
+ return true;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * @return state of session flag\r
+ */\r
+ public boolean checkFlag() {\r
+ checkFlagFile();\r
+ if (flagFile.exists()) {\r
+ if (log.isDebugEnabled())\r
+ log.debug("Flag '" + flagFile + "' is set.");\r
+ return true;\r
+ }\r
+ if (log.isDebugEnabled())\r
+ log.debug("Flag '" + flagFile + "' is not set.");\r
+ return false;\r
+ }\r
+\r
+ /**\r
+ * @param flagFile\r
+ */\r
+ public SessionFlagFile(File flagFile) {\r
+ super();\r
+ this.flagFile = flagFile;\r
+ };\r
+}\r
git://source.jalview.org / vamsas.git / blobdiff