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.context.parameters;
  22
  23 import org.onap.policy.apex.model.basicmodel.service.AbstractParameters;
  24 import org.onap.policy.apex.model.basicmodel.service.ParameterService;
  25
  26 /**
  27  * An empty schema helper parameter class that may be specialized by context schema helper plugins that require plugin
  28  * specific parameters.
  29  *
  30  * @author Liam Fallon (liam.fallon@ericsson.com)
  31  */
  32 public class SchemaHelperParameters extends AbstractParameters {
  33     // Schema helper plugin class for the schema
  34     private String schemaHelperPluginClass;
  35
  36     /**
  37      * Constructor to create a schema helper parameters instance and register the instance with the parameter service.
  38      */
  39     public SchemaHelperParameters() {
  40         super(SchemaHelperParameters.class.getCanonicalName());
  41         ParameterService.registerParameters(SchemaHelperParameters.class, this);
  42     }
  43
  44     /**
  45      * Constructor to create a schema helper parameters instance with the name of a sub class of this class and register
  46      * the instance with the parameter service.
  47      *
  48      * @param parameterClassName the class name of a sub class of this class
  49      */
  50     public SchemaHelperParameters(final String parameterClassName) {
  51         super(parameterClassName);
  52     }
  53
  54     /**
  55      * Gets the schema helper plugin class.
  56      *
  57      * @return the schema helper plugin class
  58      */
  59     public String getSchemaHelperPluginClass() {
  60         return schemaHelperPluginClass;
  61     }
  62
  63     /**
  64      * Sets the schema helper plugin class.
  65      *
  66      * @param pluginClass the schema helper plugin class
  67      */
  68     public void setSchemaHelperPluginClass(final String pluginClass) {
  69         schemaHelperPluginClass = pluginClass;
  70     }
  71
  72     /*
  73      * (non-Javadoc)
  74      *
  75      * @see org.onap.policy.apex.model.basicmodel.service.AbstractParameters#toString()
  76      */
  77     @Override
  78     public String toString() {
  79         return "SchemaHelperParameters [schemaHelperPluginClass=" + schemaHelperPluginClass + "]";
  80     }
  81 }