Skip to content

Commit 20b08d3

Browse files
cescoffiercescoffier
committed
Apply new formatting rules to the messaging API
Signed-off-by: Clement Escoffier <[email protected]>
1 parent b04f256 commit 20b08d3

File tree

4 files changed

+98
-98
lines changed

4 files changed

+98
-98
lines changed

‎messaging/api/src/main/java/org/eclipse/microprofile/reactive/messaging/Incoming.java

+30-30
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@
3030
* Methods annotated with this annotation must have one of the following shapes:
3131
* <p>
3232
* <ul>
33-
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.SubscriberBuilder}.</li>
34-
* <li>Take zero parameters, and return a {@link org.reactivestreams.Subscriber}.</li>
35-
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.ProcessorBuilder}.</li>
36-
* <li>Take zero parameters, and return a {@link org.reactivestreams.Processor}.</li>
37-
* <li>Accept a single parameter, and return a {@link java.util.concurrent.CompletionStage}.</li>
38-
* <li>Accept a single parameter, and return void.</li>
39-
* <li>Accept a single parameter, and return any type.</li>
33+
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.SubscriberBuilder}.</li>
34+
* <li>Take zero parameters, and return a {@link org.reactivestreams.Subscriber}.</li>
35+
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.ProcessorBuilder}.</li>
36+
* <li>Take zero parameters, and return a {@link org.reactivestreams.Processor}.</li>
37+
* <li>Accept a single parameter, and return a {@link java.util.concurrent.CompletionStage}.</li>
38+
* <li>Accept a single parameter, and return void.</li>
39+
* <li>Accept a single parameter, and return any type.</li>
4040
* </ul>
4141
* <p>
4242
* In addition, implementations of this specification may allow returning additional types, such as implementation
@@ -80,28 +80,28 @@
8080
@Retention(RetentionPolicy.RUNTIME)
8181
public @interface Incoming {
8282

83-
/**
84-
* The topic to subscribe to.
85-
* <p>
86-
* If not set, it is assumed some other messaging provider specific mechanism will be used to identify which
87-
* messages this subscriber will receive.
88-
*/
89-
String topic() default "";
83+
/**
84+
* The topic to subscribe to.
85+
* <p>
86+
* If not set, it is assumed some other messaging provider specific mechanism will be used to identify which
87+
* messages this subscriber will receive.
88+
*/
89+
String topic() default "";
9090

91-
/**
92-
* The messaging provider.
93-
* <p>
94-
* If not set, then the container may provide a container specific mechanism for selecting a default messaging
95-
* provider.
96-
* <p>
97-
* Note that not all messaging providers are compatible with all containers, it is up to each container to
98-
* decide which messaging providers it will accept, to define the messaging provider classes to pass here, and
99-
* to potentially offer a container specific extension point for plugging in new containers.
100-
* <p>
101-
* If the container does not support the selected messaging provider, it must raise a deployment exception before
102-
* the container is initialized.
103-
* <p>
104-
* The use of this property is inherently non portable.
105-
*/
106-
Class<? extends MessagingProvider> provider() default MessagingProvider.class;
91+
/**
92+
* The messaging provider.
93+
* <p>
94+
* If not set, then the container may provide a container specific mechanism for selecting a default messaging
95+
* provider.
96+
* <p>
97+
* Note that not all messaging providers are compatible with all containers, it is up to each container to
98+
* decide which messaging providers it will accept, to define the messaging provider classes to pass here, and
99+
* to potentially offer a container specific extension point for plugging in new containers.
100+
* <p>
101+
* If the container does not support the selected messaging provider, it must raise a deployment exception before
102+
* the container is initialized.
103+
* <p>
104+
* The use of this property is inherently non portable.
105+
*/
106+
Class<? extends MessagingProvider> provider() default MessagingProvider.class;
107107
}

‎messaging/api/src/main/java/org/eclipse/microprofile/reactive/messaging/Message.java

+38-38
Original file line numberDiff line numberDiff line change
@@ -33,46 +33,46 @@
3333
*/
3434
public interface Message<T> {
3535

36-
/**
37-
* The payload for this message.
38-
*/
39-
T getPayload();
36+
/**
37+
* Create a message with the given payload.
38+
*
39+
* @param payload The payload.
40+
* @return A message with the given payload, and a no-op ack function.
41+
*/
42+
static <T> Message<T> of(T payload) {
43+
return () -> payload;
44+
}
4045

41-
/**
42-
* Acknowledge this message.
43-
*/
44-
default CompletionStage<Void> ack() {
45-
return CompletableFuture.completedFuture(null);
46-
}
46+
/**
47+
* Create a message with the given payload and ack function.
48+
*
49+
* @param payload The payload.
50+
* @param ack The ack function, this will be invoked when the returned messages {@link #ack()} method is invoked.
51+
* @return A message with the given payload and ack function.
52+
*/
53+
static <T> Message<T> of(T payload, Supplier<CompletionStage<Void>> ack) {
54+
return new Message<T>() {
55+
@Override
56+
public T getPayload() {
57+
return payload;
58+
}
4759

48-
/**
49-
* Create a message with the given payload.
50-
*
51-
* @param payload The payload.
52-
* @return A message with the given payload, and a no-op ack function.
53-
*/
54-
static <T> Message<T> of(T payload) {
55-
return () -> payload;
56-
}
60+
@Override
61+
public CompletionStage<Void> ack() {
62+
return ack.get();
63+
}
64+
};
65+
}
5766

58-
/**
59-
* Create a message with the given payload and ack function.
60-
*
61-
* @param payload The payload.
62-
* @param ack The ack function, this will be invoked when the returned messages {@link #ack()} method is invoked.
63-
* @return A message with the given payload and ack function.
64-
*/
65-
static <T> Message<T> of(T payload, Supplier<CompletionStage<Void>> ack) {
66-
return new Message<T>() {
67-
@Override
68-
public T getPayload() {
69-
return payload;
70-
}
67+
/**
68+
* The payload for this message.
69+
*/
70+
T getPayload();
7171

72-
@Override
73-
public CompletionStage<Void> ack() {
74-
return ack.get();
75-
}
76-
};
77-
}
72+
/**
73+
* Acknowledge this message.
74+
*/
75+
default CompletionStage<Void> ack() {
76+
return CompletableFuture.completedFuture(null);
77+
}
7878
}

‎messaging/api/src/main/java/org/eclipse/microprofile/reactive/messaging/Outgoing.java

+29-29
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@
3030
* Methods annotated with this annotation must have one of the following shapes:
3131
* <p>
3232
* <ul>
33-
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.PublisherBuilder}.</li>
34-
* <li>Take zero parameters, and return a {@link org.reactivestreams.Publisher}.</li>
35-
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.ProcessorBuilder}.</li>
36-
* <li>Take zero parameters, and return a {@link org.reactivestreams.Processor}.</li>
37-
* <li>Accept a single parameter, and return a {@link java.util.concurrent.CompletionStage}.</li>
38-
* <li>Accept a single parameter, and return any type.</li>
33+
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.PublisherBuilder}.</li>
34+
* <li>Take zero parameters, and return a {@link org.reactivestreams.Publisher}.</li>
35+
* <li>Take zero parameters, and return a {@link org.eclipse.microprofile.reactive.streams.ProcessorBuilder}.</li>
36+
* <li>Take zero parameters, and return a {@link org.reactivestreams.Processor}.</li>
37+
* <li>Accept a single parameter, and return a {@link java.util.concurrent.CompletionStage}.</li>
38+
* <li>Accept a single parameter, and return any type.</li>
3939
* </ul>
4040
* <p>
4141
* In addition, implementations of this specification may allow returning additional types, such as implementation
@@ -64,28 +64,28 @@
6464
@Retention(RetentionPolicy.RUNTIME)
6565
public @interface Outgoing {
6666

67-
/**
68-
* The topic to publish to.
69-
* <p>
70-
* If not set, it is assumed some other messaging provider specific mechanism will be used to identify the
71-
* destination that this publisher will send to.
72-
*/
73-
String topic() default "";
67+
/**
68+
* The topic to publish to.
69+
* <p>
70+
* If not set, it is assumed some other messaging provider specific mechanism will be used to identify the
71+
* destination that this publisher will send to.
72+
*/
73+
String topic() default "";
7474

75-
/**
76-
* The messaging provider.
77-
* <p>
78-
* If not set, then the container may provide a container specific mechanism for selecting a default messaging
79-
* provider.
80-
* <p>
81-
* Note that not all messaging providers are compatible with all containers, it is up to each container to
82-
* decide which messaging providers it will accept, to define the messaging provider classes to pass here, and
83-
* to potentially offer a container specific extension point for plugging in new containers.
84-
* <p>
85-
* If the container does not support the selected messaging provider, it must raise a deployment exception before
86-
* the container is initialized.
87-
* <p>
88-
* The use of this property is inherently non portable.
89-
*/
90-
Class<? extends MessagingProvider> provider() default MessagingProvider.class;
75+
/**
76+
* The messaging provider.
77+
* <p>
78+
* If not set, then the container may provide a container specific mechanism for selecting a default messaging
79+
* provider.
80+
* <p>
81+
* Note that not all messaging providers are compatible with all containers, it is up to each container to
82+
* decide which messaging providers it will accept, to define the messaging provider classes to pass here, and
83+
* to potentially offer a container specific extension point for plugging in new containers.
84+
* <p>
85+
* If the container does not support the selected messaging provider, it must raise a deployment exception before
86+
* the container is initialized.
87+
* <p>
88+
* The use of this property is inherently non portable.
89+
*/
90+
Class<? extends MessagingProvider> provider() default MessagingProvider.class;
9191
}

‎messaging/api/src/main/java/org/eclipse/microprofile/reactive/messaging/package-info.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@
5353
* }
5454
* </pre>
5555
*/
56-
package org.eclipse.microprofile.reactive.messaging;
56+
package org.eclipse.microprofile.reactive.messaging;

0 commit comments

Comments
 (0)