Method: getDecoratedMessage()

1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2023 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
12: * the License. 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
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.actor;
28:
29: import javax.annotation.Nonnull;
30: import lombok.Getter;
31: import lombok.RequiredArgsConstructor;
32: import lombok.ToString;
33:
34: /***********************************************************************************************************************
35: *
36: * This role should be injected into a message to decorated it at the moment of sending. This technique is experimental
37: * and represents the function of a Decorator Pattern in a message-oriented design.
38: *
39: * @stereotype Role
40: *
41: * @author Fabrizio Giudici
42: *
43: **********************************************************************************************************************/
44: public interface MessageDecorator
45: {
46: public static final Class<MessageDecorator> _MessageDecorator_ = MessageDecorator.class;
47:
48: /*******************************************************************************************************************
49: *
50: * A default implementation of {@code MessageDecorator} which returns the same message.
51: *
52: ******************************************************************************************************************/
53: @RequiredArgsConstructor @ToString
54: public static class Same<T extends MessageSupport> implements MessageDecorator
55: {
56: @Getter @Nonnull
57: private final T decoratedMessage;
58: }
59:
60: /*******************************************************************************************************************
61: *
62: * Returns the decorated message.
63: *
64: * @return the decorated message
65: *
66: ******************************************************************************************************************/
67: @Nonnull
68: public MessageSupport getDecoratedMessage();
69: }