org.opendaylight.yangtools.binding.KeyStep Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.binding;

import static java.util.Objects.requireNonNull;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;

/**
 * A {@link EntryObject}-based step with a {@link #key()}. It equates to a {@code node-identifier} with a
 * {@code key-predicate}.
 *
 * @param  Key type
 * @param  EntryObject type
 */
public record KeyStep, T extends EntryObject>(
        @NonNull Class type,
        @Nullable Class caseType,
        @NonNull K key) implements ExactDataObjectStep, KeyAware {
    public KeyStep {
        NodeStep.checkType(type, true);
        NodeStep.checkCaseType(caseType);
        requireNonNull(key);
    }

    public KeyStep(final @NonNull Class type, final @NonNull K key) {
        this(type, null, key);
    }
}