de.devland.esperandro.annotations.Default Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of esperandro-api Show documentation

There is a newer version: 4.0.1

/*
 * Copyright 2013 David Kunzler
 *
 *   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 de.devland.esperandro.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Allows to set a default for the primitive preferences as well as {@code String}. A {@code Set} will always
 * have {@code null} as default value;
 * 
 * If no annotation is given or the proper default value is not set the used defaults are: {@code boolean}: false {@code
 * int}: -1 {@code long}: -1l {@code float}: -1.0f {@code String}: "" (empty String)
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Default {

    boolean booleanDefault = false;
    int intDefault = -1;
    long longDefault = -1L;
    float floatDefault = -1.0f;
    char charDefault = 0;
    byte byteDefault = 0x00;
    String stringDefault = "";

    boolean ofBoolean() default booleanDefault;

    int ofInt() default intDefault;

    long ofLong() default longDefault;

    float ofFloat() default floatDefault;

    char ofChar() default charDefault;

    byte ofByte() default byteDefault;

    String ofString() default stringDefault;

    /**
     * A default that can be used on every type. If present the value of the provided string will be used as is
     * as the default value when getting the preference value.
     */
    String ofStatement() default stringDefault;
}