Skip to content

Commit eea54af

Browse files
committed
Prepare release - update README
1 parent 4783368 commit eea54af

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Maven Central](https://img.shields.io/maven-central/v/net.tascalate.javaflow/net.tascalate.javaflow.parent.svg)](https://search.maven.org/artifact/net.tascalate.javaflow/net.tascalate.javaflow.parent/2.6.1/pom) [![GitHub release](https://img.shields.io/github/release/vsilaev/tascalate-javaflow.svg)](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.6.1) [![license](https://img.shields.io/github/license/vsilaev/tascalate-javaflow.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
1+
[![Maven Central](https://img.shields.io/maven-central/v/net.tascalate.javaflow/net.tascalate.javaflow.parent.svg)](https://search.maven.org/artifact/net.tascalate.javaflow/net.tascalate.javaflow.parent/2.6.2/pom) [![GitHub release](https://img.shields.io/github/release/vsilaev/tascalate-javaflow.svg)](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.6.2) [![license](https://img.shields.io/github/license/vsilaev/tascalate-javaflow.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
22

33
# IMPORTANT NOTICE FOR RELEASE 2.5.0!!!
44
Java 9+ is fully supported now, all artefacts are modular multi-release JAR-s that works correctly with Java versions 1.6 to 11. The library code was tested with JDK 11, and all features of the Java 11 bytecode (including nest of inner classes) works correctly.
@@ -29,7 +29,7 @@ You have to add the following configuration to enable build-time instrumentation
2929
<dependency>
3030
<groupId>net.tascalate.javaflow</groupId>
3131
<artifactId>net.tascalate.javaflow.api</artifactId>
32-
<version>2.6.1</version>
32+
<version>2.6.2</version>
3333
</dependency>
3434
<!-- Add-on for Java 8 and above -->
3535
<dependency>
@@ -54,7 +54,7 @@ You have to add the following configuration to enable build-time instrumentation
5454
<plugin>
5555
<groupId>net.tascalate.javaflow</groupId>
5656
<artifactId>net.tascalate.javaflow.tools.maven</artifactId>
57-
<version>2.6.1</version>
57+
<version>2.6.2</version>
5858
<executions>
5959
<execution>
6060
<phase>process-classes</phase>
@@ -67,7 +67,7 @@ You have to add the following configuration to enable build-time instrumentation
6767
</plugins>
6868
</build>
6969
```
70-
Note that if you are using continuations with Java 1.8 lambdas then you need to add [Tascalate JavaFlow instrumentation agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.1/javaflow.instrument-continuations.jar) at run-time as command-line option, while lambda-related classes are generated by JVM on the fly and there is no other way to instrument them. If this is not an option, then you can de-sugar all lambdas with [RetroLambda](https://github.com/luontola/retrolambda) Maven plugin at build-time (RetroLambda output is supported by Tascalate JavaFlow 2.3.2 or higher).
70+
Note that if you are using continuations with Java 1.8 lambdas then you need to add [Tascalate JavaFlow instrumentation agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.2/javaflow.instrument-continuations.jar) at run-time as command-line option, while lambda-related classes are generated by JVM on the fly and there is no other way to instrument them. If this is not an option, then you can de-sugar all lambdas with [RetroLambda](https://github.com/luontola/retrolambda) Maven plugin at build-time (RetroLambda output is supported by Tascalate JavaFlow 2.3.2 or higher).
7171

7272
Please refer to [pom.xml](https://github.com/vsilaev/tascalate-javaflow-examples/blob/master/net.tascalate.javaflow.examples.common/pom.xml) in examples project for typical Maven configuration
7373

@@ -96,7 +96,7 @@ It's possibe to instrument compiled Java classes as below:
9696
You may download a complete [examples project setup](https://github.com/vsilaev/tascalate-javaflow-examples/releases/download/1.0.0/tascalate-javaflow-ant-project-setup1.zip) from [the latest release](https://github.com/vsilaev/tascalate-javaflow-examples/releases/tag/1.0.0) for complete configuration template. Please pay attention to <code>ant-lib</code> folder with Ant TaskDef and <code>lib</code> folders with compile-/runtime-dependencies.
9797

9898
# Java Instrumentation Agent (Runt-time Instrumentation)
99-
As an alternative to compile-time bytecode instrumentation, you MAY use [Tascalate JavaFlow Instrumentation Agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.1/javaflow.instrument-continuations.jar) from [the latest release](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.6.1) to enable continuations support at class-loading time. Please note, that if you are using Java 8 and creating continuable lambda functions (either anonymous or/and as method references), and you don't replace them with tools like [RetroLambda](https://github.com/luontola/retrolambda) as mentioned above, then you SHOULD use this instrumentation agent always: as long as Java run-time generates implementation of functional interfaces on the fly there is no other option to instrument them. To enable Tascalate JavaFlow Instrumentation Agent please add the following arguments to Java command line:
99+
As an alternative to compile-time bytecode instrumentation, you MAY use [Tascalate JavaFlow Instrumentation Agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.2/javaflow.instrument-continuations.jar) from [the latest release](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.6.2) to enable continuations support at class-loading time. Please note, that if you are using Java 8 and creating continuable lambda functions (either anonymous or/and as method references), and you don't replace them with tools like [RetroLambda](https://github.com/luontola/retrolambda) as mentioned above, then you SHOULD use this instrumentation agent always: as long as Java run-time generates implementation of functional interfaces on the fly there is no other option to instrument them. To enable Tascalate JavaFlow Instrumentation Agent please add the following arguments to Java command line:
100100
```bash
101101
java -javaagent:<path-to-jar>/javaflow.instrument-continuations.jar <rest-of arguments>
102102
```
@@ -105,15 +105,15 @@ The agent JAR file includes all necessary dependencies and requires no additiona
105105
Another useful application of the instrumentation agent is to apply it for debugging code within your IDE of choice. Just specify the "-javaagent" option listed above in your IDE debug/run configuration and you will be able to perform quick "debug-fix" loops without executing full project rebuild.
106106

107107
# Command-line tools
108-
It's possible to use a stand-alone command-line utility [JavaFlowRewriteJar.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.1/JavaFlowRewriteJar.jar) to instrument JAR archives containing continuable classes. Please use the following command:
108+
It's possible to use a stand-alone command-line utility [JavaFlowRewriteJar.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.2/JavaFlowRewriteJar.jar) to instrument JAR archives containing continuable classes. Please use the following command:
109109

110110
```bash
111111
java -jar JavaFlowRewriteJar.jar src1.jar dst1.jar src2.jar dst2.jar...
112112
```
113113
Note, that the source and the destination should be different files.
114114

115115
# CDI Support
116-
To work correctly in CDI environment continuable methods should be advised only by continuation-aware CDI proxies (interceptors, scope proxies, etc). Obviously, generation of these proxies is out of our control. Plus, major CDI containers (JBoss Weld and Apache OpenWebBeans) generates such proxies dynamically at run-time. Therefore if you plan to use Tascalate JavaFlow continuations with managed beans' methods then it's necessary to instrument CDI-specific proxies with [javaflow.instrument-cdi-proxy.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.1/javaflow.instrument-cdi-proxy.jar) Java Agent:
116+
To work correctly in CDI environment continuable methods should be advised only by continuation-aware CDI proxies (interceptors, scope proxies, etc). Obviously, generation of these proxies is out of our control. Plus, major CDI containers (JBoss Weld and Apache OpenWebBeans) generates such proxies dynamically at run-time. Therefore if you plan to use Tascalate JavaFlow continuations with managed beans' methods then it's necessary to instrument CDI-specific proxies with [javaflow.instrument-cdi-proxy.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.2/javaflow.instrument-cdi-proxy.jar) Java Agent:
117117
```bash
118118
java -javaagent:<path-to-jar>/javaflow.instrument-cdi-proxy.jar <rest-of arguments>
119119
```
@@ -123,7 +123,7 @@ Please note, that CDI-specific agent neither requires javaflow.instrument-contin
123123
-javaagent:<path-to-jar>/javaflow.instrument-cdi-proxy.jar \
124124
<rest-of arguments>
125125
```
126-
CDI functionality is tested with JBoss Weld 2.x - 3.1.1 and Apache OpenWebBeans 1.6.x - 2.0.10. Contribution for other CDI/CDI-like containers (Spring, Google Guice, etc) is welcome.
126+
CDI functionality is tested with JBoss Weld 2.x - 3.1.1 and Apache OpenWebBeans 1.6.x - 2.0.23. Contribution for other CDI/CDI-like containers (Spring, Google Guice, etc) is welcome.
127127

128128
# More documentation & exmaples
129129
Examples of the library usage may be found in the [Tascalate JavaFlow Examples](https://github.com/vsilaev/tascalate-javaflow-examples) project. The covered topics are common tasks, inheritance, lambdas support, proxies, usage with CDI containers like JBoss Weld and Apache OpenWebBeans.

0 commit comments

Comments
 (0)