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.common.parameters.GroupValidationResult;
  24 import org.onap.policy.common.parameters.ParameterGroup;
  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 implements ParameterGroup {
  33     private String name;
  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();
  41     }
  42
  43     /**
  44      * Gets the schema helper plugin class.
  45      *
  46      * @return the schema helper plugin class
  47      */
  48     public String getSchemaHelperPluginClass() {
  49         return schemaHelperPluginClass;
  50     }
  51
  52     /**
  53      * Sets the schema helper plugin class.
  54      *
  55      * @param pluginClass the schema helper plugin class
  56      */
  57     public void setSchemaHelperPluginClass(final String pluginClass) {
  58         schemaHelperPluginClass = pluginClass;
  59     }
  60
  61     @Override
  62     public String toString() {
  63         return "SchemaHelperParameters [name=" + name + ", schemaHelperPluginClass=" + schemaHelperPluginClass + "]";
  64     }
  65
  66     @Override
  67     public String getName() {
  68         return name;
  69     }
  70
  71     @Override
  72     public void setName(final String name) {
  73         this.name = name;
  74     }
  75
  76     @Override
  77     public GroupValidationResult validate() {
  78         return new GroupValidationResult(this);
  79     }
  80 }