From 4fb9972e4379bdc9738e72f547fec8ad503051be Mon Sep 17 00:00:00 2001
From: Tobrun
Date: Tue, 30 Jan 2018 15:35:23 +0100
Subject: [android] - update javadoc with links to style specification
---
.../mapboxsdk/style/expressions/Expression.java | 139 ++++++++++++++++++++-
1 file changed, 138 insertions(+), 1 deletion(-)
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/expressions/Expression.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/expressions/Expression.java
index 7b841a2580..0f76f590c2 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/expressions/Expression.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/expressions/Expression.java
@@ -246,7 +246,7 @@ public class Expression {
}
/**
- * Create a literal object expression
+ * Create a literal object expression.
*
* @param object the object
* @return the expression
@@ -280,6 +280,7 @@ public class Expression {
* @param green green color expression
* @param blue blue color expression
* @return expression
+ * @see Style specification
*/
public static Expression rgb(@NonNull Expression red, @NonNull Expression green,
@NonNull Expression blue) {
@@ -297,6 +298,7 @@ public class Expression {
* @param green green color value
* @param blue blue color value
* @return expression
+ * @see Style specification
*/
public static Expression rgb(@NonNull Number red, @NonNull Number green, @NonNull Number blue) {
return rgb(literal(red), literal(green), literal(blue));
@@ -314,6 +316,7 @@ public class Expression {
* @param blue blue color value
* @param alpha alpha color value
* @return expression
+ * @see Style specification
*/
public static Expression rgba(@NonNull Expression red, @NonNull Expression green,
@NonNull Expression blue, @NonNull Expression alpha) {
@@ -332,6 +335,7 @@ public class Expression {
* @param blue blue color value
* @param alpha alpha color value
* @return expression
+ * @see Style specification
*/
public static Expression rgba(@NonNull Number red, @NonNull Number green, @NonNull Number blue, @NonNull Number alpha) {
return rgba(literal(red), literal(green), literal(blue), literal(alpha));
@@ -342,6 +346,7 @@ public class Expression {
*
* @param expression an expression to convert to a color
* @return expression
+ * @see Style specification
*/
public static Expression toRgba(@NonNull Expression expression) {
return new Expression<>("to-rgba", expression);
@@ -358,6 +363,7 @@ public class Expression {
* @param compareOne the first expression
* @param compareTwo the second expression
* @return expression
+ * @see Style specification
*/
public static Expression eq(@NonNull Expression compareOne, @NonNull Expression compareTwo) {
return new Expression<>("==", compareOne, compareTwo);
@@ -369,6 +375,7 @@ public class Expression {
* @param compareOne the first boolean
* @param compareTwo the second boolean
* @return expression
+ * @see Style specification
*/
public static Expression eq(boolean compareOne, boolean compareTwo) {
return eq(literal(compareOne), literal(compareTwo));
@@ -380,6 +387,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression eq(@NonNull String compareOne, @NonNull String compareTwo) {
return eq(literal(compareOne), literal(compareTwo));
@@ -391,6 +399,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression eq(@NonNull Number compareOne, @NonNull Number compareTwo) {
return eq(literal(compareOne), literal(compareTwo));
@@ -403,6 +412,7 @@ public class Expression {
* @param compareOne the first expression
* @param compareTwo the second expression
* @return expression
+ * @see Style specification
*/
public static Expression neq(@NonNull Expression compareOne, @NonNull Expression compareTwo) {
return new Expression<>("!=", compareOne, compareTwo);
@@ -414,6 +424,7 @@ public class Expression {
* @param compareOne the first boolean
* @param compareTwo the second boolean
* @return expression
+ * @see Style specification
*/
public static Expression neq(boolean compareOne, boolean compareTwo) {
return new Expression<>("!=", literal(compareOne), literal(compareTwo));
@@ -425,6 +436,7 @@ public class Expression {
* @param compareOne the first string
* @param compareTwo the second string
* @return expression
+ * @see Style specification
*/
public static Expression neq(@NonNull String compareOne, @NonNull String compareTwo) {
return new Expression<>("!=", literal(compareOne), literal(compareTwo));
@@ -436,6 +448,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression neq(@NonNull Number compareOne, @NonNull Number compareTwo) {
return new Expression<>("!=", literal(compareOne), literal(compareTwo));
@@ -448,6 +461,7 @@ public class Expression {
* @param compareOne the first expression
* @param compareTwo the second expression
* @return expression
+ * @see Style specification
*/
public static Expression gt(@NonNull Expression compareOne, @NonNull Expression compareTwo) {
return new Expression<>(">", compareOne, compareTwo);
@@ -459,6 +473,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression gt(@NonNull Number compareOne, @NonNull Number compareTwo) {
return new Expression<>(">", literal(compareOne), literal(compareTwo));
@@ -470,6 +485,7 @@ public class Expression {
* @param compareOne the first string
* @param compareTwo the second string
* @return expression
+ * @see Style specification
*/
public static Expression gt(@NonNull String compareOne, @NonNull String compareTwo) {
return new Expression<>(">", literal(compareOne), literal(compareTwo));
@@ -482,6 +498,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression lt(@NonNull Expression compareOne, @NonNull Expression compareTwo) {
return new Expression<>("<", compareOne, compareTwo);
@@ -493,6 +510,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression lt(@NonNull Number compareOne, @NonNull Number compareTwo) {
return new Expression<>("<", literal(compareOne), literal(compareTwo));
@@ -504,6 +522,7 @@ public class Expression {
* @param compareOne the first string
* @param compareTwo the second string
* @return expression
+ * @see Style specification
*/
public static Expression lt(@NonNull String compareOne, @NonNull String compareTwo) {
return new Expression<>("<", literal(compareOne), literal(compareTwo));
@@ -516,6 +535,7 @@ public class Expression {
* @param compareOne the first expression
* @param compareTwo the second expression
* @return expression
+ * @see Style specification
*/
public static Expression gte(@NonNull Expression compareOne, @NonNull Expression compareTwo) {
return new Expression<>(">=", compareOne, compareTwo);
@@ -527,6 +547,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression gte(@NonNull Number compareOne, @NonNull Number compareTwo) {
return new Expression<>(">=", literal(compareOne), literal(compareTwo));
@@ -538,6 +559,7 @@ public class Expression {
* @param compareOne the first string
* @param compareTwo the second string
* @return expression
+ * @see Style specification
*/
public static Expression gte(@NonNull String compareOne, @NonNull String compareTwo) {
return new Expression<>(">=", literal(compareOne), literal(compareTwo));
@@ -550,6 +572,7 @@ public class Expression {
* @param compareOne the first expression
* @param compareTwo the second expression
* @return expression
+ * @see Style specification
*/
public static Expression lte(@NonNull Expression compareOne, @NonNull Expression compareTwo) {
return new Expression<>("<=", compareOne, compareTwo);
@@ -561,6 +584,7 @@ public class Expression {
* @param compareOne the first number
* @param compareTwo the second number
* @return expression
+ * @see Style specification
*/
public static Expression lte(@NonNull Number compareOne, @NonNull Number compareTwo) {
return new Expression<>("<=", literal(compareOne), literal(compareTwo));
@@ -572,6 +596,7 @@ public class Expression {
* @param compareOne the first string
* @param compareTwo the second string
* @return expression
+ * @see Style specification
*/
public static Expression lte(@NonNull String compareOne, @NonNull String compareTwo) {
return new Expression<>("<=", literal(compareOne), literal(compareTwo));
@@ -587,6 +612,7 @@ public class Expression {
*
* @param input expression input
* @return expression
+ * @see Style specification
*/
@SafeVarargs
public static Expression all(@NonNull Expression... input) {
@@ -603,6 +629,7 @@ public class Expression {
*
* @param input expression input
* @return expression
+ * @see Style specification
*/
@SafeVarargs
public static Expression any(@NonNull Expression... input) {
@@ -614,6 +641,7 @@ public class Expression {
*
* @param input expression input
* @return expression
+ * @see Style specification
*/
public static Expression not(@NonNull Expression input) {
return new Expression<>("!", input);
@@ -624,6 +652,7 @@ public class Expression {
*
* @param input boolean input
* @return expression
+ * @see Style specification
*/
public static Expression not(boolean input) {
return not(literal(input));
@@ -631,9 +660,14 @@ public class Expression {
/**
* Selects the first output whose corresponding test condition evaluates to true.
+ *
+ * For each case a condition and an output should be provided.
+ * The last parameter should provide the default output.
+ *
*
* @param input expression input
* @return expression
+ * @see Style specification
*/
@SafeVarargs
public static Expression switchCase(@NonNull @Size(min = 1) Expression... input) {
@@ -647,6 +681,7 @@ public class Expression {
*
* @param input expression input
* @return expression
+ * @see Style specification
*/
public static Expression match(@NonNull @Size(min = 2) Expression... input) {
return new Expression("match", input);
@@ -659,6 +694,7 @@ public class Expression {
*
* @param input expression input
* @return expression
+ * @see Style specification
*/
public static Expression match(@NonNull Expression input, @NonNull Stop... stops) {
Expression[] expressions = new Expression[stops.length * 2];
@@ -674,6 +710,7 @@ public class Expression {
*
* @param input expression input
* @return expression
+ * @see Style specification
*/
public static Expression coalesce(@NonNull Expression... input) {
return new Expression("coalesce", input);
@@ -690,6 +727,7 @@ public class Expression {
*