summaryrefslogtreecommitdiff
path: root/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java
diff options
context:
space:
mode:
authorIvo van Dongen <info@ivovandongen.nl>2016-10-04 14:26:04 +0200
committerIvo van Dongen <ivovandongen@users.noreply.github.com>2016-10-05 12:15:15 +0200
commitdd7713f6ee55a15b4ec5228a46a13c184dfdc01f (patch)
treedcd6afde3062995c25e7cdf5ab964a7b48103f9c /platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java
parent93166aef482ea5835d87231f88d369449398ccdf (diff)
downloadqtlocation-mapboxgl-dd7713f6ee55a15b4ec5228a46a13c184dfdc01f.tar.gz
[android] javadoc - inter-link style properties properly
Diffstat (limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java')
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java20
1 files changed, 18 insertions, 2 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java
index 58ffa12e35..0856b117dc 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/Source.java
@@ -1,7 +1,5 @@
package com.mapbox.mapboxsdk.style.sources;
-import java.util.HashMap;
-
/**
* Base Peer class for sources. see source.hpp for the other half of the peer.
*/
@@ -9,6 +7,11 @@ public abstract class Source {
private long nativePtr;
private boolean invalidated;
+ /**
+ * Internal use
+ *
+ * @param nativePtr - pointer to native peer
+ */
public Source(long nativePtr) {
this.nativePtr = nativePtr;
}
@@ -16,11 +19,21 @@ public abstract class Source {
public Source() {
}
+ /**
+ * Retrieve the source id
+ *
+ * @return the source id
+ */
public String getId() {
checkValidity();
return nativeGetId();
}
+ /**
+ * Internal use
+ *
+ * @return the native peer pointer
+ */
public long getNativePtr() {
return nativePtr;
}
@@ -33,6 +46,9 @@ public abstract class Source {
}
}
+ /**
+ * Internal use - invalidates the source for further use (after adding it to the map)
+ */
public final void invalidate() {
this.invalidated = true;
}