1 /*
2 * *************************************************************************************************************************************************************
3 *
4 * TheseFoolishThings: Miscellaneous utilities
5 * http://tidalwave.it/projects/thesefoolishthings
6 *
7 * Copyright (C) 2009 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
8 *
9 * *************************************************************************************************************************************************************
10 *
11 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18 *
19 * *************************************************************************************************************************************************************
20 *
21 * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22 * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23 *
24 * *************************************************************************************************************************************************************
25 */
26 package it.tidalwave.actor;
27
28 import javax.annotation.Nonnull;
29 import lombok.Getter;
30 import lombok.RequiredArgsConstructor;
31 import lombok.ToString;
32
33 /***************************************************************************************************************************************************************
34 *
35 * This role should be injected into a message to decorated it at the moment of sending. This technique is experimental
36 * and represents the function of a Decorator Pattern in a message-oriented design.
37 *
38 * @stereotype Role
39 *
40 * @author Fabrizio Giudici
41 *
42 **************************************************************************************************************************************************************/
43 public interface MessageDecorator
44 {
45 public static final Class<MessageDecorator> _MessageDecorator_ = MessageDecorator.class;
46
47 /***********************************************************************************************************************************************************
48 * A default implementation of {@code MessageDecorator} which returns the same message.
49 **********************************************************************************************************************************************************/
50 @Getter @RequiredArgsConstructor @ToString
51 public static class Same<T extends MessageSupport> implements MessageDecorator
52 {
53 @Nonnull
54 private final T decoratedMessage;
55 }
56
57 /***********************************************************************************************************************************************************
58 * Returns the decorated message.
59 *
60 * @return the decorated message
61 **********************************************************************************************************************************************************/
62 @Nonnull
63 public MessageSupport getDecoratedMessage();
64 }