summaryrefslogtreecommitdiffstats
path: root/sched/src/com/android/sched/util/RunnableHooks.java
blob: 07430fca7c972c9d22c43b957025df77af5e0e73 (plain)
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
/*
 * Copyright (C) 2013 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 com.android.sched.util;

import com.google.common.collect.Lists;

import com.android.sched.util.config.HasKeyId;
import com.android.sched.util.config.ThreadConfig;
import com.android.sched.util.config.id.ObjectId;

import java.util.ArrayList;
import java.util.List;

import javax.annotation.Nonnull;

/**
 * A class to add, remove and execute hooks. Each instance of this class is registered as a runtime
 * shutdown hook ({@link Runtime#addShutdownHook}) but can be managed by the user in order to
 * trigger hooks at another level than {@link Runtime#addShutdownHook(Thread)}.
 *
 * Also declare a general purpose thread local {@code Config} shutdown hooks.
 */
@HasKeyId
public class RunnableHooks {
  @Nonnull
  private static final ObjectId<RunnableHooks> SHUTDOWN_HOOKS =
      new ObjectId<RunnableHooks>("sched.internal.shutdown", RunnableHooks.class);

  @Nonnull
  private final List<Runnable> hooks = new ArrayList<Runnable>();

  public synchronized void addHook(@Nonnull Runnable hook) {
    assert !hooks.contains(hook);

    hooks.add(hook);
  }

  public synchronized void removeHook(@Nonnull Runnable hook) {
    assert hooks.contains(hook);

    hooks.remove(hook);
  }

  public synchronized void runHooks() {
    for (Runnable hook : Lists.reverse(hooks)) {
      hook.run();
    }

    hooks.clear();
  }

  /**
   * @return general purpose thread local {@code Config} shutdown hooks.
   */
  @Nonnull
  public static RunnableHooks getShutdownHooks() {
    return ThreadConfig.get(SHUTDOWN_HOOKS);
  }
}