Package diegosneves.github.conectardoacoes.core.domain.shelter.entity.value

Class Address

java.lang.Object

diegosneves.github.conectardoacoes.core.domain.shelter.entity.value.Address

public class Address
extends Object

Classe Address representa um endereço físico.

Um endereço é composto pelo id, rua, número, bairro, cidade, estado e CEP (código postal). Cada um destes campos é uma string e é validado no momento da criação de um objeto Address. Se um destes campos estiver faltando ou em branco, uma exceção AddressCreationFailureException será lançada.

Este classe é utilizada na criação de entidades tais como Shelter, que precisam de uma representação de endereço.

Since:

1.0.0

Author:

diegoneves

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CEP_ERROR_MESSAGE
private final String	city
static final String	CITY_NAME_ERROR_MESSAGE
private final String	id
static final String	INVALID_ID_MESSAGE
private final String	neighborhood
static final String	NEIGHBORHOOD_NAME_ERROR_MESSAGE
private final String	number
static final String	RESIDENCE_NUMBER_ERROR_MESSAGE
private final String	state
static final String	STATE_NAME_ERROR_MESSAGE
private final String	street
static final String	STREET_NAME_ERROR_MESSAGE
private final String	zip

Constructor Summary

Constructors

Constructor	Description
Address(String id, String street, String number, String neighborhood, String city, String state, String zip)	Construtor para a classe Address.

Method Summary

Modifier and Type	Method	Description
private void	validateData()	Método sem retorno que valida os campos de um endereço.
private void	validateData(String value, String errorMessage)	Método sem retorno que valida uma string representando um campo de um endereço.

Methods inherited from class java.lang.Object

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

Field Details

STREET_NAME_ERROR_MESSAGE

public static final String STREET_NAME_ERROR_MESSAGE

See Also:

• Constant Field Values

RESIDENCE_NUMBER_ERROR_MESSAGE

public static final String RESIDENCE_NUMBER_ERROR_MESSAGE

See Also:

• Constant Field Values

NEIGHBORHOOD_NAME_ERROR_MESSAGE

public static final String NEIGHBORHOOD_NAME_ERROR_MESSAGE

See Also:

• Constant Field Values

CITY_NAME_ERROR_MESSAGE

public static final String CITY_NAME_ERROR_MESSAGE

See Also:

• Constant Field Values

STATE_NAME_ERROR_MESSAGE

public static final String STATE_NAME_ERROR_MESSAGE

See Also:

• Constant Field Values

CEP_ERROR_MESSAGE

public static final String CEP_ERROR_MESSAGE

See Also:

• Constant Field Values

INVALID_ID_MESSAGE

public static final String INVALID_ID_MESSAGE

See Also:

• Constant Field Values

id

private final String id

street

private final String street

number

private final String number

neighborhood

private final String neighborhood

city

private final String city

state

private final String state

zip

private final String zip

Constructor Details

Address

public Address(String id,
 String street,
 String number,
 String neighborhood,
 String city,
 String state,
 String zip)

Construtor para a classe Address. Cada um dos parâmetros é usado para definir os detalhes de um endereço.

Parameters:

id - A string que representa o UUID do endereço.

street - A string que representa a rua do endereço.

number - A string que representa o número da residência no endereço.

neighborhood - A string que representa o bairro do endereço.

city - A string que representa a cidade do endereço.

state - A string que representa o estado do endereço.

zip - A string que representa o código postal do endereço.

Throws:

AddressCreationFailureException - Se qualquer um dos parâmetros estiver nulo ou em branco.

Utiliza o método validateData() para garantir que cada campo fornecido é válido. Isso é feito através da verificação de que cada campo não seja nulo nem em branco. Se algum campo for inválido, será lançada uma exceção AddressCreationFailureException específica para aquele campo.

Method Details

validateData

private void validateData()

Método sem retorno que valida os campos de um endereço.

Este método examina cada campo (rua, número, bairro, cidade, estado e CEP) e chama um segundo método de validação passando o valor atual do campo e uma mensagem de erro específica para aquele campo.

Se algum dos campos estiver nulo ou em branco, ele lançará a exceção AddressCreationFailureException com a mensagem de erro específica para aquele campo.

validateData

private void validateData(String value,
 String errorMessage)
                   throws AddressCreationFailureException

Método sem retorno que valida uma string representando um campo de um endereço.

Parameters:

value - A String contendo o valor atual do campo do endereço.

errorMessage - A String contendo a mensagem de erro a ser usada se a validação falhar.

Este método verifica se o valor passado é nulo ou está em branco. Se o valor estiver nulo ou em branco, ele lançará a exceção `AddressCreationFailureException` com a mensagem de erro passada.

Throws:

AddressCreationFailureException - Se value estiver nulo ou em branco.