roboguice.inject.InjectExtra Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of roboguice

A framework for using Google Guice dependency injection in Android.

There is a newer version: 4.0.0

/*
 * Copyright 2009 Michael Burton
 * 
 * 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 roboguice.inject;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

import com.google.inject.BindingAnnotation;

/**
 * Indicates that a variable member of a class (whether static or not) should be
 * injected with an Android extra. The value is compulsory, and correspond to
 * the key of the extra.

 * 

 * The extra must exists when the activity is injected, unless you specify
 * {@code optional=true} in the {@link InjectExtra} annotation. If optional is
 * set to true and no extra is found, no value will be injected in the field.

 * 

 * The default behavior of the {@link InjectExtra} annotation is to forbid null
 * values. However, if you wish to allow injection of null values, you should
 * use the {@link Nullable} annotation.

 * 

 * You can define a default value in Java when the extra is optional : 
 {@code
 * @InjectExtra(value="someValue", optional=true) Integer someValue = 2;} ) 

 * However, it is a non-sense to inject a default value in Java if the extra is
 * not optional : {@code @InjectExtra("someValue") Integer someValue = 2; // DO
 * NOT DO THIS}
 * 
 * 

 * Usage example:
 {@code @InjectExtra("someValue") protected Integer someValue;}

 * 
{@code @InjectExtra("someValue") @Nullable protected Integer someValue;}
 * 
 * @author Mike Burton
 */
@Retention(RUNTIME)
@Target( { ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD })
@BindingAnnotation
public @interface InjectExtra {
    String value();

    boolean optional() default false;
}