w3w java wrapper

w3w-java-wrapper

Una biblioteca Java para usar la API What3Words V3.

Los métodos API se agrupan en un solo objeto de servicio que puede ser administrado de forma centralizada mediante una instancia What3WordSV3. Actuará como una fábrica para todos los puntos finales de API y los inicializará automáticamente con su clave API.

Para obtener una clave API, visite https://what3words.com/select-plan y regístrese para obtener una cuenta.

Instalación

El artefacto está disponible a través de Maven Central.

Aturdir

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

Graduarse

Implementación 'com.what3words: w3w-java-wrapper: 3.1.19'

Documentación

Vea la documentación de la API pública What3words

Uso general

 // 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 ());

    }
}

Métodos API

• Convertir a una dirección de 3 palabras: convierta una latitud y longitud a una dirección de 3 palabras
• Convertir en coordenadas: convierta una dirección de 3 palabras en latitud y longitud
• AutoSuggest: AutoSuggest puede tomar una dirección de 3 palabras ligeramente incorrecta y sugerir una lista de direcciones válidas de 3 palabras.
• Sección de cuadrícula: devuelve una sección de la cuadrícula de 3m x 3m What3words para un cuadro delimitador.
• Idiomas disponibles: recupera una lista todos los idiomas de dirección de 3 palabras disponibles.
• Es válida dirección de 3 palabras: verifica si una dirección What3words es válida.

Funciones auxiliares

ispossible3wa

Compruebe si una cadena es una posible dirección What3words. Un recordatorio de que esto solo verifica el formato del texto, por lo tanto, por qué se llama posible3WA, para verificar si es una dirección real de What3words, por favor, usar es una dirección válida de 3 palabras.

 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

Compruebe si una cadena es una posible dirección What3words, esta regex permite diferentes separadores (es decir: no usar parada/punto completa estándar). Un recordatorio de que esto solo verifica el formato del texto, por lo tanto, por qué se llama didYouMean3wa, para verificar si es una dirección real de What3words, por favor, use es válida dirección de 3 palabras usando una parada completa como un separador.

 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

Obtenga cualquier posible dirección de What3Words de un texto. Devolverá una lista vacía si no se encuentran direcciones posibles. Recordatorio de que esto solo verifica el formato del texto, por lo tanto, por qué se llama FindPossible3WA, para verificar si es una dirección real de What3Words, por favor, use es válida dirección de 3 palabras para verificar cada elemento de la lista.

 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 []