dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/util/json/mixin/BaseDynamicPropertiesProviderMixin.java

   1 /*
   2  * ===============================LICENSE_START======================================
   3  *  dcae-analytics
   4  * ================================================================================
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *   You may obtain a copy of the License at
  10  *
  11  *          http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *  ============================LICENSE_END===========================================
  19  */
  20
  21 package org.openecomp.dcae.apod.analytics.model.util.json.mixin;
  22
  23 import com.fasterxml.jackson.annotation.JsonAnyGetter;
  24 import com.fasterxml.jackson.annotation.JsonAnySetter;
  25 import com.fasterxml.jackson.annotation.JsonIgnore;
  26 import org.openecomp.dcae.apod.analytics.model.domain.BaseDynamicPropertiesProvider;
  27
  28 import java.util.Map;
  29
  30 /**
  31  * Json Mixin for {@link BaseDynamicPropertiesProvider}
  32  *
  33  * @author Rajiv Singla . Creation Date: 11/5/2016.
  34  */
  35 public abstract class BaseDynamicPropertiesProviderMixin implements JsonMixin {
  36
  37     /**
  38      * Provides hint to Jackson Json Object mapper to bind any put all dynamic properties in a map
  39      *
  40      * @param propertyName dynamic property name
  41      * @param propertyValue dynamic property value
  42      */
  43     @JsonAnySetter
  44     public abstract void addDynamicProperties(String propertyName, Object propertyValue);
  45
  46     /**
  47      * Provides hint to serialize dynamic properties as map
  48      *
  49      * @return dynamic properties map
  50      */
  51     @JsonAnyGetter
  52     public abstract Map<String, Object> getDynamicProperties();
  53
  54     /**
  55      * Ignores isDynamicPropertiesPresent for json serialization
  56      *
  57      * @return true if dynamic properties are present
  58      */
  59     @JsonIgnore
  60     public abstract boolean isDynamicPropertiesPresent();
  61 }