com.vectorprint.configuration.binding.parameters.AbstractParameterizableBinding Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 VectorPrint.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.vectorprint.configuration.binding.parameters;

/*
 * #%L
 * Config
 * %%
 * Copyright (C) 2015 VectorPrint
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.vectorprint.VectorPrintRuntimeException;
import com.vectorprint.configuration.Configurable;
import com.vectorprint.configuration.EnhancedMap;
import com.vectorprint.configuration.parameters.CharPasswordParameter;
import com.vectorprint.configuration.parameters.Parameter;
import com.vectorprint.configuration.parameters.Parameterizable;
import com.vectorprint.configuration.parameters.PasswordParameter;
import com.vectorprint.configuration.parameters.annotation.ParamAnnotationProcessor;
import com.vectorprint.configuration.parameters.annotation.ParamAnnotationProcessorImpl;
import java.lang.reflect.InvocationTargetException;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Syntax independent base class for Parsers.
 *
 * @author Eduard Drenth at VectorPrint.nl
 * @param  The type of Object yielded by the parsing process, for example List or Object when the type is unknown
 */
public abstract class AbstractParameterizableBinding implements ParameterizableParser, ParameterizableSerializer {

   private static final Logger logger = Logger.getLogger(AbstractParameterizableBinding.class.getName());
   private String packageName;
   private EnhancedMap settings;

   public final void checkKey(Parameterizable st, String key) {
      if (!st.getParameters().containsKey(key)) {
         throw new VectorPrintRuntimeException(String.format("wrong paramter(s) for %s: %s; parameters allowed are: %s",
             st.getClass().getSimpleName(), key, st.getParameters()));
      }
   }

   /**
    * Calls {@link ParamAnnotationProcessor#initParameters(com.vectorprint.configuration.parameters.Parameterizable) } and if
    * applicable {@link Configurable#initSettings(java.util.Map) }
    *
    */
   @Override
   public void initParameterizable(Parameterizable parameterizable) {
      try {
         ParamAnnotationProcessorImpl.PAP.initParameters(parameterizable);
      } catch (NoSuchMethodException | InstantiationException | IllegalAccessException | InvocationTargetException ex) {
         throw new VectorPrintRuntimeException(ex);
      }
      if (parameterizable instanceof Configurable) {
         ((Configurable) parameterizable).initSettings(settings);
      }
   }

   @Override
   public EnhancedMap getSettings() {
      return settings;
   }

   @Override
   public ParameterizableParser setSettings(EnhancedMap settings) {
      this.settings = settings;
      return this;
   }

   @Override
   public String getPackageName() {
      return packageName;
   }

   @Override
   public ParameterizableParser setPackageName(String packageName) {
      this.packageName = packageName;
      return this;
   }

   /**
    * return false for password parameters and when parameter value and default are the same
    * @param parameter
    * @return 
    */
   @Override
   public boolean include(Parameter parameter) {
      boolean rv = true;
      if (parameter instanceof CharPasswordParameter || parameter instanceof PasswordParameter) {
         rv = false;
      } else {
         Object v = parameter.getValue();
         rv = !(v == null ? parameter.getDefault() == null : v.equals(parameter.getDefault()));
      }
      if (!rv) {
         if (logger.isLoggable(Level.FINE)) {
            logger.fine(String.format("not including %s in serialization", parameter));
         }
      }
      return rv;
   }

}