Packages
package	github

Functions
record	GameDto (Long gameid, @Nonnull @NotNull GridDto grididDto, @Nonnull @NotNull Long playerid, @Nonnull @NotNull GameLevelDto levelidDto, boolean selected, @Nonnull @NotNull Instant createdat, @Nonnull @NotNull Instant updatedat)
	Data Transfer Object representing a game entity.

record	GameLevelDto (Byte levelid, @Min(1) @Max(3) byte level)
	Data Transfer Object representing a game level entity.

record	GridDto (Long gridid, @Nonnull @NotNull @Size(max=81) String defaultgridvalue, @Nonnull @NotNull @Size(max=810) String gridvalue, @Min(0) @Max(100) byte possibilities)
	Data Transfer Object representing a grid entity.

record	MenuDto (Byte menuid, @Min(1) @Max(3) byte mode)
	Data Transfer Object representing a menu entity.

record	OptionsDto (Long optionsid, @Nonnull @NotNull @Size(min=8, max=8) String hexcolor, @Nonnull @NotNull @Size(max=260) String imagepath, @Nonnull @NotNull @Size(max=260) String songpath, boolean opaque, boolean muted)
	Data Transfer Object representing an Options entity.

record	PlayerDto (Long playerid, @Nonnull @NotNull PlayerLanguageDto playerlanguageidDto, @Nonnull @NotNull OptionsDto optionsidDto, @Nonnull @NotNull MenuDto menuidDto, @Nullable GameDto selectedGame, @Nonnull @NotNull @Size(max=256) String name, boolean selected, @Nonnull @NotNull Instant createdat, @Nonnull @NotNull Instant updatedat)
	Data Transfer Object representing a player.

record	PlayerLanguageDto (Long playerlanguageid, @Nonnull @NotNull @Pattern(regexp="^(FR\|EN)$", message="iso must be either 'FR' or 'EN'") String iso)
	Data Transfer Object representing a player's language.

record	ToastData (String visibleText, String detailedText, ToastLevels level, boolean requestFocus)
	A data transfer object representing a toast notification.

Function Documentation

◆ GameDto()

record fr.softsf.sudokufx.dto.GameDto	(	Long	gameid,
		@Nonnull @NotNull GridDto	grididDto,
		@Nonnull @NotNull Long	playerid,
		@Nonnull @NotNull GameLevelDto	levelidDto,
		boolean	selected,
		@Nonnull @NotNull Instant	createdat,
		@Nonnull @NotNull Instant	updatedat )

Data Transfer Object representing a game entity.

Parameters

gameid	the unique identifier of the game
grididDto	the associated grid data transfer object; must not be null
playerid	the identifier of the player linked to the game; must not be null
levelidDto	the associated game level data transfer object; must not be null
selected	flag indicating if the game is selected
createdat	the timestamp when the game was created; must not be null
updatedat	the timestamp when the game was last updated; must not be null

Returns a new instance with the given game ID.

Returns a new instance with the given grid DTO.

Returns a new instance with the given player ID.

Returns a new instance with the given level DTO.

Returns a new instance with the given selected flag.

Returns a new instance with the given creation timestamp.

Returns a new instance with the given update timestamp.

Here is the call graph for this function:

◆ GameLevelDto()

record fr.softsf.sudokufx.dto.GameLevelDto	(	Byte	levelid,
		@Min(1) @Max(3) byte	level )

Data Transfer Object representing a game level entity.

Parameters

levelid	the unique identifier of the game level
level	the difficulty level, constrained between 1 and 3 (inclusive)

Returns a new GameLevelDto with the specified levelid, keeping the current level.

Parameters

levelid the new levelid

Returns: a new GameLevelDto with updated levelid

Returns a new GameLevelDto with the specified level, keeping the current levelid.

Parameters

level the new level (1-3)

Returns: a new GameLevelDto with updated level

Here is the call graph for this function:

◆ GridDto()

record fr.softsf.sudokufx.dto.GridDto	(	Long	gridid,
		@Nonnull @NotNull @Size(max=81) String	defaultgridvalue,
		@Nonnull @NotNull @Size(max=810) String	gridvalue,
		@Min(0) @Max(100) byte	possibilities )

Data Transfer Object representing a grid entity.

Parameters

gridid	the unique identifier of the grid
defaultgridvalue	the default grid value string, max length 81; must not be null
gridvalue	the current grid value string, max length 810; must not be null
possibilities	the percentage of possibilities (0 to 100)

Returns a new instance with the given grid ID.

Returns a new instance with the given default grid value.

Returns a new instance with the given current grid value.

Returns a new instance with the given possibilities percentage.

Here is the call graph for this function:

◆ MenuDto()

record fr.softsf.sudokufx.dto.MenuDto	(	Byte	menuid,
		@Min(1) @Max(3) byte	mode )

Data Transfer Object representing a menu entity.

Parameters

menuid	the unique identifier of the menu
mode	the mode of the menu, must be between 1 and 3 (inclusive)

◆ OptionsDto()

record fr.softsf.sudokufx.dto.OptionsDto	(	Long	optionsid,
		@Nonnull @NotNull @Size(min=8, max=8) String	hexcolor,
		@Nonnull @NotNull @Size(max=260) String	imagepath,
		@Nonnull @NotNull @Size(max=260) String	songpath,
		boolean	opaque,
		boolean	muted )

Data Transfer Object representing an Options entity.

Parameters

optionsid	the unique identifier of the options
hexcolor	the color in hexadecimal format (e.g., FFFFFFFF), 8 characters, not null
imagepath	the file path to the image associated with the options, max 260 characters, not null
songpath	the file path to the song associated with the options, max 260 characters, not null
opaque	flag indicating if the grid's background is opaque (true) or transparent (false)
muted	flag indicating if sound is muted (true) or enabled (false)

Returns a copy of this DTO with a new optionsid.

Parameters

optionsid the new options ID

Returns: a new OptionsDto instance

Returns a copy of this DTO with a new hexcolor.

Parameters

hexcolor the new hex color

Returns: a new OptionsDto instance

Returns a copy of this DTO with a new imagepath.

Parameters

imagepath the new image path

Returns: a new OptionsDto instance

Returns a copy of this DTO with a new songpath.

Parameters

songpath the new song path

Returns: a new OptionsDto instance

Returns a copy of this DTO with a new opaque flag.

Parameters

opaque the new opaque value

Returns: a new OptionsDto instance

Returns a copy of this DTO with a new muted flag.

Parameters

muted the new muted value

Returns: a new OptionsDto instance

Here is the call graph for this function:

◆ PlayerDto()

record fr.softsf.sudokufx.dto.PlayerDto	(	Long	playerid,
		@Nonnull @NotNull PlayerLanguageDto	playerlanguageidDto,
		@Nonnull @NotNull OptionsDto	optionsidDto,
		@Nonnull @NotNull MenuDto	menuidDto,
		@Nullable GameDto	selectedGame,
		@Nonnull @NotNull @Size(max=256) String	name,
		boolean	selected,
		@Nonnull @NotNull Instant	createdat,
		@Nonnull @NotNull Instant	updatedat )

Data Transfer Object representing a player.

Parameters

playerid	the unique identifier of the player
playerlanguageidDto	the player's language data, must not be null
optionsidDto	the player's options data, must not be null
menuidDto	the menu associated with the player, must not be null
selectedGame	the currently selected game for the player, can be null
name	the player's name, must not be null and maximum length 256 characters
selected	indicates whether this player is selected
createdat	the creation timestamp, must not be null
updatedat	the last update timestamp, must not be null

Returns a new instance with the given player language.

Returns a new instance with the given options.

Returns a new instance with the given menu.

Returns a new instance with the given selected game.

Returns a new instance with the given name.

Returns a new instance with the given selected flag.

Returns a new instance with the given creation timestamp.

Returns a new instance with the given update timestamp.

Here is the call graph for this function:

◆ PlayerLanguageDto()

record fr.softsf.sudokufx.dto.PlayerLanguageDto	(	Long	playerlanguageid,
		@Nonnull @NotNull @Pattern(regexp="^(FR\|EN)$", message="iso must be either 'FR' or 'EN'") String	iso )

Data Transfer Object representing a player's language.

Parameters

playerlanguageid	the unique identifier of the player language
iso	the ISO code; must be "FR" or "EN" and not null

◆ ToastData()

record fr.softsf.sudokufx.dto.ToastData	(	String	visibleText,
		String	detailedText,
		ToastLevels	level,
		boolean	requestFocus )

A data transfer object representing a toast notification.

Packages

Functions

Function Documentation

◆ GameDto()

◆ GameLevelDto()

◆ GridDto()

◆ MenuDto()

◆ OptionsDto()

◆ PlayerDto()

◆ PlayerLanguageDto()

◆ ToastData()