1 /*
2 * *************************************************************************************************************************************************************
3 *
4 * TheseFoolishThings: Miscellaneous utilities
5 * http://tidalwave.it/projects/thesefoolishthings
6 *
7 * Copyright (C) 2009 - 2024 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.Duration;
31 import java.time.ZonedDateTime;
32 import it.tidalwave.actor.annotation.Message;
33 import lombok.EqualsAndHashCode;
34 import lombok.ToString;
35
36 /***************************************************************************************************************************************************************
37 *
38 * This message notifies that a {@link Collaboration} has been completed.
39 *
40 * @author Fabrizio Giudici
41 *
42 **************************************************************************************************************************************************************/
43 @Message @Immutable @EqualsAndHashCode @ToString
44 public class CollaborationCompletedMessage extends MessageSupport
45 {
46 private final ZonedDateTime endTime = ZonedDateTime.now();
47
48 /***********************************************************************************************************************************************************
49 *
50 **********************************************************************************************************************************************************/
51 private CollaborationCompletedMessage (@Nonnull final Collaboration collaboration)
52 {
53 super(collaboration);
54 }
55
56 /***********************************************************************************************************************************************************
57 * Creates a new instance for the given {@link Collaboration}.
58 *
59 * @param collaboration the {@code Collaboration}
60 * @return the new instance
61 **********************************************************************************************************************************************************/
62 @Nonnull
63 public static CollaborationCompletedMessage forCollaboration (@Nonnull final Collaboration collaboration)
64 {
65 return new CollaborationCompletedMessage(collaboration);
66 }
67
68 /***********************************************************************************************************************************************************
69 * Returns the time when the {@link Collaboration} has been started.
70 *
71 * @return the start time
72 **********************************************************************************************************************************************************/
73 @Nonnull
74 public ZonedDateTime getStartTime()
75 {
76 return collaboration.getStartTime();
77 }
78
79 /***********************************************************************************************************************************************************
80 * Returns the time when the {@link Collaboration} has been completed.
81 *
82 * @return the end time
83 **********************************************************************************************************************************************************/
84 @Nonnull
85 public ZonedDateTime getEndTime()
86 {
87 return endTime;
88 }
89
90 /***********************************************************************************************************************************************************
91 * Returns the time this {@link Collaboration} took to complete.
92 *
93 * @return the duration
94 **********************************************************************************************************************************************************/
95 @Nonnull
96 public Duration getDuration()
97 {
98 return Duration.between(getStartTime(), endTime);
99 }
100 }