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 javax.annotation.concurrent.Immutable;
30 import java.time.ZonedDateTime;
31 import it.tidalwave.actor.annotation.Message;
32 import lombok.EqualsAndHashCode;
33 import lombok.ToString;
34
35 /***************************************************************************************************************************************************************
36 *
37 * This message notifies that a new {@link Collaboration} has been started.
38 *
39 * @author Fabrizio Giudici
40 *
41 **************************************************************************************************************************************************************/
42 @Message @Immutable @EqualsAndHashCode(callSuper = true) @ToString
43 public class CollaborationStartedMessage extends MessageSupport
44 {
45 /***********************************************************************************************************************************************************
46 *
47 **********************************************************************************************************************************************************/
48 private CollaborationStartedMessage (@Nonnull final Collaboration collaboration)
49 {
50 super(collaboration);
51 }
52
53 /***********************************************************************************************************************************************************
54 * Creates a new instance for the given {@link Collaboration}.
55 *
56 * @param collaboration the {@code Collaboration}
57 * @return the new instance
58 **********************************************************************************************************************************************************/
59 @Nonnull
60 public static CollaborationStartedMessage forCollaboration (@Nonnull final Collaboration collaboration)
61 {
62 return new CollaborationStartedMessage(collaboration);
63 }
64
65 /***********************************************************************************************************************************************************
66 * Returns the time when the {@link Collaboration} has been started.
67 *
68 * @return the start time
69 **********************************************************************************************************************************************************/
70 @Nonnull
71 public ZonedDateTime getStartTime()
72 {
73 return collaboration.getStartTime();
74 }
75 }