# coherence-idea-plugin

**Repository Path**: mirrors_oracle/coherence-idea-plugin

## Basic Information

- **Project Name**: coherence-idea-plugin
- **Description**: This plugin adds features to IntelliJ to assist in development of applications using Oracle Coherence.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-29
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--

  Copyright (c) 2020, 2021 Oracle and/or its affiliates.

  Licensed under the Universal Permissive License v 1.0 as shown at
  https://oss.oracle.com/licenses/upl.

-->

-----
<img src=https://oracle.github.io/coherence/assets/images/logo-red.png><img>

# Coherence IntelliJ Plugin

![Build](https://github.com/oracle/coherence-idea-plugin/workflows/Build/badge.svg)
[![Version](https://img.shields.io/jetbrains/plugin/v/com.oracle.coherence.coherence-idea.svg)](https://plugins.jetbrains.com/plugin/com.oracle.coherence.coherence-idea)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/com.oracle.coherence.coherence-idea.svg)](https://plugins.jetbrains.com/plugin/com.oracle.coherence.coherence-idea)
[![License](http://img.shields.io/badge/license-UPL%201.0-blue.svg)](https://oss.oracle.com/licenses/upl/)

<!-- Plugin description -->
This plugin adds features to IntelliJ to assist in development of applications using Oracle Coherence.

Features:

* POF code generation for suitably annotated classes.

## Installation

- Using IDE built-in plugin system:
  
  <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "coherence-idea"</kbd> >
  <kbd>Install Plugin</kbd>
  
- Manually:

  Download the [latest release](https://github.com/oracle/coherence-idea-plugin/releases/latest) and install it manually using
  <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>

## Usage

> For full documentation on the Coherence POF code generator and using PortableType annotations
> see the official [Portable Types documentation](https://coherence.community/20.12/docs/#/docs/core/04_portable_types)

The POF code generator plugin uses the Coherence POF code generator to instrument classes tha have been annotated with
the corresponding POF annotations. The plugin is a build service plugin that will instrument classes as part of the
IntelliJ build process.

The plugin itself does not contain a `coherence.jar` or the POF code generator, it 
will use the code generator built into the version of Coherence that the current project depends on. 
This means that there is no need to upgrade the IntelliJ plugin for different versions of Coherence. 

The POF plugin is disabled by default and must be enabled for each IntelliJ project.
Once enabled, evolvable PortableType code will be generated for suitably annotated classes as part of 
the IntelliJ build process.

* Open the IntelliJ preference pane and go to the Oracle Coherence panel under Languages & Frameworks,
  
  <kbd>Preferences</kbd> > <kbd>Languages & Frameworks</kbd> > <kbd>Oracle Coherence</kbd>

* Check the `Enable POF code generation` check box.  
                            

<!-- Plugin description end -->

---
This plugin has been created using the 
[IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template)

## Contributing

This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)

## Security

Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process

## License

Copyright (c) 2020, 2024, Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at
<https://oss.oracle.com/licenses/upl/>.