Skip to content

Commit

Permalink
javadoc warnings
Browse files Browse the repository at this point in the history 
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
  • Loading branch information
@jodygarnett
jodygarnett committed Feb 1, 2020
1 parent bd649fb commit b7b6eaa
Show file tree
Hide file tree
Showing 15 changed files with 80 additions and 80 deletions.
6 changes: 3 additions & 3 deletions modules/unsupported/mbstyle/src/main/java/org/geotools/mbstyle/expression/MBColor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public MBColor(JSONArray json) {
* 255, and an alpha component of 1. If any component is out of range, the expression is an
* error. Example: ["rgb", number, number, number]: color
*
* @return
* @return Color expression
*/
public Expression colorRGB() {
if (json.size() == 4) {
Expand Down Expand Up @@ -62,7 +62,7 @@ public Expression colorRGB() {
* and an alpha component which must range between 0 and 1. If any component is out of range,
* the expression is an error. Example: ["rgba", number, number, number, number]: color
*
* @return
* @return Color expression
*/
// Currently unsupported
public Expression colorRGBA() {
Expand All @@ -73,7 +73,7 @@ public Expression colorRGBA() {
* Returns a four-element array containing the input color's red, green, blue, and alpha
* components, in that order. Example: ["to-rgba", color]: array&lt;number, 4&gt;
*
* @return
* @return color expression
*/
// Currently unsupported
public Expression colorToRGBA() {
Expand Down
24 changes: 12 additions & 12 deletions modules/unsupported/mbstyle/src/main/java/org/geotools/mbstyle/expression/MBDecision.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public MBDecision(JSONArray json) {
* Logical negation. Returns true if the input is false, and false if the input is true.
* Example: ["!", boolean]: boolean
*
* @return
* @return not expression
*/
private Expression decisionNot() {
// validate the arg list
Expand All @@ -68,7 +68,7 @@ private Expression decisionNot() {
* strings, or booleans, and both of the same type. Examples:["!=", number, number]: boolean
* ["!=", string, string]: boolean ["!=", boolean, boolean]: boolean ["!=", null, null]: boolean
*
* @return
* @return Not equals expression
*/
private Expression decisionNotEqual() {
// validate the arg list
Expand All @@ -86,7 +86,7 @@ private Expression decisionNotEqual() {
* must be numbers or strings, and both of the same type. Examples: ["<", number, number]:
* boolean ["<", string, string]: boolean
*
* @return
* @return Less than expression
*/
private Expression decisionLessThan() {
// validate the arg list
Expand All @@ -103,7 +103,7 @@ private Expression decisionLessThan() {
* inputs must be numbers or strings, and both of the same type. Examples: ["<=", number,
* number]: boolean ["<=", string, string]: boolean
*
* @return
* @return less than or equals to expression
*/
private Expression decisionLessEqualThan() {
// validate the arg list
Expand All @@ -120,7 +120,7 @@ private Expression decisionLessEqualThan() {
* strings, or booleans, and both of the same type. Examples: ["==", number, number]: boolean
* ["==", string, string]: boolean ["==", boolean, boolean]: boolean ["==", null, null]: boolean
*
* @return
* @return equal to expression
*/
private Expression decisionEqualTo() {
// validate the arg list
Expand All @@ -138,7 +138,7 @@ private Expression decisionEqualTo() {
* inputs must be numbers or strings, and both of the same type. Example: [">", number, number]:
* boolean [">", string, string]: boolean
*
* @return
* @return greater than expression
*/
private Expression decisionGreaterThan() {
// validate the arg list
Expand All @@ -155,7 +155,7 @@ private Expression decisionGreaterThan() {
* inputs must be numbers or strings, and both of the same type. Example: [">=", number,
* number]: boolean [">=", string, string]: boolean
*
* @return
* @return greater than or equal to expression
*/
private Expression decisionGreaterEqualThan() {
// validate the arg list
Expand All @@ -173,7 +173,7 @@ private Expression decisionGreaterEqualThan() {
* is false and no further input expressions are evaluated. Example: [""all"", boolean,
* boolean]: boolean [""all"", boolean, boolean, ...]: boolean
*
* @return
* @return all expression
*/
private Expression decisionAll() {
// validate the arg list
Expand All @@ -194,7 +194,7 @@ private Expression decisionAll() {
* result is true and no further input expressions are evaluated. Example: [""any"", boolean,
* boolean]: boolean [""any"", boolean, boolean, ...]: boolean
*
* @return
* @return any expression
*/
private Expression decisionAny() {
// validate the arg list
Expand All @@ -214,7 +214,7 @@ private Expression decisionAny() {
* [""case"", condition: boolean, output: OutputType, ...condition: boolean, output: OutputType,
* ...default: OutputType]: OutputType
*
* @return
* @return case expression
*/
private Expression decisionCase() {
// validate the arg list
Expand All @@ -233,7 +233,7 @@ private Expression decisionCase() {
* Evaluates each expression in turn until the first non-null value is obtained, and returns
* that value. Example: ["coalesce", OutputType, OutputType, ...]: OutputType
*
* @return
* @return coalesce expresson
*/
private Expression decisionCoalesce() {
// validate the arg list
Expand All @@ -256,7 +256,7 @@ private Expression decisionCoalesce() {
* InputType, ...], output_1: OutputType, label_n: InputType | [InputType, InputType, ...],
* output_n: OutputType, ..., default: OutputType]: OutputType
*
* @return
* @return match expression
*/
private Expression decisionMatch() {
// validate the arg list
Expand Down
2 changes: 1 addition & 1 deletion modules/unsupported/mbstyle/src/main/java/org/geotools/mbstyle/expression/MBExpression.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ public static boolean canCreate(final String name) {
* transform Mapbox tokens into CQL expressions.
*
* @param ex
* @return
* @return cq; text expression
*/
public Expression transformLiteral(Expression ex) {
String text = ex.evaluate(null, String.class);
Expand Down
6 changes: 3 additions & 3 deletions modules/unsupported/mbstyle/src/main/java/org/geotools/mbstyle/expression/MBFeatureData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public MBFeatureData(JSONArray json) {
* Gets the feature's geometry type: Point, MultiPoint, LineString, MultiLineString, Polygon,
* MultiPolygon.Example: ["geometry-type"]: string
*
* @return
* @return geometry type expression
*/
public Expression featureGeometryType() {
return ff.function("geometryType", ff.function("geometry", ff.literal(true)));
Expand All @@ -44,7 +44,7 @@ public Expression featureGeometryType() {
/**
* Gets the feature's id, if it has one. Example: ["id"]: value
*
* @return
* @return feature id expression
*/
public Expression featureId() {
return ff.function("id");
Expand All @@ -54,7 +54,7 @@ public Expression featureId() {
* Gets the feature properties object. Note that in some cases, it may be more efficient to use
* ["get", "property_name"] directly. Example: ["properties"]: object
*
* @return
* @return expression of feature attributes
*/
public Expression featureProperties() {
// not supported
Expand Down
4 changes: 2 additions & 2 deletions modules/unsupported/mbstyle/src/main/java/org/geotools/mbstyle/expression/MBHeatmap.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ public MBHeatmap(JSONArray json) {
* of how many data points are crowded around a particular pixel. Can only be used in the
* heatmap-color property. Example: ["heatmap-density"]: number
*
* @return
* @return heat map density expression
*/
public Expression heatmapDensity() {
return null;
return null; // throw new UnsupportedOperationException( ... )
}

@Override
Expand Down
8 changes: 4 additions & 4 deletions modules/unsupported/mbstyle/src/main/java/org/geotools/mbstyle/expression/MBLookup.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public MBLookup(JSONArray json) {
/**
* Retrieves an item from an array. Example: ["at", number, array]: ItemType
*
* @return
* @return lookup array element expression
*/
public Expression lookupAt() {
// requires an instance of a "literal" array expression ie. non-expression array
Expand All @@ -51,7 +51,7 @@ public Expression lookupAt() {
*
* <p>As a note, the mbstyle requires json objects for lookup, and evaluates the object as such.
*
* @return
* @return lookup map property by bame expression
*/
public Expression lookupGet() {
if (json.size() == 2 || json.size() == 3) {
Expand All @@ -75,7 +75,7 @@ public Expression lookupGet() {
*
* <p>As a note, the mbstyle requires json objects for lookup, and evaluates the object as such.
*
* @return
* @return check of properties contains key expression
*/
public Expression lookupHas() {
if (json.size() == 2 || json.size() == 3) {
Expand All @@ -97,7 +97,7 @@ public Expression lookupHas() {
* Gets the length of an array or string. Example: ["length", string]: number ["length", array]:
* number
*
* @return
* @return length of array expression
*/
public Expression lookupLength() {
Expression e = parse.string(json, 1);
Expand Down
Loading

0 comments on commit b7b6eaa

Please sign in to comment.