W3WSquare (API Reference)
Class W3WSquare
Contains information about one of the squares in the what3words geocode system.
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe center of the square.Country that contains the square.The language code of the words as an ISO 639-1 2 letter code.A 3-by-3-metre square defined by the what3words geocode system.3 word address of the square, for example "///wage.mere.heap". -
Constructor Summary
ConstructorsConstructorDescriptionW3WSquare(GeoBox square, GeoCoordinates coordinates, String words, String languageCode) Creates a new instance. -
Method Summary
-
Field Details
-
square
A 3-by-3-metre square defined by the what3words geocode system.
-
coordinates
The center of the square.
-
words
3 word address of the square, for example "///wage.mere.heap".
-
languageCode
The language code of the words as an ISO 639-1 2 letter code. Each supported language has its own set of words for each of the squares in the what3words geocode system. For Bosnian-Croatian-Montenegrin-Serbian, a special code "oo" is used.
-
countryCode
Country that contains the square. Not set if the square is in an area not governed by a specific country, such as international waters, Antarctica, some uninhabited islands etc.
-
-
Constructor Details
-
W3WSquare
public W3WSquare(@NonNull GeoBox square, @NonNull GeoCoordinates coordinates, @NonNull String words, @NonNull String languageCode) Creates a new instance.
- Parameters:
square-A 3-by-3-metre square defined by the what3words geocode system.
coordinates-The center of the square.
words-3 word address of the square, for example "///wage.mere.heap".
languageCode-The language code of the words as an ISO 639-1 2 letter code. Each supported language has its own set of words for each of the squares in the what3words geocode system. For Bosnian-Croatian-Montenegrin-Serbian, a special code "oo" is used.
-
-
Method Details