/*
 * 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.libraries.pcc.chronicle.analysis

import com.android.libraries.pcc.chronicle.api.DataTypeDescriptor
import com.android.libraries.pcc.chronicle.api.ProcessorNode
import com.android.libraries.pcc.chronicle.api.cantrip.Cantrip
import com.android.libraries.pcc.chronicle.api.policy.Policy
import com.android.libraries.pcc.chronicle.api.policy.builder.UsageType

/**
 * Defines a factory capable of building [Cantrips][Cantrip] based on a [ConnectionRequest] and a
 * given [UsageType].
 */
interface CantripFactory {
  /**
   * Builds a [Cantrip] for the [dtd] accessed via a [requester][ProcessorNode] given the
   * [usageType] and abiding by the [policy][Policy].
   */
  fun <Data> buildCantrip(
    dtd: DataTypeDescriptor,
    requester: ProcessorNode,
    policy: Policy?,
    usageType: UsageType
  ): Cantrip<Data>
}