com.vectorprint.configuration.Configurable Maven / Gradle / Ivy

Go to download

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

A library for configuration of applications and parameterization of objects. Settings can be provided in a configfile (file, url, stream), as arguments and programmatically, object parameters can be set using annotations or code. Both provide data type support, serialization, cloning, a help mechanism.

There is a newer version: 12.0

Show newest version

package com.vectorprint.configuration;

/*
 * #%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 com.vectorprint.configuration.annotation.Setting;
import com.vectorprint.configuration.annotation.Settings;
import com.vectorprint.configuration.annotation.SettingsAnnotationProcessor;
import com.vectorprint.configuration.decoration.FindableProperties;
import java.util.Map;

/**
 * A Configurable object should be initialized by a {@link SettingsProvider}.
 * Instead of implementing this interface to provide settings to your objects you could also make use of
 * {@link Setting} and {@link SettingsAnnotationProcessor}.
 *
 * @param  a Map holding settings for the Configurable Object
 * @see FindableProperties#find(java.lang.String)
 * @see Settings
 * @author Eduard Drenth at VectorPrint.nl
 */
public interface Configurable {

        /**
         * return properties
         *
         * @return the properties found or null
         */
        P getSettings();
        
        /**
         * A settingsprovider can provide settings to a Configurable by calling this method.
         *
         * @param settings
         */
        
        void initSettings(P settings);
        
        /**
         * return a setting of a certain type
         * @see EnhancedMap#getGenericProperty(java.lang.String, java.lang.Object, java.lang.Class) 
         * @param 
         * @param key
         * @param defaultValue 
         * @param clazz
         * @return 
         */
         TYPE getSetting(Object key, TYPE defaultValue, Class clazz);
}