Prepare M4 release

* Bump reactor-core to 3.1.0.RC1
* Update README to show reactor kafka 1.0.0.M4
* Fix some javadoc errors

README.md

@@ -50,7 +50,7 @@ With Gradle from repo.spring.io:
 
     dependencies {
       //compile "io.projectreactor.kafka:reactor-kafka:1.0.0.BUILD-SNAPSHOT"
-      compile "io.projectreactor.kafka:reactor-kafka:1.0.0.M3"
+      compile "io.projectreactor.kafka:reactor-kafka:1.0.0.M4"
     }
 ```
 

build.gradle

@@ -34,7 +34,7 @@ ext {
 
   kafkaVersion = '0.11.0.0'
   scalaVersion = '2.11'
-  reactorVersion = '3.1.0.BUILD-SNAPSHOT'
+  reactorVersion = '3.1.0.RC1'
   metricsVersion = '2.2.0'
 
   argparseVersion = '0.5.0'
@@ -46,7 +46,7 @@ ext {
   powermockVersion = '1.6.4'
 
   javadocLinks = ["http://docs.oracle.com/javase/8/docs/api/",
-                  "https://kafka.apache.org/0102/javadoc",
+                  "https://kafka.apache.org/0110/javadoc/",
                   "http://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/",
                   "http://projectreactor.io/docs/core/release/api/"] as String[]
 

reactor-kafka-samples/src/main/java/reactor/kafka/samples/SampleScenarios.java

@@ -79,7 +79,7 @@ public class SampleScenarios {
         "sample-topic3"
     };
 
-    enum Scenario {
+    protected enum Scenario {
         KAFKA_SINK,
         KAFKA_SINK_CHAIN,
         KAFKA_SOURCE,

reactor-kafka-tools/src/main/java/reactor/kafka/tools/perf/ThroughputThrottler.java

@@ -78,7 +78,7 @@ public ThroughputThrottler(long targetThroughput, long startMs) {
      * @param amountSoFar bytes produced so far if you want to throttle data throughput, or
      *                    messages produced so far if you want to throttle message throughput.
      * @param sendStartMs timestamp of the most recently sent message
-     * @return
+     * @return the boolean that denotes if throttling is needed.
      */
     public boolean shouldThrottle(long amountSoFar, long sendStartMs) {
         if (this.targetThroughput < 0) {

src/main/java/reactor/kafka/sender/KafkaSender.java

@@ -101,15 +101,15 @@ public static <K, V> KafkaSender<K, V> create(SenderOptions<K, V> options) {
      * @return Flux of Kafka producer response record metadata along with the corresponding request correlation metadata.
      *         Each inner Flux contains results of records sent within a transaction.
      * @throws IllegalStateException if the sender was created without setting a non-empty
-     *         {@value ProducerConfig#TRANSACTIONAL_ID_CONFIG} in {@link SenderOptions}
+     *         {@value org.apache.kafka.clients.producer.ProducerConfig#TRANSACTIONAL_ID_CONFIG} in {@link SenderOptions}
      */
     <T> Flux<Flux<SenderResult<T>>> sendTransactionally(Publisher<? extends Publisher<? extends SenderRecord<K, V, T>>> records);
 
     /**
      * Returns the {@link TransactionManager} instance associated with this sender,
      * which may be used for fine-grained control over transaction states. Sender
      * must have been created with a non-empty transactional id by setting
-     * {@value ProducerConfig#TRANSACTIONAL_ID_CONFIG} in {@link SenderOptions}.
+     * {@value org.apache.kafka.clients.producer.ProducerConfig#TRANSACTIONAL_ID_CONFIG} in {@link SenderOptions}.
      *
      * <p>
      * <b>Threading model for transactional sender:</b>
@@ -121,14 +121,14 @@ public static <K, V> KafkaSender<K, V> create(SenderOptions<K, V> options) {
      *
      * @return {@link TransactionManager} associated with this sender
      * @throws IllegalStateException if the sender was created without setting a non-empty
-     *         {@value ProducerConfig#TRANSACTIONAL_ID_CONFIG} in {@link SenderOptions}
+     *         {@value org.apache.kafka.clients.producer.ProducerConfig#TRANSACTIONAL_ID_CONFIG} in {@link SenderOptions}
      */
     TransactionManager transactionManager();
 
     /**
      * Creates a reactive gateway for outgoing Kafka records. Outgoing sends can be chained
      * using {@link KafkaOutbound#send(Publisher)} or {@link KafkaSender#sendTransactionally(Publisher)}.
-     * Like {@link Flux} and {@link Mono}, subscribing to the tail {@link SenderOutbound} will
+     * Like {@link Flux} and {@link Mono}, subscribing to the tail {@link KafkaOutbound} will
      * schedule all parent sends in the declaration order.
      *
      * <p>

src/main/java/reactor/kafka/sender/TransactionManager.java

@@ -73,7 +73,7 @@ public interface TransactionManager {
      * this scheduler. This scheduler is configured using {@link SenderOptions#scheduler(Scheduler)}
      * and it must be single threaded.
      *
-     * @return
+     * @return the scheduler associated with this transaction instance.
      */
     Scheduler scheduler();