main/src/main/java/org/onap/policy/pap/main/parameters/PapParameterGroup.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   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.pap.main.parameters;
  22
  23 import org.onap.policy.common.parameters.GroupValidationResult;
  24 import org.onap.policy.common.parameters.ParameterGroup;
  25 import org.onap.policy.common.parameters.ValidationStatus;
  26 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
  27
  28 /**
  29  * Class to hold all parameters needed for pap component.
  30  *
  31  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  32  */
  33 public class PapParameterGroup implements ParameterGroup {
  34     private String name;
  35
  36     /**
  37      * Create the pap parameter group.
  38      *
  39      * @param name the parameter group name
  40      */
  41     public PapParameterGroup(final String name) {
  42         this.name = name;
  43     }
  44
  45     /**
  46      * Return the name of this parameter group instance.
  47      *
  48      * @return name the parameter group name
  49      */
  50     @Override
  51     public String getName() {
  52         return name;
  53     }
  54
  55     /**
  56      * Set the name of this parameter group instance.
  57      *
  58      * @param name the parameter group name
  59      */
  60     @Override
  61     public void setName(final String name) {
  62         this.name = name;
  63     }
  64
  65     /**
  66      * Validate the parameter group.
  67      *
  68      * @return the result of the validation
  69      */
  70     @Override
  71     public GroupValidationResult validate() {
  72         final GroupValidationResult validationResult = new GroupValidationResult(this);
  73         if (!ParameterValidationUtils.validateStringParameter(name)) {
  74             validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
  75         }
  76         return validationResult;
  77     }
  78 }