org.androidannotations.annotations.IgnoreWhen Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of androidannotations-api Show documentation
Show all versions of androidannotations-api Show documentation
The API jar containing the annotations and the runtime helpers
/**
* Copyright (C) 2010-2016 eBusiness Information, Excilys Group
*
* 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 org.androidannotations.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* When used standalone in an {@link EFragment} or in conjunction with the
* {@link UiThread} or {@link Background} annotations, the annotated method will
* be wrapped in an 'if attached' block such that no code will be executed if
* the {@link EFragment} is no longer bound to its parent activity or
* DETACHEDthe {@link EFragment} views are destroyed
* VIEW_DESTROYED.
*
*
* Should be used on method that must meet the following criteria
*
*
* 1) Can only be used in conjunction with classes annotated with
* {@link EFragment}
*
*
* 2) The annotated method MUST return void and MAY contain parameters.
*
*
* Example :
*
*
* @EFragment
* public class LoaderFragment extends Fragment {
*
* ...
*
* @UiThread
* @IgnoreWhen(IgnoreWhen.State.DETACHED)
* void killActivity() {
* getActivity().finish();
* }
*
*
* @IgnoreWhen(IgnoreWhen.State.VIEW_DESTROYED)
* void updateTitle(String title) {
* getActivity().setTitle(title);
* }
* }
*
*
*
*
* @see org.androidannotations.annotations.EFragment
* @see org.androidannotations.annotations.UiThread
* @see org.androidannotations.annotations.Background
* @see android.os.Handler
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface IgnoreWhen {
/**
* The lifecycle state after the method should not be executed.
*
* @return the state that skips method execution
*/
State value();
/**
* The lifecycle state after the method should not be executed.
*/
enum State {
/**
* Skip execution if the {@link EFragment} is no longer bound to its
* parent activity.
*/
DETACHED,
/**
* Skip execution if the {@link EFragment} views are destroyed.
*/
VIEW_DESTROYED
}
}