summaryrefslogtreecommitdiff
path: root/adservices/service-core/java/com/android/adservices/service/measurement/EventTrigger.java
blob: 91b13854f3509f3289d5249f56186bce9a3b8325 (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
 * Copyright (C) 2022 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.adservices.service.measurement;

import com.android.adservices.service.measurement.aggregation.AggregatableAttributionTrigger;
import com.android.adservices.service.measurement.util.UnsignedLong;

import java.util.Objects;
import java.util.Optional;

/** Event trigger containing trigger data, priority, de-deup key and filters info. */
public class EventTrigger {
    private UnsignedLong mTriggerData;
    private long mTriggerPriority;
    private UnsignedLong mDedupKey;
    private Optional<FilterData> mFilter;
    private Optional<FilterData> mNotFilter;

    private EventTrigger() {
        mFilter = Optional.empty();
        mNotFilter = Optional.empty();
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof EventTrigger)) {
            return false;
        }
        EventTrigger eventTrigger = (EventTrigger) obj;
        return Objects.equals(mTriggerData, eventTrigger.mTriggerData)
                && mTriggerPriority == eventTrigger.mTriggerPriority
                && Objects.equals(mDedupKey, eventTrigger.mDedupKey)
                && Objects.equals(mFilter, eventTrigger.mFilter)
                && Objects.equals(mNotFilter, eventTrigger.mNotFilter);
    }

    @Override
    public int hashCode() {
        return Objects.hash(mTriggerData, mTriggerPriority, mDedupKey, mFilter, mNotFilter);
    }

    /** Returns trigger_data for the event. */
    public UnsignedLong getTriggerData() {
        return mTriggerData;
    }

    /** Trigger priority. */
    public long getTriggerPriority() {
        return mTriggerPriority;
    }

    /** De-deuplication key.. */
    public UnsignedLong getDedupKey() {
        return mDedupKey;
    }

    /** Filters that should match with source's. */
    public Optional<FilterData> getFilterData() {
        return mFilter;
    }

    /** Filters that should not match with source's. */
    public Optional<FilterData> getNotFilterData() {
        return mNotFilter;
    }

    /** Builder for {@link AggregatableAttributionTrigger}. */
    public static final class Builder {
        private final EventTrigger mBuilding;

        public Builder() {
            mBuilding = new EventTrigger();
        }

        /** See {@link EventTrigger#getTriggerData()}. */
        public EventTrigger.Builder setTriggerData(UnsignedLong triggerData) {
            mBuilding.mTriggerData = triggerData;
            return this;
        }

        /** See {@link EventTrigger#getTriggerPriority()}. */
        public EventTrigger.Builder setTriggerPriority(Long triggerPriority) {
            mBuilding.mTriggerPriority = triggerPriority;
            return this;
        }

        /** See {@link EventTrigger#getDedupKey()}. */
        public EventTrigger.Builder setDedupKey(UnsignedLong dedupKey) {
            mBuilding.mDedupKey = dedupKey;
            return this;
        }

        /** See {@link EventTrigger#getFilterData()}. */
        public EventTrigger.Builder setFilter(FilterData filterData) {
            mBuilding.mFilter = Optional.ofNullable(filterData);
            return this;
        }

        /** See {@link EventTrigger#getNotFilterData()} ()}. */
        public EventTrigger.Builder setNotFilter(FilterData notFilterData) {
            mBuilding.mNotFilter = Optional.ofNullable(notFilterData);
            return this;
        }

        /** Build the {@link EventTrigger}. */
        public EventTrigger build() {
            return mBuilding;
        }
    }
}