/*
 * Copyright (c) 2016 Cisco Systems, Inc. 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.yang.model.api;

import com.google.common.annotations.Beta;
import java.util.Collection;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.model.api.stmt.DeviateEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.UniqueEffectiveStatement;

/**
 * Interface describing YANG 'deviate' statement.
 *
 * <p>
 * The 'deviate' statement defines how the device's implementation of
 * the target node deviates from its original definition.
 * The argument is one of the strings "not-supported", "add", "replace", or "delete".
 */
@Beta
public interface DeviateDefinition extends EffectiveStatementEquivalent<DeviateEffectiveStatement> {
    /**
     * Return deviation kind.
     *
     * @return enum which describes the type of this deviate statement
     */
    DeviateKind getDeviateType();

    /**
     * Returns deviated config value.
     *
     * @return value of the deviated config statement or null if it is not deviated
     */
    Boolean getDeviatedConfig();

    /**
     * Returns deviated default value.
     *
     * @return value of the deviated default statement or null if it is not deviated
     */
    String getDeviatedDefault();

    /**
     * Returns deviated mandatory value.
     *
     * @return value of the deviated mandatory statement or null if it is not deviated
     */
    Boolean getDeviatedMandatory();

    /**
     * Returns deviated max-elements.
     *
     * @return value of the deviated max-elements statement or null if it is not deviated
     */
    Integer getDeviatedMaxElements();

    /**
     * Returns deviated min-elements.
     *
     * @return value of the deviated min-elements statement or null if it is not deviated
     */
    Integer getDeviatedMinElements();

    /**
     * Returns deviated must statements.
     *
     * @return set of the deviated must statements
     */
    Collection<? extends @NonNull MustDefinition> getDeviatedMusts();

    /**
     * Returns deviated type statement.
     *
     * @return deviated type statement or null if it is not deviated
     */
    TypeDefinition<?> getDeviatedType();

    /**
     * Returns deviated unique statements.
     *
     * @return collection of the deviated unique statements
     */
    Collection<? extends @NonNull UniqueEffectiveStatement> getDeviatedUniques();

    /**
     * Returns deviated units statement.
     *
     * @return value of the deviated units statement or null if it is not deviated
     */
    String getDeviatedUnits();
}