com.vectorprint.configuration.parameters.Parameterizable Maven / Gradle / Ivy

Go to download

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

A library for settings and parameterization of objects. Key features are support for data types, help for settings and parameters, annotations for ease of use. Settings and parameters both are Clonable and Serializable. More features for settings such as parsing a settingsfile, being observable, readonliness, caching etc. are available. The library contains javacc generated parsers for syntax support for properties, multi valued properties, parameterized objects and multi valued parameters.

The newest version!


package com.vectorprint.configuration.parameters;

/*-
 * #%L
 * Config
 * %%
 * Copyright (C) 2015 - 2018 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%
 */

//~--- JDK imports ------------------------------------------------------------

import com.vectorprint.configuration.EnhancedMap;
import com.vectorprint.configuration.parameters.annotation.ParamAnnotationProcessor;

import java.beans.PropertyChangeListener;
import java.io.Serializable;
import java.util.Map;

public interface Parameterizable extends Cloneable, PropertyChangeListener {

   /**
    * contains parameters
    *
    * @return
    */
   Map getParameters();

   /**
    * get hold of a parameter
    *
    * @param 
    * @param key
    * @param T
    * @return
    */
    Parameter getParameter(String key, Class T);

   /**
    * get a value from a parameter.
    *
    * @param 
    * @param key
    * @param T
    * @return
    */
    TYPE getValue(String key, Class T);

   /**
    * set a value of a parameter
    *
    * @param 
    * @param key
    * @param value
    */
    void setValue(String key, TYPE value);

   /**
    * addParameter a Parameter to this Parameterizable
    *
    * @param declaringClass the class in which the parameter was declared
    * @see ParamAnnotationProcessor
    * @param parameter
    */
   void addParameter(Parameter parameter, Class declaringClass);

   Parameterizable clone() throws CloneNotSupportedException;

   /**
    * return true when {@link Parameter#getValue() } is not null.
    *
    * @param key
    * @return
    */
   boolean isParameterSet(String key);

   EnhancedMap getSettings();
}