From 3564075e7fe7eeb073782167b9d8178253a80454 Mon Sep 17 00:00:00 2001 From: Sheldan <5037282+Sheldan@users.noreply.github.com> Date: Tue, 13 Jul 2021 01:13:58 +0200 Subject: [PATCH] [AB-xxx] fixing javadoc build --- .../model/database/AssignableRolePlace.java | 5 -- .../AssignableRoleManagementService.java | 27 --------- .../AssignableRolePlaceManagementService.java | 58 ------------------- 3 files changed, 90 deletions(-) diff --git a/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/model/database/AssignableRolePlace.java b/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/model/database/AssignableRolePlace.java index 2ed964d69..ec231ec21 100644 --- a/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/model/database/AssignableRolePlace.java +++ b/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/model/database/AssignableRolePlace.java @@ -10,11 +10,6 @@ import java.time.Instant; import java.util.ArrayList; import java.util.List; -/** - * The place entity holding the {@link AssignableRole roles} and {@link AssignableRolePlacePost posts} together. - * This is also the entity holding all the configuration for the place and is identified by a key as a String, which is unique - * for each server. This place holds the {@link AChannel} in which the - */ @Entity @Table(name = "assignable_role_place") @Builder diff --git a/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRoleManagementService.java b/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRoleManagementService.java index fe7b37b04..daad5da49 100644 --- a/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRoleManagementService.java +++ b/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRoleManagementService.java @@ -3,40 +3,13 @@ package dev.sheldan.abstracto.assignableroles.service.management; import dev.sheldan.abstracto.assignableroles.model.database.AssignableRole; import dev.sheldan.abstracto.assignableroles.model.database.AssignableRolePlace; import dev.sheldan.abstracto.core.models.FullEmote; -import dev.sheldan.abstracto.core.models.cache.CachedEmote; -import dev.sheldan.abstracto.core.models.database.AEmote; -import dev.sheldan.abstracto.core.models.database.ARole; import dev.sheldan.abstracto.core.models.database.ComponentPayload; import net.dv8tion.jda.api.entities.Role; -/** - * Management service for the table of {@link AssignableRole assignableRoles} - */ public interface AssignableRoleManagementService { - /** - * Adds the given {@link ARole role} to the {@link AssignableRolePlace place} to be identified with the given {@link AEmote emote} - * and displayed with the given description. An optional {@link AssignableRolePlacePost post} can be provided, if the - * place has already been setup. - * @param emote The {@link AEmote emote} which is used as an reaction on the {@link AssignableRolePlacePost post} - * @param role The {@link ARole role} which should be given to the {@link dev.sheldan.abstracto.core.models.database.AUserInAServer user} placing a reaction - * @param description The description which should be displayed in the field for the given {@link ARole role} - * @return The created instance of the {@link AssignableRole assignableRole} according to the given parameters - */ AssignableRole addRoleToPlace(FullEmote emote, Role role, String description, AssignableRolePlace place, ComponentPayload componentPayload); - /** - * Finds the {@link AssignableRole} given by the ID and returns it if found. Throws an exception otherwise. - * @param assignableRoleId The ID Of the {@link AssignableRole assignableRole} to find - * @return An instance of {@link AssignableRole assignableRole} if it exists for the given ID - */ AssignableRole getByAssignableRoleId(Long assignableRoleId); void deleteAssignableRole(AssignableRole assignableRole); - /** - * Returns the respective {@link AssignableRole assignableRole} for the {@link CachedEmote emote} which is part of the - * {@link AssignableRolePlace place}. It will throw an exception, if the {@link CachedEmote emote} is not used. - * @param cachedEmote The {@link CachedEmote emote} which should be used to identify the {@link AssignableRole role} - * @param assignableRolePlace The {@link AssignableRolePlace place} from which the {@link AssignableRole role} should be retrieved for - * @return An instance of {@link AssignableRole role} which was in the place and identified by the emote - */ } diff --git a/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRolePlaceManagementService.java b/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRolePlaceManagementService.java index 053c97dc3..116f3776d 100644 --- a/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRolePlaceManagementService.java +++ b/abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/service/management/AssignableRolePlaceManagementService.java @@ -7,82 +7,24 @@ import dev.sheldan.abstracto.core.models.database.AServer; import java.util.List; import java.util.Optional; -/** - * Management service for {@link AssignableRolePlace place} table - */ public interface AssignableRolePlaceManagementService { - /** - * Creates an {@link AssignableRolePlace place} with the given attributes - * @param name The key of the {@link AssignableRolePlace place} to identify it with - * @param channel The {@link AChannel channel} in which the {@link dev.sheldan.abstracto.assignableroles.model.database.AssignableRolePlacePost posts} - * should be created in - * @param text The text which should be shown in the description - * @return The {@link AssignableRolePlace place} which was created - */ AssignableRolePlace createPlace(String name, AChannel channel, String text); - /** - * Whether or not a place with the key exists in the given {@link AServer server} - * @param server The {@link AServer server} in which it should be searched - * @param name The key of an {@link AssignableRolePlace place} which should be searched - * @return Whether or not an {@link AssignableRolePlace place} with the key exists in the {@link AServer server} - */ boolean doesPlaceExist(AServer server, String name); - /** - * Retrieves an {@link AssignableRolePlace place} identified by the given key in the {@link AServer server} - * @param server The {@link AServer server} to search in - * @param name The key of the {@link AssignableRolePlace place} to search for - * @throws dev.sheldan.abstracto.assignableroles.exception.AssignableRolePlaceNotFoundException if not found - * @return Returns an instance of {@link AssignableRolePlace place}, if it was found - */ AssignableRolePlace findByServerAndKey(AServer server, String name); - /** - * Retrieves an {@link AssignableRolePlace place} via its ID in an {@link Optional optional} - * @param id The ID to search for - * @return Returns an {@link Optional optional} with an instance of {@link AssignableRolePlace place}, if it was found - * and empty otherwise - */ Optional findByPlaceIdOptional(Long id); - /** - * Retrieves an {@link AssignableRolePlace place} via its ID - * @param id The ID to search for - * @throws dev.sheldan.abstracto.assignableroles.exception.AssignableRolePlaceNotFoundException if not found - * @return Returns an {@link AssignableRolePlace place} if one was found with this ID - */ AssignableRolePlace findByPlaceId(Long id); - /** - * Changes the {@link AChannel channel} in which a {@link AssignableRolePlace place} should be posted towards - * when being setup. - * @param name The key of the {@link AssignableRolePlace place} to move - * @param newChannel The new {@link AChannel channel} where the place should be moved to, used to determine in which {@link AServer server} - * the {@link AssignableRolePlace place} is - */ void moveAssignableRolePlace(String name, AChannel newChannel); - /** - * Changes the {@link AssignableRolePlace#text description} of an assignable role place - * @param server The {@link AServer server} in which to look for the place - * @param name The key of the {@link AssignableRolePlace place} to change the descripiont for - * @param newDescription The description value which should be used from now on - */ void changeAssignableRolePlaceDescription(AServer server, String name, String newDescription); - /** - * Deletes the {@link AssignableRolePlace place} - * @param place The {@link AssignableRolePlace place} to remove - */ void deleteAssignablePlace(AssignableRolePlace place); - /** - * Retrieves all {@link AssignableRolePlace assignableRolePlaces} for the given {@link AServer server} - * @param server The {@link AServer server} for whom the places should be retrieved for - * @return All {@link AssignableRolePlace assignableRolePlaces} in the given {@link AServer server} - */ List findAllByServer(AServer server); }