summaryrefslogtreecommitdiff
path: root/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java
diff options
context:
space:
mode:
authorTobrun <tobrun.van.nuland@gmail.com>2016-08-09 10:54:56 -0400
committerTobrun <tobrun.van.nuland@gmail.com>2016-08-09 20:48:00 -0400
commit532c659b22c73eac04c7d643aff6ac5f1cc9f55a (patch)
tree10727eaaab5bd41188580a227c6300936c250ebf /platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java
parent78387e9167f1072265d6e06b4a4a423dfe405c4a (diff)
downloadqtlocation-mapboxgl-532c659b22c73eac04c7d643aff6ac5f1cc9f55a.tar.gz
[android] javadoc cleanup part 2
Diffstat (limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java')
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java96
1 files changed, 91 insertions, 5 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java
index 3bb25372cd..ee0236303a 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CircleLayer.java
@@ -13,47 +13,96 @@ import static com.mapbox.mapboxsdk.utils.ColorUtils.*;
*/
public class CircleLayer extends Layer {
+ /**
+ * Creates a CircleLayer.
+ *
+ * @param nativePtr pointer used by core
+ */
public CircleLayer(long nativePtr) {
super(nativePtr);
}
+ /**
+ * Creates a CircleLayer.
+ *
+ * @param layerId the id of the layer
+ * @param sourceId the id of the source
+ */
public CircleLayer(String layerId, String sourceId) {
initialize(layerId, sourceId);
}
protected native void initialize(String layerId, String sourceId);
+ /**
+ * Set the source layer.
+ *
+ * @param sourceLayer the source layer to set
+ */
public void setSourceLayer(String sourceLayer) {
checkValidity();
nativeSetSourceLayer(sourceLayer);
}
+ /**
+ * Set the source Layer.
+ *
+ * @param sourceLayer the source layer to set
+ * @return This
+ */
public CircleLayer withSourceLayer(String sourceLayer) {
setSourceLayer(sourceLayer);
return this;
}
-
+ /**
+ * Set a single filter.
+ *
+ * @param filter the filter to set
+ */
public void setFilter(Filter.Statement filter) {
checkValidity();
this.setFilter(filter.toArray());
}
+ /**
+ * Set an array of filters.
+ *
+ * @param filter the filter array to set
+ */
public void setFilter(Object[] filter) {
checkValidity();
nativeSetFilter(filter);
}
+ /**
+ * Set an array of filters.
+ *
+ * @param filter tthe filter array to set
+ * @return This
+ */
public CircleLayer withFilter(Object[] filter) {
setFilter(filter);
return this;
}
+ /**
+ * Set a single filter.
+ *
+ * @param filter the filter to set
+ * @return This
+ */
public CircleLayer withFilter(Filter.Statement filter) {
setFilter(filter);
return this;
}
+ /**
+ * Set a property or properties.
+ *
+ * @param properties the var-args properties
+ * @return This
+ */
public CircleLayer withProperties(@NonNull Property<?>... properties) {
setProperties(properties);
return this;
@@ -61,21 +110,33 @@ public class CircleLayer extends Layer {
// Property getters
+ /**
+ * Get the CircleRadius property
+ *
+ * @return property wrapper value around Float
+ */
@SuppressWarnings("unchecked")
public PropertyValue<Float> getCircleRadius() {
checkValidity();
return (PropertyValue<Float>) new PropertyValue(nativeGetCircleRadius());
}
+ /**
+ * Get the CircleColor property
+ *
+ * @return property wrapper value around String
+ */
@SuppressWarnings("unchecked")
public PropertyValue<String> getCircleColor() {
checkValidity();
return (PropertyValue<String>) new PropertyValue(nativeGetCircleColor());
}
- /**
- * The color of the circle.
- * @throws RuntimeException
- */
+ /**
+ * The color of the circle.
+ *
+ * @return int representation of a rgba string color
+ * @throws RuntimeException thrown if property isn't a value
+ */
@ColorInt
public int getCircleColorAsInt() {
checkValidity();
@@ -88,30 +149,55 @@ public class CircleLayer extends Layer {
}
+ /**
+ * Get the CircleBlur property
+ *
+ * @return property wrapper value around Float
+ */
@SuppressWarnings("unchecked")
public PropertyValue<Float> getCircleBlur() {
checkValidity();
return (PropertyValue<Float>) new PropertyValue(nativeGetCircleBlur());
}
+ /**
+ * Get the CircleOpacity property
+ *
+ * @return property wrapper value around Float
+ */
@SuppressWarnings("unchecked")
public PropertyValue<Float> getCircleOpacity() {
checkValidity();
return (PropertyValue<Float>) new PropertyValue(nativeGetCircleOpacity());
}
+ /**
+ * Get the CircleTranslate property
+ *
+ * @return property wrapper value around Float[]
+ */
@SuppressWarnings("unchecked")
public PropertyValue<Float[]> getCircleTranslate() {
checkValidity();
return (PropertyValue<Float[]>) new PropertyValue(nativeGetCircleTranslate());
}
+ /**
+ * Get the CircleTranslateAnchor property
+ *
+ * @return property wrapper value around String
+ */
@SuppressWarnings("unchecked")
public PropertyValue<String> getCircleTranslateAnchor() {
checkValidity();
return (PropertyValue<String>) new PropertyValue(nativeGetCircleTranslateAnchor());
}
+ /**
+ * Get the CirclePitchScale property
+ *
+ * @return property wrapper value around String
+ */
@SuppressWarnings("unchecked")
public PropertyValue<String> getCirclePitchScale() {
checkValidity();