From 741d09bfc2323ea97fd587542fe395aa2923883f Mon Sep 17 00:00:00 2001
From: bjculkin <bjculkin@WIT-136XG42.wvu-ad.wvu.edu>
Date: Mon, 3 Apr 2017 10:50:00 -0400
Subject: Work on utility functions

---
 src/main/java/bjc/inflexion/InflectionUtils.java | 82 ++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 src/main/java/bjc/inflexion/InflectionUtils.java

(limited to 'src/main/java/bjc')

diff --git a/src/main/java/bjc/inflexion/InflectionUtils.java b/src/main/java/bjc/inflexion/InflectionUtils.java
new file mode 100644
index 0000000..6ea0ac3
--- /dev/null
+++ b/src/main/java/bjc/inflexion/InflectionUtils.java
@@ -0,0 +1,82 @@
+/**
+ * (C) Copyright 2017 Benjamin Culkin.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package bjc.inflexion;
+
+/**
+ * Utility functions for inflections.
+ * 
+ * Whenever a suffix is mentioned, it should be provided in the format of a
+ * leading '-', followed by a regular expression.
+ * 
+ * @author bjculkin
+ *
+ */
+public class InflectionUtils {
+	/**
+	 * Returns true if the given word ends in the given suffix.
+	 * 
+	 * @param word
+	 *                The word to check.
+	 * 
+	 * @param suffix
+	 *                The suffix to check for.
+	 * 
+	 * @return Whether or not the provided word ends in the provided suffix.
+	 */
+	public static boolean suffix(String word, String suffix) {
+		/*
+		 * TODO implement me.
+		 */
+		return false;
+	}
+
+	/**
+	 * Check if the given word inflects from the given singular suffix to
+	 * the given plural suffix.
+	 * 
+	 * @param word
+	 *                The word to check.
+	 * 
+	 * @param singular
+	 *                The singular suffix.
+	 * 
+	 * @param plural
+	 *                The plural suffix.
+	 * 
+	 * @return Whether or not the provided word is in that inflection
+	 *         category.
+	 */
+	public static boolean category(String word, String singular, String plural) {
+		/*
+		 * TODO implement me.
+		 */
+		return false;
+	}
+
+	/**
+	 * 
+	 * @param word
+	 * @param singular
+	 * @param plural
+	 * @return
+	 */
+	public static String inflect(String word, String singular, String plural) {
+		/*
+		 * TODO implement me.
+		 */
+		return null;
+	}
+}
-- 
cgit v1.2.3