https://github.com/mohamed-ashraf-bayor/jisel
Java Interface Segregation Library (min. Java 17 required)
https://github.com/mohamed-ashraf-bayor/jisel
addto annotation annotations code-generation code-generator developer-tool interface-segregation-principle isp java java-17 java17 jisel mohamed-ashraf-bayor sealed-interface sealfor software-design solid-principles toplevel
Last synced: 5 months ago
JSON representation
Java Interface Segregation Library (min. Java 17 required)
- Host: GitHub
- URL: https://github.com/mohamed-ashraf-bayor/jisel
- Owner: mohamed-ashraf-bayor
- License: mit
- Created: 2021-11-29T16:07:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T13:00:58.000Z (about 1 year ago)
- Last Synced: 2025-08-23T04:34:49.016Z (9 months ago)
- Topics: addto, annotation, annotations, code-generation, code-generator, developer-tool, interface-segregation-principle, isp, java, java-17, java17, jisel, mohamed-ashraf-bayor, sealed-interface, sealfor, software-design, solid-principles, toplevel
- Language: Java
- Homepage:
- Size: 363 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JISEL - Java Interface Segregation Library
> ### JISEL 1.2 released:
> - Added new annotations (**@UnSeal**, **@Detach** and **@DetachAll**) allowing to generate pre-java 17 "unsealed" interfaces during the Segregation process
> - Existing Annotations on top of interfaces, methods or parameters are now replicated in the generated interfaces or classes
> - Bug fixes and improvements
## Quick Overview
Code Migration to Java 17 using FROPOREC and JISEL - [https://youtu.be/iML8EjMIDLc](https://youtu.be/iML8EjMIDLc)
Integrating Jisel with Spring: Segregation of a Spring Data JPA Repository - [PDF](https://github.com/mohamed-ashraf-bayor/jisel-integration-with-spring/blob/master/Jisel_Integration_with_SpringDataJPA.pdf)
v1.2: UnSeal & Detach - [https://youtu.be/HOssFTKPQRM](https://youtu.be/HOssFTKPQRM)
v1.1 Quick Intro - [https://youtu.be/cbYdt8NRUaM](https://youtu.be/cbYdt8NRUaM)
Project's Pitch (v1.0) - [https://youtu.be/nkbu6zxV3R0](https://youtu.be/nkbu6zxV3R0)
## Installation
If you are running a Maven project, add the latest release dependency to your pom.xml
```xml
org.jisel
jisel
1.2
```
You will also need to include the same dependency as an additional annotation processor in the Maven Compiler plugin of your project
```xml
org.apache.maven.plugins
maven-compiler-plugin
${maven-compiler-plugin.version}
17
-Xlint:unchecked
org.jisel
jisel
1.2
```
For other build tools, please check: [Maven Central](https://search.maven.org/artifact/org.jisel/jisel/1.2/jar).
## Provided Annotations
### @TopLevel
- **MANDATORY** annotation, to be applied only on top of abstract methods of the large interface you intend to segregate.
- Allows you to specify methods which should be part of the top-level parent interface generated during segregation.
- As a result, a sealed interface will be generated following the naming convention:
**Sealed<LargeInterfaceSimpleName>** (**<LargeInterfaceSimpleName>** corresponds to the simplename of the interface being segregated).
- The generated sealed interface will contain all abstract methods annotated with **@TopLevel**.
- Also, any other Jisel annotation combined with **@TopLevel** on the same abstract method, will be ignored in the processing.
### @SealFor
- Annotation to be applied only on top of abstract methods of an interface you intend to segregate.
- Picked up and processed **ONLY** if at least 1 of the abstract methods of the large interface has been annotated with **@TopLevel**.
- Ignored if combined with **@TopLevel** on the same abstract method.
- Expects an array of String values corresponding to the list of profiles you want to seal the method for.
- For each one of the specified profile names, a sealed interface will be generated following the naming convention **Sealed<ProfileName><LargeInterfaceSimpleName>**(**<LargeInterfaceSimpleName>** corresponds to the simplename of the interface being segregated).
```java
public interface Sociable {
String STUDENT = "Student";
String WORKER = "Worker";
String ACTIVE_WORKER = "ActiveWorker";
@TopLevel
String startConversation() throws IllegalStateException;
@SealFor(STUDENT)
boolean attendClass(String fieldOfStudy) throws IllegalArgumentException;
@SealFor(STUDENT)
void askForHelpWhenNeeded();
@SealFor({WORKER, ACTIVE_WORKER})
boolean[] joinOfficeSocialGroups(String[] groups, int maximum);
@SealFor(ACTIVE_WORKER)
void leadOfficeSocialGroup(String groupName);
@SealFor(ACTIVE_WORKER)
double createNewOfficeSocialGroup(String groupName, List starters) throws ArithmeticException;
}
```
### @AddTo
Annotation to be applied on top of a class, interface or record, which is implementing or extending a sealed interface generated by Jisel.
Expects 2 attributes:
- **profiles**: OPTIONAL - array of String values corresponding to the list of profiles whose generated sealed interfaces are implemented by the annotated class, interface or record.
If not provided or empty, the annotated class, interface or record will be added to the permits list of the generated top-level parent sealed interface.
- **largeInterface**: **MANDATORY** - _.class_ representation of the large interface. That would be the **<LargeInterfaceSimpleName>** as seen in the sealed interface name convention, followed by "_.class_".
```java
@AddTo(profiles = {STUDENT, WORKER}, largeInterface = Sociable.class)
public final class StudentWorkerHybrid implements SealedStudentSociable, SealedWorkerSociable {
@Override
public String startConversation() throws IllegalStateException {
return null;
}
@Override
public void askForHelpWhenNeeded() {
}
@Override
public boolean attendClass(String param0) throws IllegalArgumentException {
return false;
}
@Override
public boolean[] joinOfficeSocialGroups(String[] param0, int param1) {
return new boolean[0];
}
}
```
### @UnSeal
Annotation to be applied only on top of large interfaces to segregate.
Generates a classic pre-java 17 interfaces hierarchy, which is basically the Interface Segregation Principle applied without sealing the hierarchy.
The unsealed hierarchy interfaces are generated additionally to the sealed hierarchy generated files, and stored in the created _unsealed_ sub-package. Each one of the generated interfaces follows the naming convention: ( is the simplename of the large interface being segregated).
**Note:** This annotation will not work if **@TopLevel** is NOT used anywhere within the large interface.
```java
@UnSeal
public interface Sociable {
String STUDENT = "Student";
@TopLevel
String startConversation() throws IllegalStateException;
@SealFor(STUDENT)
boolean attendClass(String fieldOfStudy) throws IllegalArgumentException;
...
}
```
### @Detach
Repeatable annotation to apply on top of a large interface being segregated.
Expects a mandatory **profile** attribute String value corresponding to one of the profiles provided using the **@SealFor** annotation.
Result will be the generation of an (unsealed) interface for the specified profile. The generated interface contains all abstract methods which have been tagged for the specified profile (through the use of **@SealFor**).
Also, as the generated interface is "detached" from the generated sealed hierarchy, no inheritance declaration clause (_extends_) is generated.
Flexibility is offered, allowing to choose a new name for the generated interface, specify which superInterfaces (along with generics) the generated interface should extend, and list qualified names of annotations (along with their attributes/values) to be added on top of the generated interface.
All generated detached interfaces are stored in the created _detached_ sub-package.
**Note:** This annotation will not work if **@TopLevel** is NOT used anywhere within the large interface, or if the specified profile is none of the ones provided though the **@SealFor** annotation.
```java
@Detach(
profile = ACTIVE_WORKER,
rename = ACTIVE_WORKER + "With2SuperInterfaces",
superInterfaces = {Processor.class, Drivable.class},
applyAnnotations = """
@java.lang.Deprecated
@java.lang.SuppressWarnings({"unchecked", "deprecation", "unused", "testing", "anotherTestValue"})
@javax.annotation.processing.SupportedOptions("")
@javax.annotation.processing.SupportedAnnotationTypes("type1")
"""
)
@Detach(profile = STUDENT, rename = "DeprecatedStudent", applyAnnotations = "@java.lang.Deprecated")
public interface Sociable {
String STUDENT = "Student";
String WORKER = "Worker";
String ACTIVE_WORKER = "ActiveWorker";
@TopLevel
String startConversation() throws IllegalStateException;
@SealFor(STUDENT)
boolean attendClass(String fieldOfStudy) throws IllegalArgumentException;
...
}
```
### @DetachAll
Annotation to apply on top of a large interface being segregated.
Result will be the generation of (unsealed) interfaces generated, each one corresponding to each profile provided through the use of the **@SealFor** annotation. Also, each generated interface contains all tagged abstract methods for each profile.
Does not provide as much flexibility as the **@Detach** annotation.
All generated detached interfaces are stored in the created _detached.all_ sub-package.
**Note:** This annotation will not work if **@TopLevel** is NOT used anywhere within the large interface.
```java
@DetachAll
public interface Sociable {
String STUDENT = "Student";
String WORKER = "Worker";
String ACTIVE_WORKER = "ActiveWorker";
@TopLevel
String startConversation() throws IllegalStateException;
@SealFor(STUDENT)
boolean attendClass(String fieldOfStudy) throws IllegalArgumentException;
...
}
```
### Sample interfaces and classes for testing
[https://github.com/mohamed-ashraf-bayor/jisel-annotation-client](https://github.com/mohamed-ashraf-bayor/jisel-annotation-client)
### Integration with Spring Framework / Spring Boot
[https://github.com/mohamed-ashraf-bayor/jisel-integration-with-spring](https://github.com/mohamed-ashraf-bayor/jisel-integration-with-spring)
### Issues, Bugs, Suggestions
Contribute to the project's growth by reporting issues or making improvement suggestions [here](https://github.com/mohamed-ashraf-bayor/jisel/issues/new/choose)