cleanup javadocs and dead code

Author: jamesrcounts

src/main/java/org/teachingextensions/approvals/lite/util/ClassUtils.java

@@ -6,18 +6,7 @@
 import java.util.List;
 
 public class ClassUtils {
-    /**
-     * ********************************************************************
-     */
-    public static String getClassName(Class<?> clazz) {
-        String name = clazz.getName();
-        int divider = name.lastIndexOf(".");
-        return name.substring(divider + 1);
-    }
 
-    /**
-     * ********************************************************************
-     */
     public static Class<?> getWrapperClass(Class<?> primitiveType) {
         if (boolean.class.equals(primitiveType)) {
             return Boolean.class;
@@ -39,10 +28,7 @@ public static Class<?> getWrapperClass(Class<?> primitiveType) {
             return primitiveType;
         }
     }
-    /************************************************************************/
-    /**
-     * ********************************************************************
-     */
+
     public static boolean hasMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes) {
         try {
             return clazz.getMethod(methodName, parameterTypes) != null;

src/main/java/org/teachingextensions/approvals/lite/util/DateDifference.java

@@ -1,10 +1,8 @@
 package org.teachingextensions.approvals.lite.util;
 
 import java.util.Calendar;
-import java.util.Date;
 
 public class DateDifference {
-    public static final String STANDARD_TIME_TEXT[] = {"Year", "Years", "Month", "Months", "Week", "Weeks", "Day", "Days", "Hour", "Hours", "Min", "Mins", "Sec", "Secs", "Milli", "Millis"};
     public static final String MILLISECONDS = "milliseconds";
     public static final String SECONDS = "seconds";
     public static final String MINUTES = "minutes";
@@ -17,38 +15,17 @@ public class DateDifference {
     // assumes a 30 day month
     private static int TIME_SCALE[] = {Calendar.YEAR, Calendar.MONTH, Calendar.WEEK_OF_YEAR, Calendar.DATE, Calendar.HOUR, Calendar.MINUTE, Calendar.SECOND, Calendar.MILLISECOND};
     private static long DIVIDERS[] = {1000 * 60 * 60 * 24 * 365L, 1000 * 60 * 60 * 24 * 30L, 1000 * 60 * 60 * 24 * 7L, 1000 * 60 * 60 * 24L, 1000 * 60 * 60L, 1000 * 60L, 1000L, 1L};
-    /**
-     * ********************************************************************
-     */
+
     private long milli;
 
-    /**
-     * ********************************************************************
-     */
     public DateDifference(long timeDifference) {
         this.milli = timeDifference;
     }
 
-    /**
-     * ********************************************************************
-     */
-    public DateDifference(Date date1, Date date2) {
-        milli = date1.getTime() - date2.getTime();
-        if (milli < 0) {
-            milli = milli * -1;
-        }
-    }
-
-    /**
-     * ********************************************************************
-     */
     public static long getAbsoluteDifference(int unit, long time) {
         return time / DIVIDERS[getTimeScaleIndex(unit)];
     }
 
-    /**
-     * ********************************************************************
-     */
     public static long getRemainingDifference(int wantedUnit, int roundTo, long time) {
         int wantedIndex = getTimeScaleIndex(wantedUnit);
         int roundToIndex = getTimeScaleIndex(roundTo);
@@ -57,7 +34,7 @@ public static long getRemainingDifference(int wantedUnit, int roundTo, long time
         }
         return (time % DIVIDERS[roundToIndex]) / DIVIDERS[wantedIndex];
     }
-    /***********************************************************************/
+
     /**
      * @return the index in TIME_SCALE[] of the largest Unit to be > 0
      */
@@ -68,10 +45,11 @@ private int getMaximumTimeUnit() {
         }
         return i;
     }
-    /***********************************************************************/
+
     /**
      * Finds the index for a Calendar.DATE ect.
      *
+     * @param calendarTime the time scale to find
      * @return the index in TIME_SCALE[]
      */
     public static int getTimeScaleIndex(int calendarTime) {
@@ -82,9 +60,6 @@ public static int getTimeScaleIndex(int calendarTime) {
         return i;
     }
 
-    /**
-     * *******************************************************************
-     */
     private static long getStandardRoundedTime(int unitIndex, boolean forceAbsolute, long time) {
         if (unitIndex == 0 || forceAbsolute) {
             return getAbsoluteDifference(TIME_SCALE[unitIndex], time);
@@ -93,9 +68,6 @@ private static long getStandardRoundedTime(int unitIndex, boolean forceAbsolute,
         }
     }
 
-    /**
-     * *******************************************************************
-     */
     public String getTimeText(int amount, int maxUnit, int minUnit, String nowText, String agoText, String units[]) {
         if (amount == 0) {
             throw new Error("getTimeText() requires amount > 0");
@@ -122,13 +94,4 @@ public String getTimeText(int amount, int maxUnit, int minUnit, String nowText,
         }
         return timeText;
     }
-
-    /**
-     * *******************************************************************
-     */
-    public String getStandardTimeText(int amountShown) {
-        return getTimeText(amountShown, Calendar.YEAR, Calendar.MILLISECOND, "now", "", STANDARD_TIME_TEXT);
-    }
-    /************************************************************************/
-    /************************************************************************/
 }

src/main/java/org/teachingextensions/approvals/lite/util/DateUtils.java

@@ -1,15 +1,9 @@
 package org.teachingextensions.approvals.lite.util;
 
-import java.sql.Timestamp;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
 import java.util.Calendar;
 import java.util.Date;
 import java.util.GregorianCalendar;
 
-/**
- * A static class of convenience functions for database access
- */
 public class DateUtils {
     private static int TIME_SCALE[] = {Calendar.YEAR,
             Calendar.MONTH,
@@ -20,29 +14,6 @@ public class DateUtils {
             Calendar.SECOND,
             Calendar.MILLISECOND};
 
-    public static boolean isSame(Date firstDate, Date secondDate, int smallestUnits) {
-        if ((firstDate == null) || (secondDate == null)) {
-            return (firstDate == secondDate);
-        }
-        return isSame(firstDate.getTime(), secondDate.getTime(), smallestUnits);
-    }
-
-    public static boolean isSame(long firstDate, long secondDate, int smallestUnits) {
-        if (!ArrayUtils.contains(TIME_SCALE, smallestUnits)) {
-            throw new Error("Invalid Timescale " + smallestUnits);
-        }
-        GregorianCalendar first = new GregorianCalendar();
-        first.setTime(new Date(firstDate));
-        setSignificantDigit(first, smallestUnits);
-        GregorianCalendar second = new GregorianCalendar();
-        second.setTime(new Date(secondDate));
-        setSignificantDigit(second, smallestUnits);
-        return (first.getTime().getTime() == second.getTime().getTime());
-    }
-
-    /**
-     * ********************************************************************
-     */
     public static Calendar setSignificantDigit(Calendar calendar, int smallestUnits) {
         boolean removeOn = false;
         for (int i : TIME_SCALE) {
@@ -74,9 +45,6 @@ public static void main(String args[]) {
         MySystem.variable("End Of Day", rollToEndOfDay(new Date()).getTime());
     }
 
-    /**
-     * ********************************************************************
-     */
     public static GregorianCalendar rollToEndOfDay(Date date) {
         GregorianCalendar gregorianCalendar = new GregorianCalendar();
         gregorianCalendar.setTime(date);
@@ -87,40 +55,4 @@ public static GregorianCalendar rollToEndOfDay(Date date) {
         return gregorianCalendar;
     }
 
-    /**
-     * *******************************************************************
-     */
-    public static Timestamp asTimestamp(Date date) {
-        return new Timestamp(date.getTime());
-    }
-
-    /**
-     * ********************************************************************
-     */
-    public static boolean isToday(Date date) {
-        return DateUtils.isSame(date, new Date(), Calendar.DATE);
-    }
-
-    /**
-     * ********************************************************************
-     */
-    public static Calendar asCalendar(Date date) {
-        GregorianCalendar gregorianCalendar = new GregorianCalendar();
-        gregorianCalendar.setTime(date);
-        return gregorianCalendar;
-    }
-
-    /************************************************************************/
-    /**
-     * @param date "yyyy/MM/dd"
-     */
-    public static Timestamp parse(String date) {
-        SimpleDateFormat format = new java.text.SimpleDateFormat("yyyy/MM/dd");
-        try {
-            return asTimestamp(format.parse(date));
-        } catch (ParseException e) {
-            throw ObjectUtils.throwAsError(e);
-        }
-    }
-    /************************************************************************/
 }

src/main/java/org/teachingextensions/approvals/lite/util/DualOutputStream.java

@@ -1,12 +1,8 @@
 package org.teachingextensions.approvals.lite.util;
 
-/**
- * Listens to the state of a EnabledConditions object
- */
-
-
 public interface Filter<T> {
     /**
+     * @param object the item to check
      * @return true if the object would be extracted by the filter
      * @throws IllegalArgumentException if the object is not supported by the filter
      */

src/main/java/org/teachingextensions/approvals/lite/util/Filter.java

@@ -11,6 +11,7 @@ public class FilterUtils {
      * @param fromObjects a collection of objects to filter
      * @param filter an optional parameter which indicates whether the item is extracted
      * @return a new List containing all elements of the list for which isExtracted() would return true
+     * @param <T> the kind of items to filter
      */
     public static <T> ArrayList<T> retainExtracted(T fromObjects[], Filter filter) throws IllegalArgumentException {
         return fromObjects == null ? new ArrayList<T>() : filter(Arrays.asList(fromObjects), filter, true);