Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f8b83360 authored by Tor Norbye's avatar Tor Norbye
Browse files

Add threading annotations 

These describe threading requirements for a given method,
or threading promises made to a callback.

Change-Id: If496067b12df3a0adedc32e4b4005cd1c2d400f3
parent 6a1c23bf

core/java/android/annotation/BinderThread.java

0 → 100644
+42 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2015 The Android Open Source Project

 *

 * 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 android.annotation;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



import static java.lang.annotation.ElementType.CONSTRUCTOR;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.TYPE;

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



/**

 * Denotes that the annotated method should only be called on the binder thread.

 * If the annotated element is a class, then all methods in the class should be called

 * on the binder thread.

 * <p>

 * Example:

 * <pre>{@code

 *  (&#64;BinderThread

 *  public BeamShareData createBeamShareData() { ... }

 * }</pre>

 *

 * {@hide}

 */

@Retention(SOURCE)

@Target({METHOD,CONSTRUCTOR,TYPE})

public @interface BinderThread {

}
 
 No newline at end of file

core/java/android/annotation/MainThread.java

0 → 100644
+42 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2015 The Android Open Source Project

 *

 * 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 android.annotation;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



import static java.lang.annotation.ElementType.CONSTRUCTOR;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.TYPE;

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



/**

 * Denotes that the annotated method should only be called on the main thread.

 * If the annotated element is a class, then all methods in the class should be called

 * on the main thread.

 * <p>

 * Example:

 * <pre>{@code

 *  &#64;MainThread

 *  public void deliverResult(D data) { ... }

 * }</pre>

 *

 * {@hide}

 */

@Retention(SOURCE)

@Target({METHOD,CONSTRUCTOR,TYPE})

public @interface MainThread {

}
 
 No newline at end of file

core/java/android/annotation/UiThread.java

0 → 100644
+42 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2015 The Android Open Source Project

 *

 * 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 android.annotation;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



import static java.lang.annotation.ElementType.CONSTRUCTOR;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.TYPE;

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



/**

 * Denotes that the annotated method or constructor should only be called on the UI thread.

 * If the annotated element is a class, then all methods in the class should be called

 * on the UI thread.

 * <p>

 * Example:

 * <pre>{@code

 *  &#64;UiThread

 *  public abstract void setText(&#64;NonNull String text) { ... }

 * }</pre>

 *

 * {@hide}

 */

@Retention(SOURCE)

@Target({METHOD,CONSTRUCTOR,TYPE})

public @interface UiThread {

}
 
 No newline at end of file

core/java/android/annotation/WorkerThread.java

0 → 100644
+42 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2015 The Android Open Source Project

 *

 * 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 android.annotation;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



import static java.lang.annotation.ElementType.CONSTRUCTOR;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.TYPE;

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



/**

 * Denotes that the annotated method should only be called on a worker thread.

 * If the annotated element is a class, then all methods in the class should be called

 * on a worker thread.

 * <p>

 * Example:

 * <pre>{@code

 *  (&#64;WorkerThread

 *  protected abstract FilterResults performFiltering(CharSequence constraint);

 * }</pre>

 *

 * {@hide}

 */

@Retention(SOURCE)

@Target({METHOD,CONSTRUCTOR,TYPE})

public @interface WorkerThread {

}
 
 No newline at end of file