aboutsummaryrefslogtreecommitdiffstats
path: root/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/context/AxStateFacade.java
blob: f433eedcdd474963f807dd12a46ddb46fb0390ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.core.engine.executor.context;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.service.ModelService;
import org.onap.policy.apex.model.policymodel.concepts.AxState;
import org.onap.policy.apex.model.policymodel.concepts.AxTasks;

/**
 * The Class AxStateFacade acts as a facade into the AxState class so that task logic can easily
 * access information in an AxState instance.
 *
 * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
 */
public class AxStateFacade {
    // CHECKSTYLE:OFF: checkstyle:visibilityModifier Logic has access to this field

    /** The full definition information for the state. */
    public final AxState state;

    // CHECKSTYLE:ON: checkstyle:visibilityModifier

    /**
     * Instantiates a new AxState facade.
     *
     * @param state the state for which a facade is being presented
     */
    public AxStateFacade(final AxState state) {
        this.state = state;
    }

    /**
     * Gets the default task key of the state.
     *
     * @return the default task key
     */
    public AxArtifactKey getDefaultTaskKey() {
        return state.getDefaultTask();
    }

    /**
     * Gets the ID of the state.
     *
     * @return the ID
     */
    public String getId() {
        return state.getKey().getId();
    }

    /**
     * Gets the name of the state.
     *
     * @return the state name
     */
    public String getStateName() {
        return state.getKey().getLocalName();
    }

    /**
     * Check if a task is defined for a given task name on a state and, if so, return its key.
     *
     * @param taskName the name of the task to get
     * @return the task key or null if it does not exist
     */
    public AxArtifactKey getTaskKey(final String taskName) {
        if (taskName == null) {
            return null;
        }

        return ModelService.getModel(AxTasks.class).get(taskName).getKey();
    }

    /**
     * Check if a task is defined for a given task name on a state and, if so, return its key.
     *
     * @return unmodifiable list of names of tasks available
     */
    public List<String> getTaskNames() {
        final Set<AxArtifactKey> tasks = state.getTaskReferences().keySet();
        final List<String> ret = new ArrayList<>(tasks.size());
        for (final AxArtifactKey task : tasks) {
            ret.add(task.getName());
        }
        return Collections.unmodifiableList(ret);
    }
}