com.vectorprint.configuration.annotation.Settings 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.

The 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.annotation;

import com.vectorprint.configuration.decoration.CachingProperties;
import com.vectorprint.configuration.decoration.ObservableProperties;
import com.vectorprint.configuration.decoration.Observer;
import com.vectorprint.configuration.decoration.visiting.DecoratorVisitor;
import com.vectorprint.configuration.decoration.visiting.ObservableVisitor;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @see SettingsAnnotationProcessor
 * @author Eduard Drenth at VectorPrint.nl
 */
@Documented
@Inherited
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Settings {
   /**
    * by default settings will be {@link CachingProperties read / write}.
    * @return 
    */
   boolean readonly() default false;
   /**
    * by default settings will be {@link CachingProperties cached}.
    * @return 
    */
   boolean cache() default true;
   /**
    * by default settings will not be {@link ObservableProperties observable}.
    * If you want the object containing the settings to be added automatically as observer, implement
    * {@link Observer}.
    * @see SettingsAnnotationProcessorImpl
    * @see ObservableVisitor
    * @return 
    */
   boolean observable() default false;
   
   /**
    * when urls are defined properties will be loaded from it
    * @return 
    */
   String[] urls() default {};
   /**
    * You can add your own features to settings, these will be applied at the end of the decoration stack.
    * @return 
    */
   Feature[] features() default {};
   
}