Interface EquipmentTypeMapper

public interface EquipmentTypeMapper

Converts EquipmentTypeDTO to EquipmentType objects.

Method Summary

Modifier and Type	Method	Description
default @NonNull EquipmentType	createEquipmentType(@NonNull EquipmentTypeDTO dto)	Constructs a new EquipmentType based on the given EquipmentTypeDTO.type.
default @NonNull EquipmentTypeDTO	createEquipmentTypeDTO(@NonNull EquipmentType dto)	Constructs a new EquipmentTypeDTO representing the given EquipmentType.
EquipmentType	fromDto(EquipmentTypeDTO dto)	Creates a proper EquipmentType object from the given data-transfer object.
default @NonNull String	resolveType(@NonNull EquipmentType equipmentType)	Returns the CODE of the given EquipmentType.
EquipmentTypeDTO	toDto(EquipmentType equipmentType)	Converts the given EquipmentType to a data-transfer object.

Method Details

toDto

EquipmentTypeDTO toDto(EquipmentType equipmentType)
                throws de.gustavblass.commons.exceptions.IllegalArgumentException

Converts the given EquipmentType to a data-transfer object.

Parameters:

equipmentType - The object which a new DTO shall be created from.

Returns:

The object constructed from the given object.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - See createEquipmentType(EquipmentTypeDTO).

fromDto

EquipmentType fromDto(EquipmentTypeDTO dto)
               throws InvalidEquipmentException

Creates a proper EquipmentType object from the given data-transfer object.

Parameters:

dto - The data-transfer object to be converted.

Returns:

The EquipmentType created from the DTO.

Throws:

InvalidEquipmentException - If the EquipmentTypeDTO.type is invalid.

createEquipmentTypeDTO

@NonNull
default @NonNull EquipmentTypeDTO createEquipmentTypeDTO(@NonNull
 @NonNull EquipmentType dto)
                                                  throws de.gustavblass.commons.exceptions.IllegalArgumentException

Constructs a new EquipmentTypeDTO representing the given EquipmentType.

Parameters:

dto - The object that shall be converted to a data-transfer object.

Returns:

The DTO.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - See resolveType(EquipmentType).

resolveType

@NonNull
default @NonNull String resolveType(@NonNull
 @NonNull EquipmentType equipmentType)
                             throws de.gustavblass.commons.exceptions.IllegalArgumentException

Returns the CODE of the given EquipmentType.

Parameters:

equipmentType - The EquipmentType whose code shall be returned.

Returns:

IndividualEquipmentType.CODE if the given EquipmentType is an IndividualEquipmentType or CommonEquipmentType.CODE if it's a CommonEquipmentType.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - If the EquipmentType is neither individual nor common equipment.

createEquipmentType

@NonNull
default @NonNull EquipmentType createEquipmentType(@NonNull
 @NonNull EquipmentTypeDTO dto)
                                            throws InvalidEquipmentException

Constructs a new EquipmentType based on the given EquipmentTypeDTO.type. Does not initialise any fields of the newly created object.

Parameters:

dto - The data-transfer object which an empty EquipmentType object shall be created from.

Returns:

An empty EquipmentType object of the class matching the DTO's type.

Throws:

InvalidEquipmentException - If the type is invalid.