Package com.griefdefender.api.claim

Interface ClaimGroup.Builder

Enclosing interface:
ClaimGroup
public static interface ClaimGroup.Builder

  • Method Details

    • getUniqueId

      UUID getUniqueId()
      Gets the UUID associated with group.

      Note: The uuid is the identifier used in permissions.
      Returns:
      The claim group uuid

    • getName

      String getName()
      Gets the claim group name
      Returns:
      The claim group name

    • getDescription

      @Nullable net.kyori.adventure.text.Component getDescription()
      Gets the claim group description Component.
      Returns:
      The claim group description, if available

    • getDateCreated

      Instant getDateCreated()
      Gets the creation date of claim group.
      Returns:
      The claim group creation date

    • getType

      ClaimGroupType getType()
      Gets the ClaimGroupType.
      Returns:
      The claim group type

    • getSyncMode

      ClaimGroupSyncMode getSyncMode()
      Gets the ClaimGroupSyncMode.
      Returns:
      The claim group sync mode

    • getUserUniqueId

      @Nullable UUID getUserUniqueId()
      Gets the user uuid this is associated with if any.
      Returns:
      The user uuid, if available

    • uuid

      ClaimGroup.Builder uuid(UUID uuid)
      Sets the ClaimGroup's UUID. Note: If not set, a new uuid will be generated.
      Parameters:
      uuid - The uuid to set
      Returns:
      The builder

    • user

      ClaimGroup.Builder user(UUID userUniqueId)
      Sets the
      invalid reference 
      User
      's UUID to assign this group to.

      Note: This is only required if type is ClaimGroupTypes.USER.
      Parameters:
      userUniqueId - The user uuid
      Returns:
      The builder

    • description

      ClaimGroup.Builder description(net.kyori.adventure.text.Component description)
      The Component description of claim group.
      Parameters:
      description - The description
      Returns:
      The claim group description

    • dateCreated

      ClaimGroup.Builder dateCreated(Instant dateCreated)
      The claim group creation date. Note: If not set, date will be set on build.
      Parameters:
      dateCreated - The claim group creation date
      Returns:
      The builder

    • name

      ClaimGroup.Builder name(String name)
      Sets the claim group name.
      Parameters:
      name - The claim group name
      Returns:
      The builder

    • syncMode

      ClaimGroup.Builder syncMode(ClaimGroupSyncMode mode)
      Sets the ClaimGroupSyncMode.
      Parameters:
      mode - The claim group sync mode.
      Returns:
      The builder

    • type

      ClaimGroup.Builder type(ClaimGroupType type)
      Sets the ClaimGroupType.
      Parameters:
      type - The claim group type
      Returns:
      The builder

    • reset

      ClaimGroup.Builder reset()
      Resets the builder to default settings.
      Returns:
      The builder

    • build

      ClaimGroup build()
      Returns the ClaimGroup.
      Returns:
      The claim group