b99759eb31f79123e87c24f7facd9f0a12bf6314
[policy/clamp.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  * Copyright (C) 2021 Nordix Foundation.
4  * ================================================================================
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.clamp.controlloop.models.controlloop.concepts;
22
23 import java.util.LinkedHashMap;
24 import java.util.Map;
25 import java.util.UUID;
26 import java.util.function.UnaryOperator;
27 import lombok.Data;
28 import lombok.NoArgsConstructor;
29 import lombok.NonNull;
30 import lombok.ToString;
31 import org.onap.policy.models.base.PfConceptKey;
32 import org.onap.policy.models.base.PfUtils;
33 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
34
35 /**
36  * Class to represent a control loop instance.
37  */
38 @NoArgsConstructor
39 @Data
40 @ToString
41 public class ControlLoopElement {
42     @NonNull
43     private UUID id = UUID.randomUUID();
44
45     @NonNull
46     private ToscaConceptIdentifier definition = new ToscaConceptIdentifier(PfConceptKey.getNullKey());
47
48     @NonNull
49     private ToscaConceptIdentifier participantType = new ToscaConceptIdentifier(PfConceptKey.getNullKey());
50
51     @NonNull
52     private ToscaConceptIdentifier participantId = new ToscaConceptIdentifier(PfConceptKey.getNullKey());
53
54     @NonNull
55     private ControlLoopState state = ControlLoopState.UNINITIALISED;
56
57     @NonNull
58     private ControlLoopOrderedState orderedState = ControlLoopOrderedState.UNINITIALISED;
59
60     private String description;
61
62     private ClElementStatistics clElementStatistics;
63
64     // A map indexed by the property name. Each map entry is the serialized value of the property,
65     // which can be deserialized into an instance of the type of the property.
66     private Map<String, String> commonPropertiesMap = new LinkedHashMap<>();
67
68     /**
69      * Copy constructor, does a deep copy but as all fields here are immutable, it's just a regular copy.
70      *
71      * @param otherElement the other element to copy from
72      */
73     public ControlLoopElement(final ControlLoopElement otherElement) {
74         this.id = otherElement.id;
75         this.definition = new ToscaConceptIdentifier(otherElement.definition);
76         this.participantType = new ToscaConceptIdentifier(otherElement.participantType);
77         this.participantId = new ToscaConceptIdentifier(otherElement.participantId);
78         this.state = otherElement.state;
79         this.orderedState = otherElement.orderedState;
80         this.description = otherElement.description;
81         this.clElementStatistics = otherElement.clElementStatistics;
82         this.commonPropertiesMap = PfUtils.mapMap(otherElement.commonPropertiesMap, UnaryOperator.identity());
83     }
84 }