w3w java wrapper

W3W-Java-Wrapper

Eine Java -Bibliothek zur Verwendung der What3Words V3 API.

API -Methoden werden in ein einzelnes Dienstobjekt zusammengefasst, das von einer What3Wordsv3 -Instanz zentral verwaltet werden kann. Es wird als Fabrik für alle API -Endpunkte dienen und sie automatisch mit Ihrem API -Schlüssel initialisieren.

Um einen API-Schlüssel zu erhalten, besuchen Sie bitte https://what3words.com/select-plan und melden Sie sich für ein Konto an.

Installation

Das Artefakt ist über Maven Central erhältlich.

Maven

< dependency >
  < groupId >com.what3words</ groupId >
  < artifactId >w3w-java-wrapper</ artifactId >
  < version >3.1.19</ version >
</ dependency >

Gradle

Implementierung 'com.what3words: W3W-Java-Wrapper: 3.1.19'

Dokumentation

Siehe die öffentliche API -Dokumentation von What3words

Allgemeine Verwendung

 // For all requests a what3words API key is needed
What3WordsV3 api = new What3WordsV3 ( "what3words-api-key" );

// In the case that you run our Enterprise Suite API Server yourself, you may specify the URL to your own server like so:
//What3WordsV3 api = new What3WordsV3("what3words-api-key", "https://api.yourserver.com/v3/");

/**
 * Additionally, if you run the Enterprise Suite API Server there is another optional setup() parameter: customHeaders. 
 * Use this if you need to send custom headers to your own server:
 */
//Map<String, String> headers = new HashMap<String, String>();
//headers.put("Name1", "Value1");
//headers.put("Name2", "Value2");
//What3WordsV3 api = new What3WordsV3("what3words-api-key", "https://api.yourserver.com/v3/", headers);

// Create and execute a request with the 3 word address such as "filled.count.soap"
ConvertToCoordinates coordinates = api . convertToCoordinates ( "filled.count.soap" ). execute ();

if ( coordinates . isSuccessful ()) { // the request was successful
    System . out . println ( "Coordinates: " + coordinates );

} else { // the request was not successful
    What3WordsError error = coordinates . getError ();

    if ( error == What3WordsError . BAD_WORDS ) { // The three word address provided is invalid
        System . out . println ( "BadWords: " + error . getMessage ());

    } else if ( error == What3WordsError . INTERNAL_SERVER_ERROR ) { // Server Error
        System . out . println ( "InternalServerError: " + error . getMessage ());

    } else if ( error == What3WordsError . NETWORK_ERROR ) { // Network Error
        System . out . println ( "NetworkError: " + error . getMessage ());

    } else { // Unknown Error
        System . out . println ( error + ": " + error . getMessage ());

    }
}

API -Methoden

• Konvertieren Sie in 3 Wortadresse - Konvertieren Sie einen Breitengrad und eine Länge in eine 3 -Wort -Adresse
• In Koordinaten konvertieren - eine 3 -Wort -Adresse in einen Breitengrad und Längengrad konvertieren
• Autosugst - Autosugst kann eine etwas falsche 3 -Wörter -Adresse annehmen und eine Liste gültiger 3 -Wörter -Adressen vorschlagen.
• Gitterabschnitt - Gibt einen Abschnitt des 3M x 3M What3Words Grid für ein Begrenzungsfeld zurück.
• Verfügbare Sprachen - Ruft eine Liste alle verfügbaren 3 -Wort -Adresssprachen ab.
• Ist gültig 3 Word -Adresse - Überprüft, ob eine What3Words -Adresse gültig ist.

Helferfunktionen

ISPossible3WA

Überprüfen Sie, ob eine Zeichenfolge eine mögliche What3Words -Adresse ist. Eine Erinnerung daran, dass dies nur das Format des Textes überprüft. Warum heißt er Social3WA, um zu überprüfen, ob es sich um eine echte What3Words -Adresse handelt. Bitte ist eine gültige 3 -Word -Adresse.

 Boolean isPossible = What3WordsV3 . isPossible3wa ( "filled.count.soap" ); // returns true
Boolean isPossible = What3WordsV3 . isPossible3wa ( "not a 3wa" ); // returns false
Boolean isPossible = What3WordsV3 . isPossible3wa ( "not.3wa address" ); //returns false

didyoumean3wa

Überprüfen Sie, ob eine Zeichenfolge eine mögliche What3Words -Adresse ist. Dieser Regex ermöglicht unterschiedliche Separatoren (dh keine Standard -Full -Stopp/DOT). Eine Erinnerung daran, dass dies nur das Format des Textes überprüft. Warum heißt Didyoumean3wa, um zu überprüfen, ob es sich um eine echte What3Words -Adresse handelt, die verwendet werden. Bitte ist eine gültige 3 -Wort -Adresse mit Full Stop als Trennzeichen.

 Boolean isDym = What3WordsV3 . didYouMean3wa ( "filled-count-soap" ); // returns true
Boolean isDym = What3WordsV3 . didYouMean3wa ( "not valid" ); // returns false
Boolean isDym = What3WordsV3 . didYouMean3wa ( "not.3wa address" ); // returns false
Boolean isDym = What3WordsV3 . didYouMean3wa ( "not.threewa address" ); // returns true

findPossible3wa

Holen Sie sich alle möglichen What3Words -Adressen aus einem Text. Gibt eine leere Liste zurück, wenn keine möglichen Adressen gefunden werden. Die Erinnerung daran, dass dies nur das Format des Textes überprüft. Warum heißt FindPossible3WA, um zu überprüfen, ob es sich um eine echte What3Words -Adresse handelt, die bitte gültig ist, um jedes Element der Liste zu überprüfen.

 List < String > possible = What3WordsV3 . findPossible3wa ( "Please leave by my porch at filled.count.soap" ); //returns ["filled.count.soap"]
List < String > possible = What3WordsV3 . findPossible3wa ( "Please leave by my porch at filled.count.soap or deed.tulip.judge" ); // returns ["filled.count.soap", "deed.tulip.judge"]
List < String > possible = What3WordsV3 . findPossible3wa ( "Please leave by my porch at" ); // returns []