com.vectorprint.configuration.preparing.AbstractPrepareKeyValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of Config Show documentation

This project is about configuration of applications and about parameterization of Objects. This library offers annotations (and annotation processors), parsers, typing, observing changes, serialization, cloning and more when working with settings and/or object parameters. Settings and its features can be declared using an xml format. The library offers syntax support for settings and parameters in a loosely coupled manner. You are not restricted to built in syntax, you can provide your own. At runtime this library tracks keys for which a default is used because they are not found in settings. Also it tracks unused keys. You can stack features for settings such as caching, preparing keys and values, readonlyness, threadsafety, helpsupport, reading / parsing from input. You can easily develop your own features for settings.

There is a newer version: 12.2

Show newest version

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package com.vectorprint.configuration.preparing;

/*
 * #%L
 * VectorPrintConfig3.0
 * %%
 * Copyright (C) 2011 - 2013 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 java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

/**
 *
 * @author Eduard Drenth at VectorPrint.nl
 */
public abstract class AbstractPrepareKeyValue implements PrepareKeyValue {

   private static final long serialVersionUID = 1;
   private final Set keys = new HashSet<>(3);
   private boolean optIn = true;

   /**
    * returns true when optIn is true (the default) and the key is registered or when optIn is false and the key isn't registered
    *
    * @see #addKeys(java.io.Serializable)
    * @see #setOptIn(boolean) 
    * @param keyValue 
    * @return
    */
   @Override
   public boolean shouldPrepare(KeyValue keyValue) {
      return (optIn && keys.contains(keyValue.getKey())) || (!optIn && !keys.contains(keyValue.getKey()));
   }

   /**
    * register a key that should not be prepared
    *
    * @param keys
    * @return
    */
   public AbstractPrepareKeyValue addKeys(String... keys) {
       this.keys.addAll(Arrays.asList(keys));
      return this;
   }

    public boolean isOptIn() {
        return optIn;
    }

    public AbstractPrepareKeyValue setOptIn(boolean optIn) {
        this.optIn = optIn;
        return this;
    }
   
   
}