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