controlloop/common/coordination/src/main/java/org/onap/policy/coordination/CoordinationDirective.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * guard
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2024 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.coordination;
  23
  24 import java.util.List;
  25 import lombok.Getter;
  26 import lombok.Setter;
  27
  28 @Setter
  29 @Getter
  30 public class CoordinationDirective {
  31
  32     private List<String> controlLoop;
  33     private String coordinationFunction;
  34
  35     /**
  36      * gets the ith control loop.
  37      *
  38      * @param index the control loop's index
  39      * @return the CoordinationDirective's string representation
  40      */
  41     public String getControlLoop(int index) {
  42         return controlLoop.get(index);
  43     }
  44
  45     /**
  46      * toString.
  47      *
  48      * @return the CoordinationDirective's string representation
  49      */
  50     public String toString() {
  51         return "CoordinationDirective[ "
  52             + String.join(" / ", controlLoop)
  53             + " / " + coordinationFunction + "]";
  54     }
  55
  56 }