com.vectorprint.configuration.parameters.Parameter 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%
 */

import com.vectorprint.configuration.parameters.annotation.Param;
import com.vectorprint.configuration.parameters.annotation.ParamAnnotationProcessorImpl;

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

public interface Parameter extends Cloneable, Serializable, Observable, PropertyChangeListener {

   /**
    *
    * @return the class of the parameter value
    */
   Class getValueClass();

   /**
    * the identifier for this parameter
    *
    * @return
    */
   String getKey();

   /**
    * provide some information about the parameter
    *
    * @return
    */
   String getHelp();


   /**
    *
    * @param value the new value
    * @return 
    */
   Parameter setValue(TYPE value);

   /**
    *
    * @param value the new default value
    * @return 
    */
   Parameter setDefault(TYPE value);

   /**
    * return the value for this parameter or, when it is null, the default value
    *
    * @return the value or the default
    */
   TYPE getValue();
   
   /**
    *
    * @return the default value
    */
   TYPE getDefault();

   Parameter clone() throws CloneNotSupportedException;

   /**
    * You may want to know which class declared this Parameter
    *
    * @see Param
    * @see ParamAnnotationProcessorImpl#initParameters(com.vectorprint.configuration.parameters.Parameterizable)
    * @see Parameterizable#addParameter(com.vectorprint.configuration.parameters.Parameter, java.lang.Class)
    * @return
    */
   Class getDeclaringClass();
}