Package: EnableMessageBus

EnableMessageBus

Coverage

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * SteelBlue: DCI User Interfaces
5: * http://tidalwave.it/projects/steelblue
6: *
7: * Copyright (C) 2015 - 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/steelblue-src
22: * git clone https://github.com/tidalwave-it/steelblue-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.ui.core.annotation;
27:
28: import java.lang.annotation.Documented;
29: import java.lang.annotation.ElementType;
30: import java.lang.annotation.Retention;
31: import java.lang.annotation.RetentionPolicy;
32: import java.lang.annotation.Target;
33:
34: /***************************************************************************************************************************************************************
35: *
36: * If a {@code Main} class is annotated with {@code EnableMessageBus}, the following things happen:
37: *
38: * <ul>
39: * <li>a messagebus implementing {@link it.tidalwave.messagebus.MessageBus} is instantiated and made available in the Spring application context
40: * (so it can be injected);</li>
41: * <li>a {@link it.tidalwave.ui.core.message.PowerOnEvent} is fired when the application is ready to be initialised;</li>
42: * <li>a {@link it.tidalwave.ui.core.message.PowerOffEvent} is fired when the application is going to be closed.</li>
43: * </ul>
44: *
45: * @since 1.1-ALPHA-6
46: * @author Fabrizio Giudici
47: *
48: **************************************************************************************************************************************************************/
49: @Target(ElementType.TYPE)
50: @Retention(RetentionPolicy.RUNTIME)
51: @Documented
52: public @interface EnableMessageBus
53: {
54: }