1 /*
2 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 *
18 * Additionally licensed with:
19 *
20 * Licensed under the Apache License, Version 2.0 (the "License");
21 * you may not use this file except in compliance with the License.
22 * You may obtain a copy of the License at
23 *
24 * http://www.apache.org/licenses/LICENSE-2.0
25 *
26 * Unless required by applicable law or agreed to in writing, software
27 * distributed under the License is distributed on an "AS IS" BASIS,
28 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29 * See the License for the specific language governing permissions and
30 * limitations under the License.
31 */
32 package org.spf4j.base;
33
34 import com.google.common.annotations.Beta;
35 import javax.annotation.ParametersAreNonnullByDefault;
36
37 /**
38 * @author Zoltan Farkas
39 */
40 @Beta
41 @ParametersAreNonnullByDefault
42 public interface ThreadLocalContextAttacher {
43
44 public interface Attached {
45
46 /**
47 * Remove context from thread.
48 */
49 void detach();
50
51 /**
52 * Returns true if the Attached Context is the first/only context in the Thread context stack.
53 * @return
54 */
55 boolean isTopOfStack();
56
57 /**
58 * Return the Thread that this context has been attached to.
59 * @return
60 */
61 Thread attachedThread();
62 }
63
64 /**
65 * Attach an execution context to the current Thread.
66 * @param ctx the Execution context.
67 * @return Information object about the operation.
68 */
69 Attached attach(ExecutionContext ctx);
70
71 }