gerrit.onap Code Review - policy/apex-pdp.git/blob

   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.model.basicmodel.service;
  22
  23 import org.onap.policy.apex.model.basicmodel.concepts.ApexRuntimeException;
  24 import org.onap.policy.apex.model.utilities.Assertions;
  25
  26 /**
  27  * 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
  28  * subclass of this abstract parameter class {@link AbstractParameters}. The class of the parameter class is checked at construction and on calls to the
  29  * {@link #getParameterClass()} method.
  30  *
  31  * @author Liam Fallon (liam.fallon@ericsson.com)
  32  */
  33 public abstract class AbstractParameters {
  34     // The name of the parameter subclass
  35     private final String parameterClassName;
  36
  37     /**
  38      * Constructor, creates a parameter class that must be a subclass of {@link AbstractParameters}.
  39      *
  40      * @param parameterClassName the full canonical class name of the parameter class
  41      */
  42     public AbstractParameters(final String parameterClassName) {
  43         try {
  44             Assertions.assignableFrom(Class.forName(parameterClassName), AbstractParameters.class);
  45         }
  46         catch (IllegalArgumentException | ClassNotFoundException e) {
  47             throw new ApexRuntimeException(
  48                     "class \"" + parameterClassName + "\" not found or not an instance of \"" + this.getClass().getCanonicalName() + "\"", e);
  49         }
  50
  51         this.parameterClassName = parameterClassName;
  52     }
  53
  54     /**
  55      * Gets the parameter class.
  56      *
  57      * @return the parameter class
  58      */
  59     @SuppressWarnings("unchecked")
  60     public final Class<? extends AbstractParameters> getParameterClass() {
  61         try {
  62             return (Class<? extends AbstractParameters>) Class.forName(parameterClassName);
  63         }
  64         catch (final ClassNotFoundException e) {
  65             throw new ApexRuntimeException("class not found for parameter class name \"" + parameterClassName + "\"", e);
  66         }
  67     }
  68
  69     /**
  70      * Gets the parameter class name.
  71      *
  72      * @return the parameter class name
  73      */
  74     public final String getParameterClassName() {
  75         return parameterClassName;
  76     }
  77
  78     /*
  79      * (non-Javadoc)
  80      *
  81      * @see java.lang.Object#toString()
  82      */
  83     @Override
  84     public String toString() {
  85         return "AbstractParameters [parameterClassName=" + parameterClassName + "]";
  86     }
  87 }