IntelliJ Platform Plugin SDK
 
IntelliJ Platform Explorer

Entity Declaration

Edit pageLast modified: 21 August 2024

The Workspace Model allows defining types of entities.

To declare an entity type, a Kotlin interface has to be created, which directly or indirectly extends WorkspaceEntity. The entity interface must contain read-only properties only.

A nested Builder interface with setters for these properties, and a companion object which allows creating instances of the entity are generated automatically along with the implementations (see Generating Entity Implementations). The platform currently provides some predefined types of entities (see entities package), but they're supposed to be used only for interoperability with code which uses the project model API.

Plugins should define and use their own types of entities if they need to store framework-specific data.