org.spongepowered.api

Interface CatalogType

All Known Subinterfaces:

AccountDeletionResultType, Advancement, AdvancementTree, AdvancementType, AITaskType, ArmorType, Art, BannerPatternShape, BanType, BigMushroomType, BiomeTreeType, BiomeType, BlockPaletteType, BlockState, BlockStatistic, BlockTrait<T>, BlockType, BodyPart, BooleanTrait, BossBarColor, BossBarOverlay, BrickType, Career, ChatType, ChatVisibility, CoalType, CollisionRule, ComparatorType, CookedFish, CraftingRecipe, Criterion, Currency, DamageModifierType, DamageType, DataFormat, DataRegistration<T,I>, DataTranslator<T>, Difficulty, DimensionType, DirtType, DisguisedBlockType, DismountType, DisplaySlot, DoublePlantType, DyeColor, EnchantmentType, EnderDragonPhaseType, EntityStatistic, EntityType, EnumTrait<E>, EquipmentType, EventContextKey<T>, FireworkShape, Fish, FluidType, FormattingCodeTextSerializer, GameMode, GeneratorType, GoalType, GoldenApple, GuiId, HandPreference, HandType, HealingType, HealthModifierType, HeldEquipmentType, Hinge, HorseColor, HorseStyle, InstrumentType, IntegerTrait, InventoryArchetype, ItemStatistic, ItemType, Key<V>, LlamaVariant, LogAxis, MushroomType, NotePitch, ObjectiveDisplayMode, OcelotType, PaletteType<T>, ParrotVariant, ParticleOption<V>, ParticleType, PickupRule, PistonType, PlantType, PopulatorObject, PopulatorType, PortalAgentType, PortionType, PotionEffectType, PotionType, PrismarineType, Profession, QuartzType, QueryOperationType<T>, RabbitType, RailDirection, Recipe, RecordType, Rotation, SafeTextSerializer, SandstoneType, SandType, SelectorType, SerializationBehavior, ShapedCraftingRecipe, ShapelessCraftingRecipe, ShrubType, SkinPart, SkullType, SlabType, SmeltingRecipe, SoundCategory, SoundType, SpawnType, StairShape, Statistic, StatisticType, StoneType, StringDataFormat, StructureMode, TeleportHelperFilter, TeleportType, TextColor, TextSerializer, TileEntityType, ToolType, TransactionType, TreeType, Trigger<C>, VirtualBiomeType, Visibility, WallType, Weather, WireAttachmentType, WorldArchetype, WorldGeneratorModifier, WornEquipmentType

All Known Implementing Classes:

SkylandsWorldGeneratorModifier, TextStyle.Base, VoidWorldGeneratorModifier

public interface CatalogType

Represents a type of a dummy that can be used to identify types without using an Enum.

All implementing classes, including those not listed in the dummy specified by the CatalogedBy annotation, 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 and Description
String	getId() Gets the unique identifier of this CatalogType.
String	getName() Gets the human-readable name of this individual CatalogType.

Method Detail

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