summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnitsGUI/PrefixSearchRule.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/sevenUnitsGUI/PrefixSearchRule.java')
-rw-r--r--src/main/java/sevenUnitsGUI/PrefixSearchRule.java12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/main/java/sevenUnitsGUI/PrefixSearchRule.java b/src/main/java/sevenUnitsGUI/PrefixSearchRule.java
index 2928082..87f14a8 100644
--- a/src/main/java/sevenUnitsGUI/PrefixSearchRule.java
+++ b/src/main/java/sevenUnitsGUI/PrefixSearchRule.java
@@ -33,24 +33,31 @@ import sevenUnits.unit.UnitPrefix;
* A search rule that applies a certain set of prefixes to a unit. It always
* includes the original unit in the output map.
*
+ * @since v0.4.0
* @since 2022-07-06
*/
public final class PrefixSearchRule implements
Function<Map.Entry<String, LinearUnit>, Map<String, LinearUnit>> {
/**
* A rule that does not add any prefixed versions of units.
+ *
+ * @since v0.4.0
*/
public static final PrefixSearchRule NO_PREFIXES = getUniversalRule(
Set.of());
/**
* A rule that gives every unit a common set of prefixes.
+ *
+ * @since v0.4.0
*/
public static final PrefixSearchRule COMMON_PREFIXES = getCoherentOnlyRule(
Set.of(Metric.MILLI, Metric.KILO));
/**
* A rule that gives every unit all metric prefixes.
+ *
+ * @since v0.4.0
*/
public static final PrefixSearchRule ALL_METRIC_PREFIXES = getCoherentOnlyRule(
Metric.ALL_PREFIXES);
@@ -62,6 +69,7 @@ public final class PrefixSearchRule implements
*
* @param prefixes prefixes to apply
* @return prefix rule
+ * @since v0.4.0
* @since 2022-07-06
*/
public static final PrefixSearchRule getCoherentOnlyRule(
@@ -75,6 +83,7 @@ public final class PrefixSearchRule implements
*
* @param prefixes prefixes to apply
* @return prefix rule
+ * @since v0.4.0
* @since 2022-07-06
*/
public static final PrefixSearchRule getUniversalRule(
@@ -95,6 +104,7 @@ public final class PrefixSearchRule implements
/**
* @param prefixes
* @param metricOnly
+ * @since v0.4.0
* @since 2022-07-06
*/
public PrefixSearchRule(Set<UnitPrefix> prefixes,
@@ -140,6 +150,7 @@ public final class PrefixSearchRule implements
/**
* @return the allowUnit
+ * @since v0.4.0
* @since 2022-07-06
*/
public Predicate<LinearUnit> getAllowUnit() {
@@ -148,6 +159,7 @@ public final class PrefixSearchRule implements
/**
* @return the prefixes that are applied by this rule
+ * @since v0.4.0
* @since 2022-07-06
*/
public Set<UnitPrefix> getPrefixes() {