com.vectorprint.configuration.binding.parameters.ParameterizableParser 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

/*
 * 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.configuration.EnhancedMap;
import com.vectorprint.configuration.annotation.SettingsAnnotationProcessor;
import com.vectorprint.configuration.binding.BindingHelper;
import com.vectorprint.configuration.parameters.Parameter;
import com.vectorprint.configuration.parameters.Parameterizable;
import com.vectorprint.configuration.parameters.annotation.ParamAnnotationProcessor;
import java.io.Serializable;

/**
 * Interface describing how to get from a syntax to a Parameterizable and vise versa. You can for example generate a
 * (javacc) parser that implements this interface, or implement this interface and use a (javacc) parser under the hood.
 * You are recommended to extend {@link AbstractParameterizableParser} and use a {@link BindingHelper}. The
 * BindingHelper will be responsible for converting Strings into (atomic) values and vise versa, for setting values and
 * defaults of parameters during or after parsing and for escaping meaningful characters for a certain syntax.
 *
 * @param 
 * @see BindingHelper
 * @see ParameterizableBindingFactory
 * @see ParameterizableBindingFactoryImpl
 * @author Eduard Drenth at VectorPrint.nl
 */
public interface ParameterizableParser {

   /**
    * a package name that may be used in {@link #parseParameterizable() }
    *
    * @param pkg
    * @return
    */
   ParameterizableParser setPackageName(String pkg);

   String getPackageName();

   /**
    * settings that may be used in {@link #parseParameterizable() }
    *
    * @param settings
    * @return
    */
   ParameterizableParser setSettings(EnhancedMap settings);

   EnhancedMap getSettings();

   /**
    * Suggestion for how a parser could initialize a Parameterizable (in this order):

    * 
    * extend {@link AbstractParameterizableParser}
    * {@link SettingsAnnotationProcessor#initSettings(java.lang.Object, com.vectorprint.configuration.EnhancedMap) }
    * on the Parameterizable class and object
    * {@link ParamAnnotationProcessor#initParameters(com.vectorprint.configuration.parameters.Parameterizable) }
    * on the Parameterizable object
    * call {@link #initParameterizable(com.vectorprint.configuration.parameters.Parameterizable) } on the
    * abstract
    * call {@link #initParameter(com.vectorprint.configuration.parameters.Parameter, java.lang.Object) } for each
    * parameter found. In this method you can call {@link ParamBindingHelper#setValueOrDefault(com.vectorprint.configuration.parameters.Parameter, java.io.Serializable, boolean)
    * }
    * after turning the Object into the type needed by the Parameter.
    * 
    * finally you may want to set (default) values for parameters using {@link ParameterHelper#findKey(java.lang.String, java.lang.Class, com.vectorprint.configuration.EnhancedMap, com.vectorprint.configuration.binding.parameters.ParameterHelper.SUFFIX) }, {@link #parseAsParameterValue(java.lang.String, com.vectorprint.configuration.parameters.Parameter)
    * } and {@link ParamBindingHelper#setValueOrDefault(com.vectorprint.configuration.parameters.Parameter, java.io.Serializable, boolean)
    * }.
    * 
    *
    * @return
    */
   Parameterizable parseParameterizable();

   /**
    * Call this when the parsing process instantiated a Parameterizable
    *
    * @param parameterizable
    */
   void initParameterizable(Parameterizable parameterizable);

   /**
    * Call this when the parsing process found and instantiated a Parameter
    *
    * @param parameter
    * @param value
    */
   void initParameter(Parameter parameter, T value);

   /**
    * try to parse a String into a value for a parameter
    *
    * @param 
    * @param valueToParse
    * @param parameter
    * @return
    */
    TYPE parseAsParameterValue(String valueToParse, Parameter parameter);

   void setBindingHelper(ParamBindingHelper bindingHelper);
}