/*
 * Copyright (c) 2015 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.parser.spi.meta;

import java.util.List;

import java.util.Map;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
import java.util.Collection;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;


public interface StmtContext<A,D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {

    @Nonnull StatementSource getStatementSource();

    @Nonnull StatementSourceReference getStatementSourceReference();

    @Nonnull StatementDefinition getPublicDefinition();

    @Nullable StmtContext<?,?,?> getParentContext();

    @Nullable String rawStatementArgument();

    @Nullable A getStatementArgument();

    @Nullable List<Object> getArgumentsFromRoot();

    //<K,VT, V extends VT,N extends IdentifierNamespace<K, V>>
    //       <K, VT, V extends VT ,N extends IdentifierNamespace<K, V>> VT getFromNamespace(Class<N> type, K key)
    @Nonnull <K,V,N extends IdentifierNamespace<K, V>> V getFromNamespace(Class<N> type, K key) throws NamespaceNotAvailableException;

    <K, V, N extends IdentifierNamespace<K, V>> Map<?, ?> getAllFromNamespace(Class<N> type);

    @Nonnull StmtContext<?,?,?> getRoot();

    @Nonnull Collection<StatementContextBase<?,?,?>> declaredSubstatements();

    public Collection<StatementContextBase<?, ?, ?>> effectiveSubstatements();

    D buildDeclared();

    E buildEffective();

    public StatementContextBase<?, ?, ?>  createCopy(QNameModule newQNameModule,StatementContextBase<?, ?, ?> newParent) throws SourceException;

    interface Mutable<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>> extends StmtContext<A,D,E> {

        @Override
        StmtContext.Mutable<?,?,?> getParentContext();

        //<K,V,VT extends V,N extends IdentifierNamespace<K, V>> void addToNs(Class<N> type, K key, VT value)
        <K,V,VT extends V,N extends IdentifierNamespace<K, V>> void addToNs(Class<N> type, K key, VT value) throws NamespaceNotAvailableException;

        @Override
        StmtContext.Mutable<?,?,?> getRoot();

        ModelActionBuilder newInferenceAction(ModelProcessingPhase phase);

        <K,KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(Class<N> namespace, KT key,
                StmtContext<?, ?, ?> stmt);

    }



}