1 /*
2  * Copyright (C) 2021 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 
17 package com.android.queryable.queries;
18 
19 import android.os.Bundle;
20 
21 import androidx.annotation.CheckResult;
22 
23 import com.android.queryable.Queryable;
24 
25 /** Query for a single key in a {@link Bundle}. */
26 public interface BundleKeyQuery<E extends Queryable> extends Queryable {
27 
28     /** Require that the key exists. */
exists()29     E exists();
30 
31     /** Require that the key does not exist. */
doesNotExist()32     E doesNotExist();
33 
34     @CheckResult
stringValue()35     StringQuery<E> stringValue();
36 
37     @CheckResult
serializableValue()38     SerializableQuery<E> serializableValue();
39 
40     @CheckResult
bundleValue()41     BundleQuery<E> bundleValue();
42 
43     /**
44      * The integer value of the key/
45      */
46     @CheckResult
integerValue()47     IntegerQuery<E> integerValue();
48 
49     /**
50      * The long value of the key/
51      */
52     @CheckResult
longValue()53     LongQuery<E> longValue();
54 
55     /**
56      * The boolean value of the key/
57      */
58     @CheckResult
booleanValue()59     BooleanQuery<E> booleanValue();
60 
61     /**
62      * The string list value of the key/
63      */
64     @CheckResult
stringListValue()65     ListQuery<E, String, StringQuery<E>> stringListValue();
66 
67     /**
68      * The integer list value of the key/
69      */
70     @CheckResult
integerListValue()71     ListQuery<E, Integer, IntegerQuery<E>> integerListValue();
72 }
73