dcae-analytics/dcae-analytics-model/src/main/java/org/onap/dcae/analytics/model/common/BaseDynamicPropertiesProvider.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. 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  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.analytics.model.common;
  21
  22 import lombok.Data;
  23
  24 import java.util.LinkedHashMap;
  25 import java.util.Map;
  26
  27 /**
  28  * Base Dynamic Provider provide functionality so that all the
  29  * additional dynamic Properties can be accumulated in a map.
  30  *
  31  * @author Rajiv Singla
  32  */
  33 @Data
  34 public abstract class BaseDynamicPropertiesProvider implements DynamicPropertiesProvider {
  35
  36     /**
  37      * All non-required properties should be captured in additional properties
  38      */
  39     private Map<String, Object> dynamicProperties = new LinkedHashMap<>();
  40
  41
  42     /**
  43      * Add a dynamic property to Common Event Format Entity
  44      *
  45      * @param propertyName property name
  46      * @param propertyValue property value
  47      */
  48     @Override
  49     public void addDynamicProperties(String propertyName, Object propertyValue) {
  50         dynamicProperties.put(propertyName, propertyValue);
  51     }
  52
  53     /**
  54      * Determines if dynamic properties are present for the CEF Entity
  55      *
  56      * @return return true if Dynamic Properties are present
  57      */
  58     public boolean isDynamicPropertiesPresent() {
  59         return dynamicProperties.size() == 0;
  60     }
  61
  62
  63 }