definition.IntentAware.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017/2021 e-voyageurs technologies
 *
 * 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 ai.tock.bot.definition

import ai.tock.shared.withoutNamespace

/**
 * Convenient interface used to compare [Intent] with [StoryDefinition].
 */
interface IntentAware {

    fun wrappedIntent(): Intent

    fun intentWithoutNamespace(): IntentWithoutNamespace = IntentWithoutNamespace(wrappedIntent().name.withoutNamespace())

    /**
     * Is it the right intent?
     */
    infix fun wrap(intent: Intent?): Boolean {
        return wrappedIntent() == intent
    }
}