com.github.gilbertotorrezan.viacep.server

Class ViaCEPClient

java.lang.Object

com.github.gilbertotorrezan.viacep.server.ViaCEPClient

public class ViaCEPClient
extends Object

Classe de acesso aos web services da ViaCEP para Java SE e Android. Utiliza Jackson-jr para a serialização de JSON para objetos Java.

Since:

v.1.0.0

Author:

Gilberto Torrezan Filho

See Also:

https://github.com/FasterXML/jackson-jr, http://viacep.com.br

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.jr.ob.JSON	service
protected boolean	usingHTTPS

Constructor Summary

Constructors

Constructor and Description
ViaCEPClient() Construtor padrão.
ViaCEPClient(com.fasterxml.jackson.jr.ob.JSON service) Construtor que permite que seja setado um JSON customizado.

Method Summary

Methods

Modifier and Type	Method and Description
ViaCEPEndereco	getEndereco(String cep) Executa a consulta de endereço a partir de um CEP.
List<ViaCEPEndereco>	getEnderecos(String uf, String localidade, String logradouro) Executa a consulta de endereços a partir da UF, localidade e logradouro
protected String	getHost() Método interno que retorna o host dos webservices da ViaCEP.
com.fasterxml.jackson.jr.ob.JSON	getService() Retorna o JSON utilizado na desserialização de objetos.
boolean	isUsingHTTPS() Retorna se o client está utilizando HTTP ou HTTPS para consultar os web services.
void	setService(com.fasterxml.jackson.jr.ob.JSON service) Seta um JSON customizado para a desserialização de objetos.
void	setUsingHTTPS(boolean usingHTTPS) Seta se o client deve utilizar HTTPS para consultar os web services.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

usingHTTPS

protected boolean usingHTTPS

service

protected com.fasterxml.jackson.jr.ob.JSON service

Constructor Detail

ViaCEPClient

public ViaCEPClient()

Construtor padrão.

ViaCEPClient

public ViaCEPClient(com.fasterxml.jackson.jr.ob.JSON service)

Construtor que permite que seja setado um JSON customizado.

Method Detail

getEndereco

public ViaCEPEndereco getEndereco(String cep)
                           throws IOException

Executa a consulta de endereço a partir de um CEP.

Parameters:

cep - CEP da localidade onde se quer consultar o endereço. Precisa ter 8 dígitos - a formatação é feita pelo cliente. CEPs válidos (que contém 8 dígitos): "20930-040", "abc0 1311000xy z", "20930 040". CEPs inválidos (que não contém 8 dígitos): "00000", "abc", "123456789"

Returns:

O endereço encontrado para o CEP, ou null caso não tenha sido encontrado.

Throws:

IOException - em casos de erro de conexão.

IllegalArgumentException - para CEPs que não possuam 8 dígitos.

getEnderecos

public List<ViaCEPEndereco> getEnderecos(String uf,
                                String localidade,
                                String logradouro)
                                  throws IOException

Executa a consulta de endereços a partir da UF, localidade e logradouro

Parameters:

uf - Unidade Federativa. Precisa ter 2 caracteres.

localidade - Localidade (p.e. município). Precisa ter ao menos 3 caracteres.

logradouro - Logradouro (p.e. rua, avenida, estrada). Precisa ter ao menos 3 caracteres.

Returns:

Os endereços encontrado para os dados enviados, nunca null. Caso não sejam encontrados endereços, uma lista vazia é retornada.

Throws:

IOException - em casos de erro de conexão.

IllegalArgumentException - para localidades e logradouros com tamanho menor do que 3 caracteres.

getHost

protected String getHost()

Método interno que retorna o host dos webservices da ViaCEP. Por padrão é "http://viacep.com.br/ws/".

isUsingHTTPS

public boolean isUsingHTTPS()

Retorna se o client está utilizando HTTP ou HTTPS para consultar os web services. Por padrão utiliza HTTP.

setUsingHTTPS

public void setUsingHTTPS(boolean usingHTTPS)

Seta se o client deve utilizar HTTPS para consultar os web services. Por padrão é false.

getService

public com.fasterxml.jackson.jr.ob.JSON getService()

Retorna o JSON utilizado na desserialização de objetos.

setService

public void setService(com.fasterxml.jackson.jr.ob.JSON service)

Seta um JSON customizado para a desserialização de objetos.