diff options
author | Tobrun <tobrun.van.nuland@gmail.com> | 2016-08-08 21:51:52 -0400 |
---|---|---|
committer | Tobrun <tobrun.van.nuland@gmail.com> | 2016-08-08 21:51:52 -0400 |
commit | 63efa9bf7d7df678b6061eea722ead20f8328b02 (patch) | |
tree | c2b74c7bc261dde32c07ba1aab3d37e5ccfea69b /platform/android | |
parent | 82f19b94f7697d18adf6f9d0eb3b5b3d3b67e4a4 (diff) | |
download | qtlocation-mapboxgl-63efa9bf7d7df678b6061eea722ead20f8328b02.tar.gz |
[android] #5880 - javadoc cleanup part one
Diffstat (limited to 'platform/android')
15 files changed, 670 insertions, 48 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapboxAccountManager.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapboxAccountManager.java index 8f2597c60a..f8a83550f0 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapboxAccountManager.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/MapboxAccountManager.java @@ -60,7 +60,7 @@ public class MapboxAccountManager { } /** - * Access Token for this application + * Access Token for this application. * * @return Mapbox Access Token */ @@ -69,10 +69,10 @@ public class MapboxAccountManager { } /** - * Runtime validation of Access Token + * Runtime validation of Access Token. * * @param accessToken Access Token to check - * @throws InvalidAccessTokenException + * @throws InvalidAccessTokenException the exception thrown */ public static void validateAccessToken(String accessToken) throws InvalidAccessTokenException { if (TextUtils.isEmpty(accessToken) || (!accessToken.toLowerCase(MapboxConstants.MAPBOX_LOCALE).startsWith("pk.") && !accessToken.toLowerCase(MapboxConstants.MAPBOX_LOCALE).startsWith("sk."))) { diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java index 3c4868c84b..d7df692e17 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java @@ -34,6 +34,8 @@ public abstract class Annotation implements Comparable<Annotation> { * </p> * This ID is unique for a MapView instance and is suitable for associating your own extra * data with. + * + * @return the assigned id */ public long getId() { return id; @@ -48,6 +50,8 @@ public abstract class Annotation implements Comparable<Annotation> { /** * Do not use this method. Used internally by the SDK. + * + * @param id the assigned id */ public void setId(long id) { this.id = id; @@ -55,15 +59,17 @@ public abstract class Annotation implements Comparable<Annotation> { /** * Do not use this method. Used internally by the SDK. + * + * @param mapboxMap the hosting mapbox map */ public void setMapboxMap(MapboxMap mapboxMap) { this.mapboxMap = mapboxMap; } /** - * Gets the associated MapboxMap + * Gets the hosting mapbox map. * - * @return The MapboxMap + * @return the MapboxMap */ protected MapboxMap getMapboxMap() { return mapboxMap; @@ -71,13 +77,15 @@ public abstract class Annotation implements Comparable<Annotation> { /** * Don not use this method. Used internally by the SDK. + * + * @param mapView the hosting map view */ public void setMapView(MapView mapView) { this.mapView = mapView; } /** - * Gets the associated MapView + * Gets the hosting map view. * * @return The MapView */ diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java index d24f020a18..38c8373104 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java @@ -3,6 +3,7 @@ package com.mapbox.mapboxsdk.annotations; import android.support.annotation.NonNull; import android.support.annotation.Nullable; import android.view.View; + import com.mapbox.mapboxsdk.R; import com.mapbox.mapboxsdk.geometry.LatLng; import com.mapbox.mapboxsdk.maps.MapView; @@ -41,7 +42,7 @@ public class Marker extends Annotation { title = baseMarkerOptions.title; } - Marker(BaseMarkerViewOptions baseMarkerViewOptions){ + Marker(BaseMarkerViewOptions baseMarkerViewOptions) { position = baseMarkerViewOptions.position; snippet = baseMarkerViewOptions.snippet; icon = baseMarkerViewOptions.icon; @@ -72,6 +73,8 @@ public class Marker extends Annotation { /** * Do not use this method. Used internally by the SDK. + * + * @return true if the infoWindow is shown */ public boolean isInfoWindowShown() { return infoWindowShown; @@ -126,7 +129,7 @@ public class Marker extends Annotation { * Update only for default Marker's InfoWindow content for Title and Snippet */ private void refreshInfoWindowContent() { - if (isInfoWindowShown() && mapView != null && mapboxMap != null && mapboxMap.getInfoWindowAdapter() == null) { + if (isInfoWindowShown() && mapView != null && mapboxMap != null && mapboxMap.getInfoWindowAdapter() == null) { InfoWindow infoWindow = getInfoWindow(mapView); if (mapView.getContext() != null) { infoWindow.adaptDefaultMarker(this, mapboxMap, mapView); @@ -140,6 +143,10 @@ public class Marker extends Annotation { /** * Do not use this method. Used internally by the SDK. + * + * @param mapboxMap the hosting mapbox map + * @param mapView the hosting map view + * @return the info window that was shown */ public InfoWindow showInfoWindow(@NonNull MapboxMap mapboxMap, @NonNull MapView mapView) { setMapboxMap(mapboxMap); @@ -177,6 +184,8 @@ public class Marker extends Annotation { /** * Do not use this method. Used internally by the SDK. + * + * @param topOffsetPixels the top offset pixels. */ public void setTopOffsetPixels(int topOffsetPixels) { this.topOffsetPixels = topOffsetPixels; @@ -184,6 +193,8 @@ public class Marker extends Annotation { /** * Do not use this method. Used internally by the SDK. + * + * @param rightOffsetPixels the right offset pixels. */ public void setRightOffsetPixels(int rightOffsetPixels) { this.rightOffsetPixels = rightOffsetPixels; diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerViewManager.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerViewManager.java index d138ded963..682ba140c4 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerViewManager.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerViewManager.java @@ -156,7 +156,9 @@ public class MarkerViewManager { } /** + * Update and invalidate the MarkerView icon. * + * @param markerView the marker view to updates */ public void updateIcon(@NonNull MarkerView markerView) { View convertView = markerViewMap.get(markerView); diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java index f9346e21d6..3a365de60a 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/camera/CameraPosition.java @@ -137,7 +137,7 @@ public final class CameraPosition implements Parcelable { /** * Creates a builder for building CameraPosition objects using radiants. * - * @param isRadiant + * @param isRadiant true if heading is in radiants */ public Builder(boolean isRadiant) { this.isRadiant = isRadiant; diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java index 8887658a3e..1f1417b4b6 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java @@ -27,10 +27,10 @@ public class ProjectedMeters implements IProjectedMeters, Parcelable { private double easting; /** - * Creates a ProjectedMeters based on projected meters in north and east direction + * Creates a ProjectedMeters based on projected meters in north and east direction. * - * @param northing - * @param easting + * @param northing the northing in meters + * @param easting the easting in meters */ public ProjectedMeters(double northing, double easting) { this.northing = northing; diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java index 6b0c207a1a..318eec80b4 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java @@ -881,8 +881,8 @@ public class MapView extends FrameLayout { * DEPRECATED @see MapboxAccountManager#start(String) * </p> * <p> - * <p> * Sets the current Mapbox access token used to load map styles and tiles. + * </p> * <p> * You must set a valid access token before you call {@link MapView#onCreate(Bundle)} * or an exception will be thrown. diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java index 26f13ed353..5cae6e70bb 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java @@ -1908,7 +1908,6 @@ public class MapboxMap { /** * Called when an MarkerView is removed from the MapView or the View object is going to be reused. * <p> - * <p> * This method should be used to reset an animated view back to it's original state for view reuse. * </p> * <p> @@ -1990,8 +1989,9 @@ public class MapboxMap { /** * Interface definition for a callback to be invoked when the user clicks on a MarkerView. - * - * @see MarkerViewManager#setOnMarkerViewClickListener(OnMarkerViewClickListener) + * </p> + * {@link MarkerViewManager#setOnMarkerViewClickListener(OnMarkerViewClickListener)} + * </p> */ public interface OnMarkerViewClickListener { diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMapOptions.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMapOptions.java index 0fd6b1390d..42609b8265 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMapOptions.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMapOptions.java @@ -124,11 +124,11 @@ public class MapboxMapOptions implements Parcelable { } /** - * Creates a GoogleMapsOptions from the attribute set + * Creates a MapboxMapsOptions from the attribute set.s * * @param context Context related to a map view. * @param attrs Attributeset containing configuration - * @return + * @return the MapboxMapOptions created from attributes */ public static MapboxMapOptions createFromAttributes(@NonNull Context context, @Nullable AttributeSet attrs) { MapboxMapOptions mapboxMapOptions = new MapboxMapOptions(); diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java index 4ce631fc3e..a06f449309 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/UiSettings.java @@ -8,8 +8,6 @@ import android.support.annotation.UiThread; import android.view.Gravity; import android.view.View; -import com.mapbox.mapboxsdk.maps.widgets.MyLocationViewSettings; - /** * Settings for the user interface of a MapboxMap. To obtain this interface, call getUiSettings(). */ @@ -492,7 +490,7 @@ public class UiSettings { /** * Gets whether the markers are automatically deselected (and therefore, their infowindows * closed) when a map tap is detected. - + * * @return If true, markers are deselected on a map tap. */ public boolean isDeselectMarkersOnTap() { @@ -503,7 +501,7 @@ public class UiSettings { * Sets whether the markers are automatically deselected (and therefore, their infowindows * closed) when a map tap is detected. * - * @param deselectMarkersOnTap + * @param deselectMarkersOnTap determines if markers should be deslected on tap */ public void setDeselectMarkersOnTap(boolean deselectMarkersOnTap) { this.deselectMarkersOnTap = deselectMarkersOnTap; @@ -580,7 +578,7 @@ public class UiSettings { /** * Returns the gesture focal point * - * @return The focal point + * @return The focal point */ public PointF getFocalPoint() { return focalPoint; diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java index 7b41184a5a..80d5ff7db0 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java @@ -55,16 +55,16 @@ public class OfflineManager { */ public interface ListOfflineRegionsCallback { /** - * Receives the list of offline regions + * Receives the list of offline regions. * - * @param offlineRegions + * @param offlineRegions the offline region array */ void onList(OfflineRegion[] offlineRegions); /** - * Receives the error message + * Receives the error message. * - * @param error + * @param error the error message */ void onError(String error); } @@ -75,16 +75,16 @@ public class OfflineManager { */ public interface CreateOfflineRegionCallback { /** - * Receives the newly created offline region + * Receives the newly created offline region. * - * @param offlineRegion + * @param offlineRegion the offline region to create */ void onCreate(OfflineRegion offlineRegion); /** - * Receives the error message + * Receives the error message. * - * @param error + * @param error the error message to be shown */ void onError(String error); } @@ -149,6 +149,8 @@ public class OfflineManager { * <p> * Code from https://developer.android.com/guide/topics/data/data-storage.html#filesExternal * </p> + * + * @return true if external storage is readable */ public static boolean isExternalStorageReadable() { String state = Environment.getExternalStorageState(); @@ -193,7 +195,7 @@ public class OfflineManager { /** * Access token getter/setter * - * @param accessToken + * @param accessToken the accessToken to be used by the offline manager. * @deprecated As of release 4.1.0, replaced by {@link MapboxAccountManager#start(Context, String)} ()} */ @Deprecated @@ -226,6 +228,8 @@ public class OfflineManager { * The query will be executed asynchronously and the results passed to the given * callback on the main thread. * </p> + * + * @param callback the callback to be invoked */ public void listOfflineRegions(@NonNull final ListOfflineRegionsCallback callback) { listOfflineRegions(mDefaultFileSourcePtr, new ListOfflineRegionsCallback() { @@ -262,6 +266,10 @@ public class OfflineManager { * downloading resources, call `OfflineRegion.setDownloadState(DownloadState.STATE_ACTIVE)`, * optionally registering an `OfflineRegionObserver` beforehand. * </p> + * + * @param definition the offline region definition + * @param metadata the metadata in bytes + * @param callback the callback to be invoked */ public void createOfflineRegion( @NonNull OfflineRegionDefinition definition, diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java index 3756c93df2..22cb034f08 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java @@ -55,8 +55,11 @@ public class OfflineRegion { * Implement this method to be notified of a change in the status of an * offline region. Status changes include any change in state of the members * of OfflineRegionStatus. - * + * <p> * This method will be executed on the main thread. + * </p> + * + * @param status the changed status */ void onStatusChanged(OfflineRegionStatus status); @@ -65,8 +68,11 @@ public class OfflineRegion { * regional resources. Such errors may be recoverable; for example the implementation * will attempt to re-request failed resources based on an exponential backoff * algorithm, or when it detects that network access has been restored. - * + * <p> * This method will be executed on the main thread. + * </p> + * + * @param error the offline region error message */ void onError(OfflineRegionError error); @@ -93,14 +99,14 @@ public class OfflineRegion { /** * Receives the status * - * @param status + * @param status the offline region status */ void onStatus(OfflineRegionStatus status); /** * Receives the error message * - * @param error + * @param error the error message */ void onError(String error); } @@ -118,7 +124,7 @@ public class OfflineRegion { /** * Receives the error message * - * @param error + * @param error the error message */ void onError(String error); } @@ -127,15 +133,17 @@ public class OfflineRegion { * A region is either inactive (not downloading, but previously-downloaded * resources are available for use), or active (resources are being downloaded * or will be downloaded, if necessary, when network access is available). - * + * <p> * This state is independent of whether or not the complete set of resources * is currently available for offline use. To check if that is the case, use * `OfflineRegionStatus.isComplete()`. + * </p> */ @IntDef({STATE_INACTIVE, STATE_ACTIVE}) @Retention(RetentionPolicy.SOURCE) - public @interface DownloadState {} + public @interface DownloadState { + } public static final int STATE_INACTIVE = 0; public static final int STATE_ACTIVE = 1; @@ -148,6 +156,8 @@ public class OfflineRegion { /** * Gets whether or not the `OfflineRegionObserver` will continue to deliver messages even if * the region state has been set as STATE_INACTIVE. + * + * @return true if delivering inactive messages */ public boolean isDeliveringInactiveMessages() { return deliverInactiveMessages; @@ -157,6 +167,8 @@ public class OfflineRegion { * When set true, the `OfflineRegionObserver` will continue to deliver messages even if * the region state has been set as STATE_INACTIVE (operations happen asynchronously). If set * false, the client won't be notified of further messages. + * + * @param deliverInactiveMessages true if it should deliver inactive messages */ public void setDeliverInactiveMessages(boolean deliverInactiveMessages) { this.deliverInactiveMessages = deliverInactiveMessages; @@ -203,6 +215,8 @@ public class OfflineRegion { /** * Register an observer to be notified when the state of the region changes. + * + * @param observer the observer to be notified */ public void setObserver(@NonNull final OfflineRegionObserver observer) { setOfflineRegionObserver(new OfflineRegionObserver() { @@ -246,6 +260,8 @@ public class OfflineRegion { /** * Pause or resume downloading of regional resources. + * + * @param state the download state */ public void setDownloadState(@DownloadState int state) { this.state = state; @@ -256,6 +272,8 @@ public class OfflineRegion { * Retrieve the current status of the region. The query will be executed * asynchronously and the results passed to the given callback which will be * executed on the main thread. + * + * @param callback the callback to invoked. */ public void getStatus(@NonNull final OfflineRegionStatusCallback callback) { getOfflineRegionStatus(new OfflineRegionStatusCallback() { @@ -284,14 +302,19 @@ public class OfflineRegion { /** * Remove an offline region from the database and perform any resources evictions * necessary as a result. - * + * <p> * Eviction works by removing the least-recently requested resources not also required * by other regions, until the database shrinks below a certain size. - * + * </p> + * <p> * When the operation is complete or encounters an error, the given callback will be * executed on the main thread. - * + * </p> + * <p> * After you call this method, you may not call any additional methods on this object. + * </p> + * + * @param callback the callback to be invoked */ public void delete(@NonNull final OfflineRegionDeleteCallback callback) { deleteOfflineRegion(new OfflineRegionDeleteCallback() { diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java index 1a1aa48065..4d4a924dab 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java @@ -12,14 +12,20 @@ import android.support.annotation.ColorInt; public class PropertyFactory { /** - * Set visibility + * Set the property visibility. + * + * @param value the visibility value + * @return property wrapper around visibility */ public static Property<String> visibility(@Property.VISIBILITY String value) { return new LayoutProperty<>("visibility", value); } /** - * Set visibility + * Set the property visibility. + * + * @param function the visibility function + * @return property wrapper around a String function */ public static Property<Function<String>> visibility(Function<String> function) { return new LayoutProperty<>("visibility", function); @@ -27,6 +33,9 @@ public class PropertyFactory { /** * Whether or not the fill should be antialiased. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> fillAntialias(Boolean value) { return new PaintProperty<>("fill-antialias", value); @@ -34,6 +43,9 @@ public class PropertyFactory { /** * Whether or not the fill should be antialiased. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> fillAntialias(Function<Boolean> function) { return new PaintProperty<>("fill-antialias", function); @@ -41,6 +53,9 @@ public class PropertyFactory { /** * The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> fillOpacity(Float value) { return new PaintProperty<>("fill-opacity", value); @@ -48,6 +63,9 @@ public class PropertyFactory { /** * The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> fillOpacity(Function<Float> function) { return new PaintProperty<>("fill-opacity", function); @@ -55,6 +73,9 @@ public class PropertyFactory { /** * The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> fillColor(@ColorInt int value) { return new PaintProperty<>("fill-color", colorToRgbaString(value)); @@ -62,6 +83,9 @@ public class PropertyFactory { /** * The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> fillColor(String value) { return new PaintProperty<>("fill-color", value); @@ -69,6 +93,9 @@ public class PropertyFactory { /** * The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> fillColor(Function<String> function) { return new PaintProperty<>("fill-color", function); @@ -76,6 +103,9 @@ public class PropertyFactory { /** * The outline color of the fill. Matches the value of `fill-color` if unspecified. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> fillOutlineColor(@ColorInt int value) { return new PaintProperty<>("fill-outline-color", colorToRgbaString(value)); @@ -83,6 +113,9 @@ public class PropertyFactory { /** * The outline color of the fill. Matches the value of `fill-color` if unspecified. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> fillOutlineColor(String value) { return new PaintProperty<>("fill-outline-color", value); @@ -90,6 +123,9 @@ public class PropertyFactory { /** * The outline color of the fill. Matches the value of `fill-color` if unspecified. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> fillOutlineColor(Function<String> function) { return new PaintProperty<>("fill-outline-color", function); @@ -97,6 +133,9 @@ public class PropertyFactory { /** * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> fillTranslate(Float[] value) { return new PaintProperty<>("fill-translate", value); @@ -104,6 +143,9 @@ public class PropertyFactory { /** * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> fillTranslate(Function<Float[]> function) { return new PaintProperty<>("fill-translate", function); @@ -111,6 +153,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen) + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> fillTranslateAnchor(@Property.FILL_TRANSLATE_ANCHOR String value) { return new PaintProperty<>("fill-translate-anchor", value); @@ -118,6 +163,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen) + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> fillTranslateAnchor(Function<String> function) { return new PaintProperty<>("fill-translate-anchor", function); @@ -125,6 +173,9 @@ public class PropertyFactory { /** * Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> fillPattern(String value) { return new PaintProperty<>("fill-pattern", value); @@ -132,6 +183,9 @@ public class PropertyFactory { /** * Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> fillPattern(Function<String> function) { return new PaintProperty<>("fill-pattern", function); @@ -139,6 +193,9 @@ public class PropertyFactory { /** * The opacity at which the line will be drawn. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> lineOpacity(Float value) { return new PaintProperty<>("line-opacity", value); @@ -146,6 +203,9 @@ public class PropertyFactory { /** * The opacity at which the line will be drawn. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> lineOpacity(Function<Float> function) { return new PaintProperty<>("line-opacity", function); @@ -153,6 +213,9 @@ public class PropertyFactory { /** * The color with which the line will be drawn. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> lineColor(@ColorInt int value) { return new PaintProperty<>("line-color", colorToRgbaString(value)); @@ -160,6 +223,9 @@ public class PropertyFactory { /** * The color with which the line will be drawn. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> lineColor(String value) { return new PaintProperty<>("line-color", value); @@ -167,6 +233,9 @@ public class PropertyFactory { /** * The color with which the line will be drawn. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> lineColor(Function<String> function) { return new PaintProperty<>("line-color", function); @@ -174,6 +243,9 @@ public class PropertyFactory { /** * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> lineTranslate(Float[] value) { return new PaintProperty<>("line-translate", value); @@ -181,6 +253,9 @@ public class PropertyFactory { /** * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> lineTranslate(Function<Float[]> function) { return new PaintProperty<>("line-translate", function); @@ -188,6 +263,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen) + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> lineTranslateAnchor(@Property.LINE_TRANSLATE_ANCHOR String value) { return new PaintProperty<>("line-translate-anchor", value); @@ -195,6 +273,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen) + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> lineTranslateAnchor(Function<String> function) { return new PaintProperty<>("line-translate-anchor", function); @@ -202,6 +283,9 @@ public class PropertyFactory { /** * Stroke thickness. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> lineWidth(Float value) { return new PaintProperty<>("line-width", value); @@ -209,6 +293,9 @@ public class PropertyFactory { /** * Stroke thickness. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> lineWidth(Function<Float> function) { return new PaintProperty<>("line-width", function); @@ -216,6 +303,9 @@ public class PropertyFactory { /** * Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> lineGapWidth(Float value) { return new PaintProperty<>("line-gap-width", value); @@ -223,6 +313,9 @@ public class PropertyFactory { /** * Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> lineGapWidth(Function<Float> function) { return new PaintProperty<>("line-gap-width", function); @@ -230,6 +323,9 @@ public class PropertyFactory { /** * The line's offset perpendicular to its direction. Values may be positive or negative, where positive indicates "rightwards" (if you were moving in the direction of the line) and negative indicates "leftwards." + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> lineOffset(Float value) { return new PaintProperty<>("line-offset", value); @@ -237,6 +333,9 @@ public class PropertyFactory { /** * The line's offset perpendicular to its direction. Values may be positive or negative, where positive indicates "rightwards" (if you were moving in the direction of the line) and negative indicates "leftwards." + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> lineOffset(Function<Float> function) { return new PaintProperty<>("line-offset", function); @@ -244,6 +343,9 @@ public class PropertyFactory { /** * Blur applied to the line, in pixels. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> lineBlur(Float value) { return new PaintProperty<>("line-blur", value); @@ -251,6 +353,9 @@ public class PropertyFactory { /** * Blur applied to the line, in pixels. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> lineBlur(Function<Float> function) { return new PaintProperty<>("line-blur", function); @@ -258,6 +363,9 @@ public class PropertyFactory { /** * Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> lineDasharray(Float[] value) { return new PaintProperty<>("line-dasharray", value); @@ -265,6 +373,9 @@ public class PropertyFactory { /** * Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> lineDasharray(Function<Float[]> function) { return new PaintProperty<>("line-dasharray", function); @@ -272,6 +383,9 @@ public class PropertyFactory { /** * Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> linePattern(String value) { return new PaintProperty<>("line-pattern", value); @@ -279,6 +393,9 @@ public class PropertyFactory { /** * Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> linePattern(Function<String> function) { return new PaintProperty<>("line-pattern", function); @@ -286,6 +403,9 @@ public class PropertyFactory { /** * The opacity at which the icon will be drawn. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> iconOpacity(Float value) { return new PaintProperty<>("icon-opacity", value); @@ -293,6 +413,9 @@ public class PropertyFactory { /** * The opacity at which the icon will be drawn. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> iconOpacity(Function<Float> function) { return new PaintProperty<>("icon-opacity", function); @@ -300,6 +423,9 @@ public class PropertyFactory { /** * The color of the icon. This can only be used with sdf icons. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> iconColor(@ColorInt int value) { return new PaintProperty<>("icon-color", colorToRgbaString(value)); @@ -307,6 +433,9 @@ public class PropertyFactory { /** * The color of the icon. This can only be used with sdf icons. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> iconColor(String value) { return new PaintProperty<>("icon-color", value); @@ -314,6 +443,9 @@ public class PropertyFactory { /** * The color of the icon. This can only be used with sdf icons. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> iconColor(Function<String> function) { return new PaintProperty<>("icon-color", function); @@ -321,6 +453,9 @@ public class PropertyFactory { /** * The color of the icon's halo. Icon halos can only be used with sdf icons. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> iconHaloColor(@ColorInt int value) { return new PaintProperty<>("icon-halo-color", colorToRgbaString(value)); @@ -328,6 +463,9 @@ public class PropertyFactory { /** * The color of the icon's halo. Icon halos can only be used with sdf icons. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> iconHaloColor(String value) { return new PaintProperty<>("icon-halo-color", value); @@ -335,6 +473,9 @@ public class PropertyFactory { /** * The color of the icon's halo. Icon halos can only be used with sdf icons. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> iconHaloColor(Function<String> function) { return new PaintProperty<>("icon-halo-color", function); @@ -342,6 +483,9 @@ public class PropertyFactory { /** * Distance of halo to the icon outline. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> iconHaloWidth(Float value) { return new PaintProperty<>("icon-halo-width", value); @@ -349,6 +493,9 @@ public class PropertyFactory { /** * Distance of halo to the icon outline. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> iconHaloWidth(Function<Float> function) { return new PaintProperty<>("icon-halo-width", function); @@ -356,6 +503,9 @@ public class PropertyFactory { /** * Fade out the halo towards the outside. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> iconHaloBlur(Float value) { return new PaintProperty<>("icon-halo-blur", value); @@ -363,6 +513,9 @@ public class PropertyFactory { /** * Fade out the halo towards the outside. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> iconHaloBlur(Function<Float> function) { return new PaintProperty<>("icon-halo-blur", function); @@ -370,6 +523,9 @@ public class PropertyFactory { /** * Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> iconTranslate(Float[] value) { return new PaintProperty<>("icon-translate", value); @@ -377,6 +533,9 @@ public class PropertyFactory { /** * Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> iconTranslate(Function<Float[]> function) { return new PaintProperty<>("icon-translate", function); @@ -384,6 +543,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen). + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> iconTranslateAnchor(@Property.ICON_TRANSLATE_ANCHOR String value) { return new PaintProperty<>("icon-translate-anchor", value); @@ -391,6 +553,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen). + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> iconTranslateAnchor(Function<String> function) { return new PaintProperty<>("icon-translate-anchor", function); @@ -398,6 +563,9 @@ public class PropertyFactory { /** * The opacity at which the text will be drawn. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textOpacity(Float value) { return new PaintProperty<>("text-opacity", value); @@ -405,6 +573,9 @@ public class PropertyFactory { /** * The opacity at which the text will be drawn. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textOpacity(Function<Float> function) { return new PaintProperty<>("text-opacity", function); @@ -412,6 +583,9 @@ public class PropertyFactory { /** * The color with which the text will be drawn. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> textColor(@ColorInt int value) { return new PaintProperty<>("text-color", colorToRgbaString(value)); @@ -419,6 +593,9 @@ public class PropertyFactory { /** * The color with which the text will be drawn. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textColor(String value) { return new PaintProperty<>("text-color", value); @@ -426,6 +603,9 @@ public class PropertyFactory { /** * The color with which the text will be drawn. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textColor(Function<String> function) { return new PaintProperty<>("text-color", function); @@ -433,6 +613,9 @@ public class PropertyFactory { /** * The color of the text's halo, which helps it stand out from backgrounds. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> textHaloColor(@ColorInt int value) { return new PaintProperty<>("text-halo-color", colorToRgbaString(value)); @@ -440,6 +623,9 @@ public class PropertyFactory { /** * The color of the text's halo, which helps it stand out from backgrounds. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textHaloColor(String value) { return new PaintProperty<>("text-halo-color", value); @@ -447,6 +633,9 @@ public class PropertyFactory { /** * The color of the text's halo, which helps it stand out from backgrounds. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textHaloColor(Function<String> function) { return new PaintProperty<>("text-halo-color", function); @@ -454,6 +643,9 @@ public class PropertyFactory { /** * Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textHaloWidth(Float value) { return new PaintProperty<>("text-halo-width", value); @@ -461,6 +653,9 @@ public class PropertyFactory { /** * Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textHaloWidth(Function<Float> function) { return new PaintProperty<>("text-halo-width", function); @@ -468,6 +663,9 @@ public class PropertyFactory { /** * The halo's fadeout distance towards the outside. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textHaloBlur(Float value) { return new PaintProperty<>("text-halo-blur", value); @@ -475,6 +673,9 @@ public class PropertyFactory { /** * The halo's fadeout distance towards the outside. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textHaloBlur(Function<Float> function) { return new PaintProperty<>("text-halo-blur", function); @@ -482,6 +683,9 @@ public class PropertyFactory { /** * Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> textTranslate(Float[] value) { return new PaintProperty<>("text-translate", value); @@ -489,6 +693,9 @@ public class PropertyFactory { /** * Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> textTranslate(Function<Float[]> function) { return new PaintProperty<>("text-translate", function); @@ -496,6 +703,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen). + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textTranslateAnchor(@Property.TEXT_TRANSLATE_ANCHOR String value) { return new PaintProperty<>("text-translate-anchor", value); @@ -503,6 +713,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen). + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textTranslateAnchor(Function<String> function) { return new PaintProperty<>("text-translate-anchor", function); @@ -510,6 +723,9 @@ public class PropertyFactory { /** * Circle radius. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> circleRadius(Float value) { return new PaintProperty<>("circle-radius", value); @@ -517,6 +733,9 @@ public class PropertyFactory { /** * Circle radius. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> circleRadius(Function<Float> function) { return new PaintProperty<>("circle-radius", function); @@ -524,6 +743,9 @@ public class PropertyFactory { /** * The color of the circle. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> circleColor(@ColorInt int value) { return new PaintProperty<>("circle-color", colorToRgbaString(value)); @@ -531,6 +753,9 @@ public class PropertyFactory { /** * The color of the circle. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> circleColor(String value) { return new PaintProperty<>("circle-color", value); @@ -538,6 +763,9 @@ public class PropertyFactory { /** * The color of the circle. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> circleColor(Function<String> function) { return new PaintProperty<>("circle-color", function); @@ -545,6 +773,9 @@ public class PropertyFactory { /** * Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> circleBlur(Float value) { return new PaintProperty<>("circle-blur", value); @@ -552,6 +783,9 @@ public class PropertyFactory { /** * Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> circleBlur(Function<Float> function) { return new PaintProperty<>("circle-blur", function); @@ -559,6 +793,9 @@ public class PropertyFactory { /** * The opacity at which the circle will be drawn. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> circleOpacity(Float value) { return new PaintProperty<>("circle-opacity", value); @@ -566,6 +803,9 @@ public class PropertyFactory { /** * The opacity at which the circle will be drawn. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> circleOpacity(Function<Float> function) { return new PaintProperty<>("circle-opacity", function); @@ -573,6 +813,9 @@ public class PropertyFactory { /** * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> circleTranslate(Float[] value) { return new PaintProperty<>("circle-translate", value); @@ -580,6 +823,9 @@ public class PropertyFactory { /** * The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> circleTranslate(Function<Float[]> function) { return new PaintProperty<>("circle-translate", function); @@ -587,6 +833,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen) + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> circleTranslateAnchor(@Property.CIRCLE_TRANSLATE_ANCHOR String value) { return new PaintProperty<>("circle-translate-anchor", value); @@ -594,6 +843,9 @@ public class PropertyFactory { /** * Control whether the translation is relative to the map (north) or viewport (screen) + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> circleTranslateAnchor(Function<String> function) { return new PaintProperty<>("circle-translate-anchor", function); @@ -601,6 +853,9 @@ public class PropertyFactory { /** * Controls the scaling behavior of the circle when the map is pitched. The value `map` scales circles according to their apparent distance to the camera. The value `viewport` results in no pitch-related scaling. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> circlePitchScale(@Property.CIRCLE_PITCH_SCALE String value) { return new PaintProperty<>("circle-pitch-scale", value); @@ -608,6 +863,9 @@ public class PropertyFactory { /** * Controls the scaling behavior of the circle when the map is pitched. The value `map` scales circles according to their apparent distance to the camera. The value `viewport` results in no pitch-related scaling. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> circlePitchScale(Function<String> function) { return new PaintProperty<>("circle-pitch-scale", function); @@ -615,6 +873,9 @@ public class PropertyFactory { /** * The opacity at which the image will be drawn. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> rasterOpacity(Float value) { return new PaintProperty<>("raster-opacity", value); @@ -622,6 +883,9 @@ public class PropertyFactory { /** * The opacity at which the image will be drawn. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> rasterOpacity(Function<Float> function) { return new PaintProperty<>("raster-opacity", function); @@ -629,6 +893,9 @@ public class PropertyFactory { /** * Rotates hues around the color wheel. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> rasterHueRotate(Float value) { return new PaintProperty<>("raster-hue-rotate", value); @@ -636,6 +903,9 @@ public class PropertyFactory { /** * Rotates hues around the color wheel. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> rasterHueRotate(Function<Float> function) { return new PaintProperty<>("raster-hue-rotate", function); @@ -643,6 +913,9 @@ public class PropertyFactory { /** * Increase or reduce the brightness of the image. The value is the minimum brightness. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> rasterBrightnessMin(Float value) { return new PaintProperty<>("raster-brightness-min", value); @@ -650,6 +923,9 @@ public class PropertyFactory { /** * Increase or reduce the brightness of the image. The value is the minimum brightness. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> rasterBrightnessMin(Function<Float> function) { return new PaintProperty<>("raster-brightness-min", function); @@ -657,6 +933,9 @@ public class PropertyFactory { /** * Increase or reduce the brightness of the image. The value is the maximum brightness. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> rasterBrightnessMax(Float value) { return new PaintProperty<>("raster-brightness-max", value); @@ -664,6 +943,9 @@ public class PropertyFactory { /** * Increase or reduce the brightness of the image. The value is the maximum brightness. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> rasterBrightnessMax(Function<Float> function) { return new PaintProperty<>("raster-brightness-max", function); @@ -671,6 +953,9 @@ public class PropertyFactory { /** * Increase or reduce the saturation of the image. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> rasterSaturation(Float value) { return new PaintProperty<>("raster-saturation", value); @@ -678,6 +963,9 @@ public class PropertyFactory { /** * Increase or reduce the saturation of the image. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> rasterSaturation(Function<Float> function) { return new PaintProperty<>("raster-saturation", function); @@ -685,6 +973,9 @@ public class PropertyFactory { /** * Increase or reduce the contrast of the image. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> rasterContrast(Float value) { return new PaintProperty<>("raster-contrast", value); @@ -692,6 +983,9 @@ public class PropertyFactory { /** * Increase or reduce the contrast of the image. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> rasterContrast(Function<Float> function) { return new PaintProperty<>("raster-contrast", function); @@ -699,6 +993,9 @@ public class PropertyFactory { /** * Fade duration when a new tile is added. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> rasterFadeDuration(Float value) { return new PaintProperty<>("raster-fade-duration", value); @@ -706,6 +1003,9 @@ public class PropertyFactory { /** * Fade duration when a new tile is added. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> rasterFadeDuration(Function<Float> function) { return new PaintProperty<>("raster-fade-duration", function); @@ -713,6 +1013,9 @@ public class PropertyFactory { /** * The color with which the background will be drawn. + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> backgroundColor(@ColorInt int value) { return new PaintProperty<>("background-color", colorToRgbaString(value)); @@ -720,6 +1023,9 @@ public class PropertyFactory { /** * The color with which the background will be drawn. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> backgroundColor(String value) { return new PaintProperty<>("background-color", value); @@ -727,6 +1033,9 @@ public class PropertyFactory { /** * The color with which the background will be drawn. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> backgroundColor(Function<String> function) { return new PaintProperty<>("background-color", function); @@ -734,6 +1043,9 @@ public class PropertyFactory { /** * Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> backgroundPattern(String value) { return new PaintProperty<>("background-pattern", value); @@ -741,6 +1053,9 @@ public class PropertyFactory { /** * Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> backgroundPattern(Function<String> function) { return new PaintProperty<>("background-pattern", function); @@ -748,6 +1063,9 @@ public class PropertyFactory { /** * The opacity at which the background will be drawn. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> backgroundOpacity(Float value) { return new PaintProperty<>("background-opacity", value); @@ -755,6 +1073,9 @@ public class PropertyFactory { /** * The opacity at which the background will be drawn. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> backgroundOpacity(Function<Float> function) { return new PaintProperty<>("background-opacity", function); @@ -762,6 +1083,9 @@ public class PropertyFactory { /** * The display of line endings. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> lineCap(@Property.LINE_CAP String value) { return new LayoutProperty<>("line-cap", value); @@ -769,6 +1093,9 @@ public class PropertyFactory { /** * The display of line endings. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> lineCap(Function<String> function) { return new LayoutProperty<>("line-cap", function); @@ -776,6 +1103,9 @@ public class PropertyFactory { /** * The display of lines when joining. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> lineJoin(@Property.LINE_JOIN String value) { return new LayoutProperty<>("line-join", value); @@ -783,6 +1113,9 @@ public class PropertyFactory { /** * The display of lines when joining. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> lineJoin(Function<String> function) { return new LayoutProperty<>("line-join", function); @@ -790,6 +1123,9 @@ public class PropertyFactory { /** * Used to automatically convert miter joins to bevel joins for sharp angles. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> lineMiterLimit(Float value) { return new LayoutProperty<>("line-miter-limit", value); @@ -797,6 +1133,9 @@ public class PropertyFactory { /** * Used to automatically convert miter joins to bevel joins for sharp angles. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> lineMiterLimit(Function<Float> function) { return new LayoutProperty<>("line-miter-limit", function); @@ -804,6 +1143,9 @@ public class PropertyFactory { /** * Used to automatically convert round joins to miter joins for shallow angles. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> lineRoundLimit(Float value) { return new LayoutProperty<>("line-round-limit", value); @@ -811,6 +1153,9 @@ public class PropertyFactory { /** * Used to automatically convert round joins to miter joins for shallow angles. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> lineRoundLimit(Function<Float> function) { return new LayoutProperty<>("line-round-limit", function); @@ -818,6 +1163,9 @@ public class PropertyFactory { /** * Label placement relative to its geometry. `line` can only be used on LineStrings and Polygons. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> symbolPlacement(@Property.SYMBOL_PLACEMENT String value) { return new LayoutProperty<>("symbol-placement", value); @@ -825,6 +1173,9 @@ public class PropertyFactory { /** * Label placement relative to its geometry. `line` can only be used on LineStrings and Polygons. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> symbolPlacement(Function<String> function) { return new LayoutProperty<>("symbol-placement", function); @@ -832,6 +1183,9 @@ public class PropertyFactory { /** * Distance between two symbol anchors. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> symbolSpacing(Float value) { return new LayoutProperty<>("symbol-spacing", value); @@ -839,6 +1193,9 @@ public class PropertyFactory { /** * Distance between two symbol anchors. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> symbolSpacing(Function<Float> function) { return new LayoutProperty<>("symbol-spacing", function); @@ -846,6 +1203,9 @@ public class PropertyFactory { /** * If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> symbolAvoidEdges(Boolean value) { return new LayoutProperty<>("symbol-avoid-edges", value); @@ -853,6 +1213,9 @@ public class PropertyFactory { /** * If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> symbolAvoidEdges(Function<Boolean> function) { return new LayoutProperty<>("symbol-avoid-edges", function); @@ -860,6 +1223,9 @@ public class PropertyFactory { /** * If true, the icon will be visible even if it collides with other previously drawn symbols. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> iconAllowOverlap(Boolean value) { return new LayoutProperty<>("icon-allow-overlap", value); @@ -867,6 +1233,9 @@ public class PropertyFactory { /** * If true, the icon will be visible even if it collides with other previously drawn symbols. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> iconAllowOverlap(Function<Boolean> function) { return new LayoutProperty<>("icon-allow-overlap", function); @@ -874,6 +1243,9 @@ public class PropertyFactory { /** * If true, other symbols can be visible even if they collide with the icon. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> iconIgnorePlacement(Boolean value) { return new LayoutProperty<>("icon-ignore-placement", value); @@ -881,6 +1253,9 @@ public class PropertyFactory { /** * If true, other symbols can be visible even if they collide with the icon. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> iconIgnorePlacement(Function<Boolean> function) { return new LayoutProperty<>("icon-ignore-placement", function); @@ -888,6 +1263,9 @@ public class PropertyFactory { /** * If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> iconOptional(Boolean value) { return new LayoutProperty<>("icon-optional", value); @@ -895,6 +1273,9 @@ public class PropertyFactory { /** * If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> iconOptional(Function<Boolean> function) { return new LayoutProperty<>("icon-optional", function); @@ -902,6 +1283,9 @@ public class PropertyFactory { /** * Orientation of icon when map is rotated. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> iconRotationAlignment(@Property.ICON_ROTATION_ALIGNMENT String value) { return new LayoutProperty<>("icon-rotation-alignment", value); @@ -909,6 +1293,9 @@ public class PropertyFactory { /** * Orientation of icon when map is rotated. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> iconRotationAlignment(Function<String> function) { return new LayoutProperty<>("icon-rotation-alignment", function); @@ -916,6 +1303,9 @@ public class PropertyFactory { /** * Scale factor for icon. 1 is original size, 3 triples the size. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> iconSize(Float value) { return new LayoutProperty<>("icon-size", value); @@ -923,6 +1313,9 @@ public class PropertyFactory { /** * Scale factor for icon. 1 is original size, 3 triples the size. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> iconSize(Function<Float> function) { return new LayoutProperty<>("icon-size", function); @@ -930,6 +1323,9 @@ public class PropertyFactory { /** * Position and scale an icon by the its corresponding text. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> iconTextFit(@Property.ICON_TEXT_FIT String value) { return new LayoutProperty<>("icon-text-fit", value); @@ -937,6 +1333,9 @@ public class PropertyFactory { /** * Position and scale an icon by the its corresponding text. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> iconTextFit(Function<String> function) { return new LayoutProperty<>("icon-text-fit", function); @@ -944,6 +1343,9 @@ public class PropertyFactory { /** * Size of padding area around the text-fit size in clockwise order: top, right, bottom, left. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> iconTextFitPadding(Float[] value) { return new LayoutProperty<>("icon-text-fit-padding", value); @@ -951,6 +1353,9 @@ public class PropertyFactory { /** * Size of padding area around the text-fit size in clockwise order: top, right, bottom, left. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> iconTextFitPadding(Function<Float[]> function) { return new LayoutProperty<>("icon-text-fit-padding", function); @@ -958,6 +1363,9 @@ public class PropertyFactory { /** * A string with {tokens} replaced, referencing the data property to pull from. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> iconImage(String value) { return new LayoutProperty<>("icon-image", value); @@ -965,6 +1373,9 @@ public class PropertyFactory { /** * A string with {tokens} replaced, referencing the data property to pull from. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> iconImage(Function<String> function) { return new LayoutProperty<>("icon-image", function); @@ -972,6 +1383,9 @@ public class PropertyFactory { /** * Rotates the icon clockwise. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> iconRotate(Float value) { return new LayoutProperty<>("icon-rotate", value); @@ -979,6 +1393,9 @@ public class PropertyFactory { /** * Rotates the icon clockwise. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> iconRotate(Function<Float> function) { return new LayoutProperty<>("icon-rotate", function); @@ -986,6 +1403,9 @@ public class PropertyFactory { /** * Size of the additional area around the icon bounding box used for detecting symbol collisions. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> iconPadding(Float value) { return new LayoutProperty<>("icon-padding", value); @@ -993,6 +1413,9 @@ public class PropertyFactory { /** * Size of the additional area around the icon bounding box used for detecting symbol collisions. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> iconPadding(Function<Float> function) { return new LayoutProperty<>("icon-padding", function); @@ -1000,6 +1423,9 @@ public class PropertyFactory { /** * If true, the icon may be flipped to prevent it from being rendered upside-down. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> iconKeepUpright(Boolean value) { return new LayoutProperty<>("icon-keep-upright", value); @@ -1007,6 +1433,9 @@ public class PropertyFactory { /** * If true, the icon may be flipped to prevent it from being rendered upside-down. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> iconKeepUpright(Function<Boolean> function) { return new LayoutProperty<>("icon-keep-upright", function); @@ -1014,6 +1443,9 @@ public class PropertyFactory { /** * Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> iconOffset(Float[] value) { return new LayoutProperty<>("icon-offset", value); @@ -1021,6 +1453,9 @@ public class PropertyFactory { /** * Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> iconOffset(Function<Float[]> function) { return new LayoutProperty<>("icon-offset", function); @@ -1028,6 +1463,9 @@ public class PropertyFactory { /** * Aligns text to the plane of the `viewport` or the `map` when the map is pitched. Matches `text-rotation-alignment` if unspecified. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textPitchAlignment(@Property.TEXT_PITCH_ALIGNMENT String value) { return new LayoutProperty<>("text-pitch-alignment", value); @@ -1035,6 +1473,9 @@ public class PropertyFactory { /** * Aligns text to the plane of the `viewport` or the `map` when the map is pitched. Matches `text-rotation-alignment` if unspecified. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textPitchAlignment(Function<String> function) { return new LayoutProperty<>("text-pitch-alignment", function); @@ -1042,6 +1483,9 @@ public class PropertyFactory { /** * Orientation of text when map is rotated. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textRotationAlignment(@Property.TEXT_ROTATION_ALIGNMENT String value) { return new LayoutProperty<>("text-rotation-alignment", value); @@ -1049,6 +1493,9 @@ public class PropertyFactory { /** * Orientation of text when map is rotated. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textRotationAlignment(Function<String> function) { return new LayoutProperty<>("text-rotation-alignment", function); @@ -1056,6 +1503,9 @@ public class PropertyFactory { /** * Value to use for a text label. Feature properties are specified using tokens like {field_name}. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textField(String value) { return new LayoutProperty<>("text-field", value); @@ -1063,6 +1513,9 @@ public class PropertyFactory { /** * Value to use for a text label. Feature properties are specified using tokens like {field_name}. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textField(Function<String> function) { return new LayoutProperty<>("text-field", function); @@ -1070,6 +1523,9 @@ public class PropertyFactory { /** * Font stack to use for displaying text. + * + * @param value a String[] value + * @return property wrapper around String[] */ public static Property<String[]> textFont(String[] value) { return new LayoutProperty<>("text-font", value); @@ -1077,6 +1533,9 @@ public class PropertyFactory { /** * Font stack to use for displaying text. + * + * @param function a wrapper function for String[] + * @return property wrapper around a String[] function */ public static Property<Function<String[]>> textFont(Function<String[]> function) { return new LayoutProperty<>("text-font", function); @@ -1084,6 +1543,9 @@ public class PropertyFactory { /** * Font size. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textSize(Float value) { return new LayoutProperty<>("text-size", value); @@ -1091,6 +1553,9 @@ public class PropertyFactory { /** * Font size. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textSize(Function<Float> function) { return new LayoutProperty<>("text-size", function); @@ -1098,6 +1563,9 @@ public class PropertyFactory { /** * The maximum line width for text wrapping. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textMaxWidth(Float value) { return new LayoutProperty<>("text-max-width", value); @@ -1105,6 +1573,9 @@ public class PropertyFactory { /** * The maximum line width for text wrapping. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textMaxWidth(Function<Float> function) { return new LayoutProperty<>("text-max-width", function); @@ -1112,6 +1583,9 @@ public class PropertyFactory { /** * Text leading value for multi-line text. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textLineHeight(Float value) { return new LayoutProperty<>("text-line-height", value); @@ -1119,6 +1593,9 @@ public class PropertyFactory { /** * Text leading value for multi-line text. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textLineHeight(Function<Float> function) { return new LayoutProperty<>("text-line-height", function); @@ -1126,6 +1603,9 @@ public class PropertyFactory { /** * Text tracking amount. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textLetterSpacing(Float value) { return new LayoutProperty<>("text-letter-spacing", value); @@ -1133,6 +1613,9 @@ public class PropertyFactory { /** * Text tracking amount. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textLetterSpacing(Function<Float> function) { return new LayoutProperty<>("text-letter-spacing", function); @@ -1140,6 +1623,9 @@ public class PropertyFactory { /** * Text justification options. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textJustify(@Property.TEXT_JUSTIFY String value) { return new LayoutProperty<>("text-justify", value); @@ -1147,6 +1633,9 @@ public class PropertyFactory { /** * Text justification options. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textJustify(Function<String> function) { return new LayoutProperty<>("text-justify", function); @@ -1154,6 +1643,9 @@ public class PropertyFactory { /** * Part of the text placed closest to the anchor. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textAnchor(@Property.TEXT_ANCHOR String value) { return new LayoutProperty<>("text-anchor", value); @@ -1161,6 +1653,9 @@ public class PropertyFactory { /** * Part of the text placed closest to the anchor. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textAnchor(Function<String> function) { return new LayoutProperty<>("text-anchor", function); @@ -1168,6 +1663,9 @@ public class PropertyFactory { /** * Maximum angle change between adjacent characters. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textMaxAngle(Float value) { return new LayoutProperty<>("text-max-angle", value); @@ -1175,6 +1673,9 @@ public class PropertyFactory { /** * Maximum angle change between adjacent characters. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textMaxAngle(Function<Float> function) { return new LayoutProperty<>("text-max-angle", function); @@ -1182,6 +1683,9 @@ public class PropertyFactory { /** * Rotates the text clockwise. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textRotate(Float value) { return new LayoutProperty<>("text-rotate", value); @@ -1189,6 +1693,9 @@ public class PropertyFactory { /** * Rotates the text clockwise. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textRotate(Function<Float> function) { return new LayoutProperty<>("text-rotate", function); @@ -1196,6 +1703,9 @@ public class PropertyFactory { /** * Size of the additional area around the text bounding box used for detecting symbol collisions. + * + * @param value a Float value + * @return property wrapper around Float */ public static Property<Float> textPadding(Float value) { return new LayoutProperty<>("text-padding", value); @@ -1203,6 +1713,9 @@ public class PropertyFactory { /** * Size of the additional area around the text bounding box used for detecting symbol collisions. + * + * @param function a wrapper function for Float + * @return property wrapper around a Float function */ public static Property<Function<Float>> textPadding(Function<Float> function) { return new LayoutProperty<>("text-padding", function); @@ -1210,6 +1723,9 @@ public class PropertyFactory { /** * If true, the text may be flipped vertically to prevent it from being rendered upside-down. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> textKeepUpright(Boolean value) { return new LayoutProperty<>("text-keep-upright", value); @@ -1217,6 +1733,9 @@ public class PropertyFactory { /** * If true, the text may be flipped vertically to prevent it from being rendered upside-down. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> textKeepUpright(Function<Boolean> function) { return new LayoutProperty<>("text-keep-upright", function); @@ -1224,6 +1743,9 @@ public class PropertyFactory { /** * Specifies how to capitalize text, similar to the CSS `text-transform` property. + * + * @param value a String value + * @return property wrapper around String */ public static Property<String> textTransform(@Property.TEXT_TRANSFORM String value) { return new LayoutProperty<>("text-transform", value); @@ -1231,6 +1753,9 @@ public class PropertyFactory { /** * Specifies how to capitalize text, similar to the CSS `text-transform` property. + * + * @param function a wrapper function for String + * @return property wrapper around a String function */ public static Property<Function<String>> textTransform(Function<String> function) { return new LayoutProperty<>("text-transform", function); @@ -1238,6 +1763,9 @@ public class PropertyFactory { /** * Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. + * + * @param value a Float[] value + * @return property wrapper around Float[] */ public static Property<Float[]> textOffset(Float[] value) { return new LayoutProperty<>("text-offset", value); @@ -1245,6 +1773,9 @@ public class PropertyFactory { /** * Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. + * + * @param function a wrapper function for Float[] + * @return property wrapper around a Float[] function */ public static Property<Function<Float[]>> textOffset(Function<Float[]> function) { return new LayoutProperty<>("text-offset", function); @@ -1252,6 +1783,9 @@ public class PropertyFactory { /** * If true, the text will be visible even if it collides with other previously drawn symbols. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> textAllowOverlap(Boolean value) { return new LayoutProperty<>("text-allow-overlap", value); @@ -1259,6 +1793,9 @@ public class PropertyFactory { /** * If true, the text will be visible even if it collides with other previously drawn symbols. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> textAllowOverlap(Function<Boolean> function) { return new LayoutProperty<>("text-allow-overlap", function); @@ -1266,6 +1803,9 @@ public class PropertyFactory { /** * If true, other symbols can be visible even if they collide with the text. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> textIgnorePlacement(Boolean value) { return new LayoutProperty<>("text-ignore-placement", value); @@ -1273,6 +1813,9 @@ public class PropertyFactory { /** * If true, other symbols can be visible even if they collide with the text. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> textIgnorePlacement(Function<Boolean> function) { return new LayoutProperty<>("text-ignore-placement", function); @@ -1280,6 +1823,9 @@ public class PropertyFactory { /** * If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not. + * + * @param value a Boolean value + * @return property wrapper around Boolean */ public static Property<Boolean> textOptional(Boolean value) { return new LayoutProperty<>("text-optional", value); @@ -1287,6 +1833,9 @@ public class PropertyFactory { /** * If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not. + * + * @param function a wrapper function for Boolean + * @return property wrapper around a Boolean function */ public static Property<Function<Boolean>> textOptional(Function<Boolean> function) { return new LayoutProperty<>("text-optional", function); diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/property_factory.java.ejs b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/property_factory.java.ejs index c7424bc31e..8508a735e6 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/property_factory.java.ejs +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/property_factory.java.ejs @@ -11,19 +11,25 @@ import android.support.annotation.ColorInt; /** * Constructs paint/layout properties for Layers * - * @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#layers>Layer style documentation</a> + * @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#layers">Layer style documentation</a> */ public class PropertyFactory { /** - * Set visibility + * Set the property visibility. + * + * @param value the visibility value + * @return property wrapper around visibility */ public static Property<String> visibility(@Property.VISIBILITY String value) { return new LayoutProperty<>("visibility", value); } /** - * Set visibility + * Set the property visibility. + * + * @param function the visibility function + * @return property wrapper around a String function */ public static Property<Function<String>> visibility(Function<String> function) { return new LayoutProperty<>("visibility", function); @@ -33,6 +39,9 @@ public class PropertyFactory { <% if (property.type == 'color') { -%> /** * <%- property.doc %> + * + * @param value a int color value + * @return property wrapper around String color */ public static Property<String> <%- camelizeWithLeadingLowercase(property.name) %>(@ColorInt int value) { return new PaintProperty<>("<%- property.name %>", colorToRgbaString(value)); @@ -41,6 +50,9 @@ public class PropertyFactory { <% } -%> /** * <%- property.doc %> + * + * @param value a <%- propertyType(property) %> value + * @return property wrapper around <%- propertyType(property) %> */ public static Property<<%- propertyType(property) %>> <%- camelizeWithLeadingLowercase(property.name) %>(<%- propertyTypeAnnotation(property) %><%- iff(() => propertyTypeAnnotation(property), " ") %><%- propertyType(property) %> value) { return new PaintProperty<>("<%- property.name %>", value); @@ -48,6 +60,9 @@ public class PropertyFactory { /** * <%- property.doc %> + * + * @param function a wrapper function for <%- propertyType(property) %> + * @return property wrapper around a <%- propertyType(property) %> function */ public static Property<Function<<%- propertyType(property) %>>> <%- camelizeWithLeadingLowercase(property.name) %>(Function<<%- propertyType(property) %>> function) { return new PaintProperty<>("<%- property.name %>", function); @@ -57,6 +72,9 @@ public class PropertyFactory { <% for (const property of layoutProperties) { -%> /** * <%- property.doc %> + * + * @param value a <%- propertyType(property) %> value + * @return property wrapper around <%- propertyType(property) %> */ public static Property<<%- propertyType(property) %>> <%- camelizeWithLeadingLowercase(property.name) %>(<%- propertyTypeAnnotation(property) %><%- iff(() => propertyTypeAnnotation(property), " ") %><%- propertyType(property) %> value) { return new LayoutProperty<>("<%- property.name %>", value); @@ -64,6 +82,9 @@ public class PropertyFactory { /** * <%- property.doc %> + * + * @param function a wrapper function for <%- propertyType(property) %> + * @return property wrapper around a <%- propertyType(property) %> function */ public static Property<Function<<%- propertyType(property) %>>> <%- camelizeWithLeadingLowercase(property.name) %>(Function<<%- propertyType(property) %>> function) { return new LayoutProperty<>("<%- property.name %>", function); diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ColorUtils.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ColorUtils.java index ef404840e8..190e0b9b8f 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ColorUtils.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/ColorUtils.java @@ -98,8 +98,10 @@ public class ColorUtils { } /** - * Convert an rgba string to a Color int + * Convert an rgba string to a Color int. * + * @param value the String representation of rgba + * @return the int representation of rgba * @throws ConversionException on illegal input */ @ColorInt |