Added @since tags to all classes and methods from v0.2.0

5 files changed, 61 insertions, 0 deletions

diff --git a/src/org/unitConverter/converterGUI/FilterComparator.java b/src/org/unitConverter/converterGUI/FilterComparator.java
index 2d0e7f9..7b17bfc 100755
--- a/src/org/unitConverter/converterGUI/FilterComparator.java
+++ b/src/org/unitConverter/converterGUI/FilterComparator.java
@@ -45,6 +45,7 @@ final class FilterComparator implements Comparator<String> {
 	 * Whether or not the comparison is case-sensitive.

 	 * 

 	 * @since 2019-04-14

+	 * @since v0.2.0

 	 */

 	private final boolean caseSensitive;

 

@@ -87,6 +88,7 @@ final class FilterComparator implements Comparator<String> {
 	 * @throws NullPointerException

 	 *             if filter is null

 	 * @since 2019-04-14

+	 * @since v0.2.0

 	 */

 	public FilterComparator(final String filter, final Comparator<String> comparator, final boolean caseSensitive) {

 		this.filter = Objects.requireNonNull(filter, "filter must not be null.");

diff --git a/src/org/unitConverter/converterGUI/MutablePredicate.java b/src/org/unitConverter/converterGUI/MutablePredicate.java
index 157903c..e15b3cd 100644
--- a/src/org/unitConverter/converterGUI/MutablePredicate.java
+++ b/src/org/unitConverter/converterGUI/MutablePredicate.java
@@ -23,14 +23,22 @@ import java.util.function.Predicate;
  * 
  * @author Adrien Hopkins
  * @since 2019-04-13
+ * @since v0.2.0
  */
 final class MutablePredicate<T> implements Predicate<T> {
+	/**
+	 * The predicate stored in this {@code MutablePredicate}
+	 * 
+	 * @since 2019-04-13
+	 * @since v0.2.0
+	 */
 	private Predicate<T> predicate;
 
 	/**
 	 * Creates the {@code MutablePredicate}.
 	 * 
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public MutablePredicate(final Predicate<T> predicate) {
 		this.predicate = predicate;
@@ -39,6 +47,7 @@ final class MutablePredicate<T> implements Predicate<T> {
 	/**
 	 * @return predicate
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public final Predicate<T> getPredicate() {
 		return this.predicate;
@@ -48,6 +57,7 @@ final class MutablePredicate<T> implements Predicate<T> {
 	 * @param predicate
 	 *            new value of predicate
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public final void setPredicate(final Predicate<T> predicate) {
 		this.predicate = predicate;
diff --git a/src/org/unitConverter/converterGUI/SearchBoxList.java b/src/org/unitConverter/converterGUI/SearchBoxList.java
index 35cc347..1995466 100644
--- a/src/org/unitConverter/converterGUI/SearchBoxList.java
+++ b/src/org/unitConverter/converterGUI/SearchBoxList.java
@@ -33,20 +33,29 @@ import javax.swing.JTextField;
 /**
  * @author Adrien Hopkins
  * @since 2019-04-13
+ * @since v0.2.0
  */
 final class SearchBoxList extends JPanel {
 
 	/**
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	private static final long serialVersionUID = 6226930279415983433L;
 
 	/**
 	 * The text to place in an empty search box.
+	 * 
+	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	private static final String EMPTY_TEXT = "Search...";
+
 	/**
 	 * The color to use for an empty foreground.
+	 * 
+	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	private static final Color EMPTY_FOREGROUND = new Color(192, 192, 192);
 
@@ -66,6 +75,13 @@ final class SearchBoxList extends JPanel {
 	private final Comparator<String> defaultOrdering;
 	private final boolean caseSensitive;
 
+	/**
+	 * Creates the {@code SearchBoxList}.
+	 * 
+	 * @param itemsToFilter
+	 *            items to put in the list
+	 * @since 2019-04-14
+	 */
 	public SearchBoxList(final Collection<String> itemsToFilter) {
 		this(itemsToFilter, null, false);
 	}
@@ -73,7 +89,15 @@ final class SearchBoxList extends JPanel {
 	/**
 	 * Creates the {@code SearchBoxList}.
 	 * 
+	 * @param itemsToFilter
+	 *            items to put in the list
+	 * @param defaultOrdering
+	 *            default ordering of items after filtration (null=Comparable)
+	 * @param caseSensitive
+	 *            whether or not the filtration is case-sensitive
+	 * 
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public SearchBoxList(final Collection<String> itemsToFilter, final Comparator<String> defaultOrdering,
 			final boolean caseSensitive) {
@@ -116,6 +140,7 @@ final class SearchBoxList extends JPanel {
 	 * @param filter
 	 *            filter to add.
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public void addSearchFilter(final Predicate<String> filter) {
 		this.customSearchFilter = this.customSearchFilter.and(filter);
@@ -125,6 +150,7 @@ final class SearchBoxList extends JPanel {
 	 * Resets the search filter.
 	 * 
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public void clearSearchFilters() {
 		this.customSearchFilter = o -> true;
@@ -133,6 +159,7 @@ final class SearchBoxList extends JPanel {
 	/**
 	 * @return this component's search box component
 	 * @since 2019-04-14
+	 * @since v0.2.0
 	 */
 	public final JTextField getSearchBox() {
 		return this.searchBox;
@@ -143,6 +170,7 @@ final class SearchBoxList extends JPanel {
 	 *            text to search for
 	 * @return a filter that filters out that text, based on this list's case sensitive setting
 	 * @since 2019-04-14
+	 * @since v0.2.0
 	 */
 	private Predicate<String> getSearchFilter(final String searchText) {
 		if (this.caseSensitive)
@@ -154,6 +182,7 @@ final class SearchBoxList extends JPanel {
 	/**
 	 * @return this component's list component
 	 * @since 2019-04-14
+	 * @since v0.2.0
 	 */
 	public final JList<String> getSearchList() {
 		return this.searchItems;
@@ -162,6 +191,7 @@ final class SearchBoxList extends JPanel {
 	/**
 	 * @return index selected in item list
 	 * @since 2019-04-14
+	 * @since v0.2.0
 	 */
 	public int getSelectedIndex() {
 		return this.searchItems.getSelectedIndex();
@@ -170,6 +200,7 @@ final class SearchBoxList extends JPanel {
 	/**
 	 * @return value selected in item list
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public String getSelectedValue() {
 		return this.searchItems.getSelectedValue();
@@ -179,6 +210,7 @@ final class SearchBoxList extends JPanel {
 	 * Re-applies the filters.
 	 * 
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	public void reapplyFilter() {
 		final String searchText = this.searchBoxEmpty ? "" : this.searchBox.getText();
@@ -205,6 +237,7 @@ final class SearchBoxList extends JPanel {
 	 * @param e
 	 *            focus event
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	private void searchBoxFocusGained(final FocusEvent e) {
 		this.searchBoxFocused = true;
@@ -220,6 +253,7 @@ final class SearchBoxList extends JPanel {
 	 * @param e
 	 *            focus event
 	 * @since 2019-04-13
+	 * @since v0.2.0
 	 */
 	private void searchBoxFocusLost(final FocusEvent e) {
 		this.searchBoxFocused = false;
@@ -236,6 +270,7 @@ final class SearchBoxList extends JPanel {
 	 * </p>
 	 * 
 	 * @since 2019-04-14
+	 * @since v0.2.0
 	 */
 	private void searchBoxTextChanged() {
 		if (this.searchBoxFocused) {
diff --git a/src/org/unitConverter/converterGUI/UnitConverterGUI.java b/src/org/unitConverter/converterGUI/UnitConverterGUI.java
index 1f59e3a..e258c6f 100755
--- a/src/org/unitConverter/converterGUI/UnitConverterGUI.java
+++ b/src/org/unitConverter/converterGUI/UnitConverterGUI.java
@@ -64,6 +64,7 @@ final class UnitConverterGUI {
 		 * @param database
 		 *            database to add to
 		 * @since 2019-04-14
+		 * @since v0.2.0
 		 */
 		private static void addDefaults(final UnitsDatabase database) {
 			database.addUnit("metre", SI.METRE);
@@ -167,6 +168,7 @@ final class UnitConverterGUI {
 		 * Converts in the dimension-based converter
 		 * 
 		 * @since 2019-04-13
+		 * @since v0.2.0
 		 */
 		public final void convertDimensionBased() {
 			final String fromSelection = this.view.getFromSelection();
@@ -264,6 +266,7 @@ final class UnitConverterGUI {
 		/**
 		 * @return a list of all of the unit dimensions
 		 * @since 2019-04-13
+		 * @since v0.2.0
 		 */
 		public final List<String> dimensionNameList() {
 			return this.dimensionNames;
@@ -272,6 +275,7 @@ final class UnitConverterGUI {
 		/**
 		 * @return a comparator to compare prefix names
 		 * @since 2019-04-14
+		 * @since v0.2.0
 		 */
 		public final Comparator<String> getPrefixNameComparator() {
 			return this.prefixNameComparator;
@@ -282,6 +286,7 @@ final class UnitConverterGUI {
 		 *            value to round
 		 * @return string of that value rounded to {@code significantDigits} significant digits.
 		 * @since 2019-04-14
+		 * @since v0.2.0
 		 */
 		private final String getRoundedString(final double value) {
 			// round value
@@ -304,6 +309,7 @@ final class UnitConverterGUI {
 		/**
 		 * @return a set of all prefix names in the database
 		 * @since 2019-04-14
+		 * @since v0.2.0
 		 */
 		public final Set<String> prefixNameSet() {
 			return this.database.prefixMap().keySet();
@@ -333,6 +339,7 @@ final class UnitConverterGUI {
 		 * @param significantFigures
 		 *            new value of significantFigures
 		 * @since 2019-01-15
+		 * @since v0.1.0
 		 */
 		public final void setSignificantFigures(final int significantFigures) {
 			this.significantFigures = significantFigures;
@@ -348,6 +355,7 @@ final class UnitConverterGUI {
 		 *            name of dimension to test
 		 * @return whether unit has dimenision
 		 * @since 2019-04-13
+		 * @since v0.2.0
 		 */
 		public final boolean unitMatchesDimension(final String unitName, final String dimensionName) {
 			final Unit unit = this.database.getUnit(unitName);
@@ -378,6 +386,7 @@ final class UnitConverterGUI {
 		/**
 		 * @return a set of all of the unit names
 		 * @since 2019-04-14
+		 * @since v0.2.0
 		 */
 		public final Set<String> unitNameSet() {
 			return this.database.unitMapPrefixless().keySet();
@@ -452,6 +461,7 @@ final class UnitConverterGUI {
 		/**
 		 * @return value in dimension-based converter
 		 * @since 2019-04-13
+		 * @since v0.2.0
 		 */
 		public String getDimensionConverterInput() {
 			return this.valueInput.getText();
@@ -460,6 +470,7 @@ final class UnitConverterGUI {
 		/**
 		 * @return selection in "From" selector in dimension-based converter
 		 * @since 2019-04-13
+		 * @since v0.2.0
 		 */
 		public String getFromSelection() {
 			return this.fromSearch.getSelectedValue();
@@ -486,6 +497,7 @@ final class UnitConverterGUI {
 		/**
 		 * @return selection in "To" selector in dimension-based converter
 		 * @since 2019-04-13
+		 * @since v0.2.0
 		 */
 		public String getToSelection() {
 			return this.toSearch.getSelectedValue();
@@ -752,6 +764,7 @@ final class UnitConverterGUI {
 		 * @param text
 		 *            text to set
 		 * @since 2019-04-13
+		 * @since v0.2.0
 		 */
 		public void setDimensionConverterOutputText(final String text) {
 			this.dimensionBasedOutput.setText(text);
diff --git a/src/org/unitConverter/converterGUI/package-info.java b/src/org/unitConverter/converterGUI/package-info.java
index d899f97..1555291 100644
--- a/src/org/unitConverter/converterGUI/package-info.java
+++ b/src/org/unitConverter/converterGUI/package-info.java
@@ -19,5 +19,6 @@
  * 
  * @author Adrien Hopkins
  * @since 2019-01-25
+ * @since v0.2.0
  */
 package org.unitConverter.converterGUI;
\ No newline at end of file