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.service.parameters.eventprotocol;
  22
  23 import org.onap.policy.common.parameters.GroupValidationResult;
  24 import org.onap.policy.common.parameters.ValidationStatus;
  25
  26 /**
  27  * An event protocol parameter class for character delimited textual event protocols that may be specialized by event
  28  * protocol plugins that require plugin specific parameters.
  29  *
  30  * <p>The following parameters are defined:
  31  * <ol>
  32  * <li>startChar: starting character delimiter for text blocks containing an event.
  33  * <li>endChar: ending character delimiter for text blocks containing an event.
  34  * </ol>
  35  *
  36  * @author Liam Fallon (liam.fallon@ericsson.com)
  37  */
  38 public abstract class EventProtocolTextCharDelimitedParameters extends EventProtocolParameters {
  39     // The starting and ending character delimiter
  40     private char startChar = '\0';
  41     private char endChar = '\0';
  42
  43     /**
  44      * Constructor to create an event protocol parameters instance with the name of a sub class of this class.
  45      *
  46      * @param parameterClassName the class name of a sub class of this class
  47      */
  48     public EventProtocolTextCharDelimitedParameters(final String parameterClassName) {
  49         super(parameterClassName);
  50     }
  51
  52     /**
  53      * Gets the start character that delimits the start of text blocks.
  54      *
  55      * @return the start char
  56      */
  57     public char getStartChar() {
  58         return startChar;
  59     }
  60
  61     /**
  62      * Sets the start character that delimits the start of text blocks.
  63      *
  64      * @param startChar the start character
  65      */
  66     public void setStartChar(final char startChar) {
  67         this.startChar = startChar;
  68     }
  69
  70     /**
  71      * Gets the end character that delimits the end of text blocks.
  72      *
  73      * @return the end character
  74      */
  75     public char getEndChar() {
  76         return endChar;
  77     }
  78
  79     /**
  80      * Sets the end character that delimits the end of text blocks.
  81      *
  82      * @param endChar the end character
  83      */
  84     public void setEndChar(final char endChar) {
  85         this.endChar = endChar;
  86     }
  87
  88     /*
  89      * (non-Javadoc)
  90      *
  91      * @see org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters#toString()
  92      */
  93     @Override
  94     public String toString() {
  95         return "EventProtocolTextCharDelimitedParameters {" + super.toString() + "} [startChar=" + startChar
  96                         + ", endChar=" + endChar + "]";
  97     }
  98
  99     /*
 100      * (non-Javadoc)
 101      *
 102      * @see org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters#validate()
 103      */
 104     @Override
 105     public GroupValidationResult validate() {
 106         final GroupValidationResult result = super.validate();
 107
 108         if (startChar == '\0') {
 109             result.setResult("startChar", ValidationStatus.INVALID,
 110                             "text character delimited start character has not been specified");
 111         }
 112
 113         if (endChar == '\0') {
 114             result.setResult("endChar", ValidationStatus.INVALID,
 115                             "text character delimited end character has not been specified\n");
 116         }
 117
 118         return result;
 119     }
 120 }