Replace non-Javadoc comments with inheritDocs
[policy/apex-pdp.git] / examples / examples-aadm / src / test / java / org / onap / policy / apex / examples / aadm / TestApexActionListener.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
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.apex.examples.aadm;
22
23 import java.util.ArrayList;
24 import java.util.List;
25
26 import org.onap.policy.apex.core.engine.engine.EnEventListener;
27 import org.onap.policy.apex.core.engine.event.EnEvent;
28 import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
29
30 /**
31  * The listener interface for receiving testApexAction events. The class that is interested in processing a
32  * testApexAction event implements this interface, and the object created with that class is registered with a component
33  * using the component's <code>addTestApexActionListener</code> method. When the testApexAction event occurs, that
34  * object's appropriate method is invoked.
35  *
36  * @author Liam Fallon (liam.fallon@ericsson.com)
37  */
38 public class TestApexActionListener implements EnEventListener {
39     List<EnEvent> resultEvents = new ArrayList<EnEvent>();
40
41     private final String id;
42
43     /**
44      * Instantiates a new test apex action listener.
45      *
46      * @param id the id
47      */
48     public TestApexActionListener(final String id) {
49         this.id = id;
50     }
51
52     /**
53      * Gets the result.
54      *
55      * @return the result
56      */
57     public EnEvent getResult() {
58         while (resultEvents.isEmpty()) {
59             ThreadUtilities.sleep(100);
60         }
61         return resultEvents.remove(0);
62     }
63
64     /**
65      * {@inheritDoc}.
66      */
67     @Override
68     public void onEnEvent(final EnEvent actionEvent) {
69         ThreadUtilities.sleep(100);
70
71         if (actionEvent != null) {
72             System.out.println("Action event from engine:" + actionEvent.getName());
73             resultEvents.add(actionEvent);
74         }
75     }
76
77     /**
78      * Gets the id.
79      *
80      * @return the id
81      */
82     public String getId() {
83         return id;
84     }
85 }