Class NewRoomDTO

java.lang.Object

de.gustavblass.fsu.fmi.roombooking.dto.NewRoomDTO

public class NewRoomDTO
extends Object

A data-transfer object that represents a Room to be newly added to the database.

Implementation Note:

This DTO is a class and not a record, in order to validate that the individualEquipment and commonEquipment JSON collections do not contain duplicates. If Jackson deserialised the JSON arrays into Sets, then the duplicates would be swallowed without an error. Thus, the client would not understand that its request was actually malformed.

So, instead, this is manually checked, and an exception is thrown manually.

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable Accessibility	accessibility	The Room.accessibility.
private @Nullable Map<String, IndividualEquipmentMutableDTO>	cachedIndividualEquipmentMap	Remembers the return value of getIndividualEquipmentMap() until the individualEquipment is updated.
private @NotNull @Min(1L) @Nullable Integer	capacity	The Room.capacity.
private @Nullable @Unmodifiable Set<String>	commonEquipment	The ConferenceRoom.commonEquipment.
private @NotNull @Nullable Integer	floor	The Room.floor.
private @NonNull List<IndividualEquipmentMutableDTO>	individualEquipment	The Room.equipment.
private @Nullable String	notes	The Room.notes.
private @NotNull @NotBlank @Pattern(regexp="^[0-9\\p{L}'\u2019/.,-_\\s+]+$") @Nullable String	number	The Room.number.
private @NotNull @Nullable RoomType	type	Whether the Room shall be a QuietStudyRoom or a ConferenceRoom.

Constructor Summary

Constructors

Constructor	Description
NewRoomDTO()

Method Summary

Modifier and Type	Method	Description
void	addEmptyIndividualEquipment(int size)	Adds n := size items of empty IndividualEquipmentMutableDTO to the individualEquipment.
@NonNull Set<String>	getCommonEquipment()
@NonNull List<IndividualEquipmentMutableDTO>	getIndividualEquipment()
@NonNull @Unmodifiable Map<String, IndividualEquipmentMutableDTO>	getIndividualEquipmentMap()
void	initialiseIndividualEquipment(int size)	Adds n := size items of empty IndividualEquipmentMutableDTO to the individualEquipment.
void	setCommonEquipment(@NonNull Collection<String> commonEquipment)	Updates the commonEquipment.
void	setIndividualEquipment(Collection<IndividualEquipmentMutableDTO> individualEquipment)	Updates the individualEquipment.

Methods inherited from class Object

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

Field Details

number

@NotNull
@NotBlank
@Pattern(regexp="^[0-9\\p{L}'\u2019/.,-_\\s+]+$")
@Nullable
private @NotNull @NotBlank @Pattern(regexp="^[0-9\\p{L}'\u2019/.,-_\\s+]+$") @Nullable String number

The Room.number.

type

@NotNull
@Nullable
private @NotNull @Nullable RoomType type

Whether the Room shall be a QuietStudyRoom or a ConferenceRoom.

floor

@NotNull
@Nullable
private @NotNull @Nullable Integer floor

The Room.floor.

capacity

@NotNull
@Min(1L)
@Nullable
private @NotNull @Min(1L) @Nullable Integer capacity

The Room.capacity.

individualEquipment

@NonNull
private @NonNull List<IndividualEquipmentMutableDTO> individualEquipment

The Room.equipment.

commonEquipment

@Nullable
private @Nullable @Unmodifiable Set<String> commonEquipment

The ConferenceRoom.commonEquipment. Must only be set if the type is RoomType.CONFERENCE_ROOM.

accessibility

@Nullable
private @Nullable Accessibility accessibility

The Room.accessibility.

notes

@Nullable
private @Nullable String notes

The Room.notes.

cachedIndividualEquipmentMap

@Nullable
private @Nullable Map<String, IndividualEquipmentMutableDTO> cachedIndividualEquipmentMap

Remembers the return value of getIndividualEquipmentMap() until the individualEquipment is updated.

Constructor Details

NewRoomDTO

public NewRoomDTO()

Method Details

initialiseIndividualEquipment

public void initialiseIndividualEquipment(int size)

Adds n := size items of empty IndividualEquipmentMutableDTO to the individualEquipment. (All previous elements are cleared).

Parameters:

size - The number of new elements to be added.

Implementation Note:

Clears the cachedIndividualEquipmentMap.

addEmptyIndividualEquipment

public void addEmptyIndividualEquipment(int size)

Adds n := size items of empty IndividualEquipmentMutableDTO to the individualEquipment.

Parameters:

size - The number of new elements to be added.

Implementation Note:

Clears the cachedIndividualEquipmentMap.

setIndividualEquipment

public void setIndividualEquipment(Collection<IndividualEquipmentMutableDTO> individualEquipment)
                            throws de.gustavblass.commons.exceptions.IllegalArgumentException

Updates the individualEquipment.

Parameters:

individualEquipment - The new individualEquipment. No IndividualEquipmentType must occur more than once.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - If one of the individual-equipment types occurs more than once.

Implementation Note:

Clears the cachedIndividualEquipmentMap.

setCommonEquipment

public void setCommonEquipment(@NonNull
 @NonNull Collection<String> commonEquipment)
                        throws de.gustavblass.commons.exceptions.IllegalArgumentException

Updates the commonEquipment.

Parameters:

commonEquipment - The new common equipment. No CommonEquipmentType must occur more than once.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - If one of the common-equipment types occurs more than once.

getIndividualEquipment

@NonNull
public @NonNull List<IndividualEquipmentMutableDTO> getIndividualEquipment()

Returns:

The individualEquipment.

Implementation Note:

Spring uses the reference of the individualEquipment list to fill in the actual form inputs. To the author's current knowledge, there is no alternative to this violation of good programming practices.

getIndividualEquipmentMap

@NonNull
public @NonNull @Unmodifiable Map<String, IndividualEquipmentMutableDTO> getIndividualEquipmentMap()

Returns:

The individualEquipment as a Map where the IndividualEquipmentMutableDTO.type serves as the key and the DTO itself as the value.

Implementation Note:

Returns the cachedIndividualEquipmentMap if not null.

getCommonEquipment

@Contract(pure=true)
@NonNull
public @NonNull Set<String> getCommonEquipment()

Returns:

The commonEquipment. Empty if no common equipment is defined.