Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://plugins.jetbrains.com/docs/intellij/workspace-model-entity-declaration.html below:

Entity Declaration | IntelliJ Platform Plugin SDK

The Workspace Model allows defining types of entities.

Defining custom entities is not yet available to third-party plugins, see also Generating Entity Implementations.

Entities' declaration is still an experimental feature and can be changed at any time. While this feature is still experimental, it is important for understanding the data stored inside the Workspace Model and its relations.

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.

See Property Kinds.

interface GradleEntity : WorkspaceEntity { val test: String // Field with default value val version: Int @Default get() = 5 val description: Description // Computable field val name: String get() = description.name } data class Description( val name: String, val valid: Boolean, val modifications: Int )

See Parent-Child Relationship.

interface MavenEntity : WorkspaceEntity { val version: Int val name: String val root: VirtualFileUrl val kotlinEntities: List<@Child KotlinEntity> } interface KotlinEntity : WorkspaceEntity { val name: String val maven: MavenEntity }

See SymbolicEntityId and Symbolic References.

interface MavenEntity : WorkspaceEntityWithSymbolicId { val version: Int val name: String override val symbolicId: MavenId get() = MavenId(true, name) } interface KotlinEntity : WorkspaceEntity { val name: String val mavenId: MavenId } data class MavenId( val valid: Boolean, override val presentableName: String ) : SymbolicEntityId<MavenEntity>

Due to the limitation that a reference must be declared on both entities, there needs to be an option to declare a reference to an entity from another module. This can be done by declaring an extension property for the entity located outside the module. This property must use the WorkspaceEntity.extension() delegate to work correctly.

Example: a KotlinEntity declaring a reference to the MavenEntity located in a different module:

interface MavenEntity: WorkspaceEntity { val version: Int val name: String }

interface KotlinEntity: WorkspaceEntity { val name: String val maven: MavenEntity } val MavenEntity.kotlinEntity: @Child KotlinEntity by WorkspaceEntity.extension()

For inheritance, the supertype entity must be marked using Abstract annotation.

See PackagingElementEntity, more samples can be found in the com.intellij.platform.workspace.jps.entities package.

This feature is currently not available to third-party plugins and enabled only for the IntelliJ IDEA project itself.

After defining the entity interface, generate some code with the Generate Workspace Model Implementation action, available from the module's context menu in the Project tool window or via on the currently open file.

Entity implementations can also be generated via the Generate implementation quick-fix on the interface's name element, which is provided by inspection .

Along with generating implementations for the interfaces in the gen source folder, this action also adds the Builder interface to an entity as well as some additional methods in the file where the entity is located.

Comments surround all generated blocks:

//region generated code //endregion

Don't edit the generated code blocks. If something is wrong with the generated code, try re-executing the action.

21 August 2024

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4