Repository navigation
Expand file tree
/
Copy pathIgnoredWhenDetached.java
More file actions
74 lines (71 loc) · 2.07 KB
/
Copy pathIgnoredWhenDetached.java
File metadata and controls
74 lines (71 loc) · 2.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/**
* Copyright (C) 2010-2014 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;
/**
* <p>
* 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.
* </p>
* <p>
* Should be used on method that must meet the following criteria
* </p>
* <p>
* 1) Can only be used in conjunction with classes annotated with
* {@link EFragment}
* </p>
* <p>
* 2) The annotated method MUST return void and MAY contain parameters.
* </p>
*
* <blockquote> <b>Example</b> :
*
* <pre>
* @EFragment
* public class LoaderFragment extends Fragment {
*
* ...
*
* @UiThread
* @IgnoredWhenDetached
* void killActivity() {
* getActivity().finish();
* }
*
*
* @IgnoredWhenDetached
* void updateTitle(String title) {
* getActivity().setTitle(title);
* }
* }
* </pre>
*
* </blockquote>
*
* @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 IgnoredWhenDetached {
}