Package cn.lunadeer.dominion.api.dtos

Interface GroupDTO

public interface GroupDTO

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Boolean
    getAdmin()
    获取权限组是否为管理员组
    @NotNull Integer
    getDomID()
    获取权限组所属领地 ID
    @NotNull Map<PreFlag,Boolean>
    getFlagsValue()
    获取权限组所有权限配置
    @NotNull Boolean
    getFlagValue(@NotNull PreFlag flag)
    获取权限组某个权限配置
    @NotNull Integer
    getId()
    获取权限组 ID
    List<MemberDTO>
    getMembers()
    获取权限组所有成员
    @NotNull String
    getNameColoredBukkit()
    获取权限组名称（带颜色） Bukkit类型
    @NotNull net.kyori.adventure.text.Component
    getNameColoredComponent()
    获取权限组名称（带颜色） kyori.adventure.text.Component 类型
    @NotNull String
    getNamePlain()
    获取权限组名称（普通字符，不含颜色代码） 绝大多数情况下应该使用该方法获取权限组名称
    @NotNull String
    getNameRaw()
    获取权限组名称（原始字符，包含颜色代码）
    @Nullable GroupDTO
    setAdmin(@NotNull Boolean admin)
    设置权限组是否为管理员组，设置成功后返回权限组对象，设置失败返回null
    @Nullable GroupDTO
    setFlagValue(@NotNull PreFlag flag, @NotNull Boolean value)
    设置权限组某个权限配置，设置成功后返回权限组对象，设置失败返回null
    @Nullable GroupDTO
    setName(@NotNull String name)
    设置权限组名称，可以包含颜色代码，设置成功后返回权限组对象，设置失败返回null

  • Method Details

    • getId

      @NotNull @NotNull Integer getId()
      获取权限组 ID
      Returns:
      权限组 ID

    • getDomID

      @NotNull @NotNull Integer getDomID()
      获取权限组所属领地 ID
      Returns:
      权限组所属领地 ID

    • setName

      @Nullable @Nullable GroupDTO setName(@NotNull @NotNull String name)
      设置权限组名称，可以包含颜色代码，设置成功后返回权限组对象，设置失败返回null
      Parameters:
      name - 权限组名称
      Returns:
      权限组对象

    • getNamePlain

      @NotNull @NotNull String getNamePlain()
      获取权限组名称（普通字符，不含颜色代码） 绝大多数情况下应该使用该方法获取权限组名称
      Returns:
      权限组名称

    • getNameRaw

      @NotNull @NotNull String getNameRaw()
      获取权限组名称（原始字符，包含颜色代码）
      Returns:
      权限组名称

    • getNameColoredComponent

      @NotNull @NotNull net.kyori.adventure.text.Component getNameColoredComponent()
      获取权限组名称（带颜色） kyori.adventure.text.Component 类型
      Returns:
      权限组名称（带颜色）

    • getNameColoredBukkit

      @NotNull @NotNull String getNameColoredBukkit()
      获取权限组名称（带颜色） Bukkit类型
      Returns:
      权限组名称（带颜色）

    • setAdmin

      @Nullable @Nullable GroupDTO setAdmin(@NotNull @NotNull Boolean admin)
      设置权限组是否为管理员组，设置成功后返回权限组对象，设置失败返回null
      Parameters:
      admin - 是否为管理员组
      Returns:
      权限组对象

    • getAdmin

      @NotNull @NotNull Boolean getAdmin()
      获取权限组是否为管理员组
      Returns:
      是否为管理员组

    • getFlagValue

      @NotNull @NotNull Boolean getFlagValue(@NotNull @NotNull PreFlag flag)
      获取权限组某个权限配置
      Parameters:
      flag - 权限
      Returns:
      权限配置值，如果权限不存在则返回默认值

    • getFlagsValue

      @NotNull @NotNull Map<PreFlag,Boolean> getFlagsValue()
      获取权限组所有权限配置
      Returns:
      权限配置

    • setFlagValue

      @Nullable @Nullable GroupDTO setFlagValue(@NotNull @NotNull PreFlag flag, @NotNull @NotNull Boolean value)
      设置权限组某个权限配置，设置成功后返回权限组对象，设置失败返回null
      Parameters:
      flag - 权限
      value - 权限值
      Returns:
      权限组对象

    • getMembers

      List<MemberDTO> getMembers()
      获取权限组所有成员
      Returns:
      成员列表