NotificationSignalExtractor.java revision f953664dc17dca23bd724bd64f89189c16c83263
1/*
2* Copyright (C) 2014 The Android Open Source Project
3*
4* Licensed under the Apache License, Version 2.0 (the "License");
5* you may not use this file except in compliance with the License.
6* You may obtain a copy of the License at
7*
8*      http://www.apache.org/licenses/LICENSE-2.0
9*
10* Unless required by applicable law or agreed to in writing, software
11* distributed under the License is distributed on an "AS IS" BASIS,
12* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13* See the License for the specific language governing permissions and
14* limitations under the License.
15*/
16
17package com.android.server.notification;
18
19import android.content.Context;
20
21/**
22 * Extracts signals that will be useful to the {@link NotificationComparator} and caches them
23 *  on the {@link NotificationManagerService.NotificationRecord} object. These annotations will
24 *  not be passed on to {@link android.service.notification.NotificationListenerService}s.
25 */
26public interface NotificationSignalExtractor {
27
28    /** One-time initialization. */
29    public void initialize(Context context);
30
31    /**
32     * Called once per notification that is posted or updated.
33     *
34     * @return null if the work is done, or a future if there is more to do. The
35     * {@link RankingFuture} will be run on a worker thread, and if notifications are re-ordered
36     * by that execution, the {@link NotificationManagerService} may send order update
37     * events to the {@link android.service.notification.NotificationListenerService}s.
38     */
39    public RankingFuture process(NotificationManagerService.NotificationRecord notification);
40
41}
42