spring-boot-enum

A set of rules for Java enum values, which represent a fixed set of choices such as an order state or user status. It covers their names, API text format, database storage, and handling of unknown values.

In plain words
What is it for?
Use it when adding domain choices, sending them in API or message data, reading them from outside services, or storing them in a database.
Why use it?
It prevents choice values from changing meaning between the API, application code, database, and external services. Stable names also reduce problems for clients that store or compare these values.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/lsampaioweb/ai-instructions/spring-boot-enum
Clone the repo
git clone --depth 1 https://github.com/lsampaioweb/ai-instructions

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 476 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00476
Opus 5 $0.00000 $0.00238
Sonnet 5 $0.00000 $0.00095
Haiku 4.5 $0.00000 $0.00048

Measured 2d ago against content hash 285e6853d2dd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

spring-boot-enum scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/spring-boot-enum.mdc · 34 lines

How it starts

The opening of the file, as written. The whole thing — 34 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Spring Boot Enum

Naming Conventions

  • Use the *Enum suffix for all enum class names (e.g., UserStatusEnum, OrderStateEnum).
  • Include the domain context as a prefix in every enum class name (e.g., UserStatusEnum, not StatusEnum).
  • Use domain-specific enum names (never TypeEnum, StatusEnum, or other generic names without a domain prefix).

Rules

  • Keep enum values stable after public release.
  • Treat adding a new enum value to a public API contract as a potentially breaking change for strict consumers.
  • Document new enum value additions in the API changelog.
  • Keep enum names expressive and domain-specific.
  • Keep enum-to-string behavior explicit when used in contracts.
  • Serialize enums as their name() string value in all API and message contracts (not ordinal).
  • Apply @JsonValue only when the serialized API value must differ from the Java constant name.
  • Declare a @JsonCreator factory method on enums used in API request bodies to control string-to-enum deserialization.
  • Add an UNKNOWN fallback constant annotated with @JsonEnumDefaultValue when the enum is sourced from an external API or message broker that may introduce new values.
  • Store application-owned enum domains in relational persistence through a dedicated lookup/reference table plus a foreign-key column in the business table.
  • Keep a stable code column in the lookup/reference table for mapping between the Java enum name() and the relational row.
  • Store enum values as strings in relational persistence only when the enum is external-system-owned, transient, or the user explicitly rejects a lookup/reference table design.
  • Declare enum constructor parameters as private and their backing fields as final.
  • Keep helper methods deterministic and side-effect free.

Safety Guards

  • Never repurpose existing enum values for new semantics.
  • Never introduce contract-breaking enum changes silently.
  • Never duplicate enum meaning in string literals across code.
  • Never use ordinal-style numeric persistence to represent enum meaning directly in a business table; numeric foreign-key columns are allowed only when they reference a dedicated lookup/reference table.

Read the full file on GitHub · 34 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 34 lines · 0 tokens per session scan A 285e6853d2dd

Subscribe to this mod's changes

spring-boot-enum is a cursor rule published in the GitHub repository lsampaioweb/ai-instructions (1 stars, last pushed 9d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 476 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.