Package com.griefdefender.api

Interface CatalogType

All Known Subinterfaces:
ApplyType, ChatType, ClaimAttribute, ClaimGroupSyncMode, ClaimGroupType, ClaimSnapshotType, ClaimType, ClaimVisualType, Clan, CreateModeType, Flag, FlagDefinition, GameModeType, IconFlag, Option<T>, OptionDefinition, PermissionDefinition, ResultType, ShovelType, TrustResultType, TrustType, WeatherType
public interface CatalogType
Represents a type of a dummy that can be used to identify types without using an Enum.

All implementing classes must meet the requirement that if any of `a.equals(b)`, `a == b`, or `a.getId().equalsIgnoreCase(b.getId())` are true then all must be true.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Gets the unique identifier of this CatalogType.
    String
    getName()
    Gets the human-readable name of this individual CatalogType.

  • Method Details

    • getId

      String getId()
      Gets the unique identifier of this CatalogType. The identifier is case insensitive, thus there cannot be another instance with a different character case. The id of this instance must remain the same for the entire duration of its existence. The identifier can be formatted however needed.

      A typical id format follows the pattern of `modId:name` or `minecraft:name`. However the prefix may be omitted for default/vanilla minecraft types.

      Returns:
      The unique identifier of this dummy type

    • getName

      String getName()
      Gets the human-readable name of this individual CatalogType. This name is not guaranteed to be unique. This value should not be used for serialization.
      Returns:
      The human-readable name of this dummy type