aboutsummaryrefslogtreecommitdiffstats
path: root/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/service/AbstractParameters.java
blob: cc7c7b06fd07aff8362d50ffc8bb088e5d65695c (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
/*
 * ============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.model.basicmodel.service;

import org.onap.policy.apex.model.basicmodel.concepts.ApexRuntimeException;
import org.onap.policy.apex.model.utilities.Assertions;

/**
 * This class defines an abstract parameter class that acts as a base class for all parameters in Apex. The abstract parameter class holds the name of a
 * subclass of this abstract parameter class {@link AbstractParameters}. The class of the parameter class is checked at construction and on calls to the
 * {@link #getParameterClass()} method.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public abstract class AbstractParameters {
    // The name of the parameter subclass
    private final String parameterClassName;

    /**
     * Constructor, creates a parameter class that must be a subclass of {@link AbstractParameters}.
     *
     * @param parameterClassName the full canonical class name of the parameter class
     */
    public AbstractParameters(final String parameterClassName) {
        try {
            Assertions.assignableFrom(Class.forName(parameterClassName), AbstractParameters.class);
        }
        catch (IllegalArgumentException | ClassNotFoundException e) {
            throw new ApexRuntimeException(
                    "class \"" + parameterClassName + "\" not found or not an instance of \"" + this.getClass().getCanonicalName() + "\"", e);
        }
        
        this.parameterClassName = parameterClassName;
    }

    /**
     * Gets the parameter class.
     *
     * @return the parameter class
     */
    @SuppressWarnings("unchecked")
    public final Class<? extends AbstractParameters> getParameterClass() {
        try {
            return (Class<? extends AbstractParameters>) Class.forName(parameterClassName);
        }
        catch (final ClassNotFoundException e) {
            throw new ApexRuntimeException("class not found for parameter class name \"" + parameterClassName + "\"", e);
        }
    }

    /**
     * Gets the parameter class name.
     *
     * @return the parameter class name
     */
    public final String getParameterClassName() {
        return parameterClassName;
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return "AbstractParameters [parameterClassName=" + parameterClassName + "]";
    }
}