Update model.api.Status design
[yangtools.git] / model / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / UnknownSchemaNode.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.yangtools.yang.model.api;
9
10 import org.eclipse.jdt.annotation.NonNull;
11 import org.opendaylight.yangtools.yang.common.QName;
12 import org.opendaylight.yangtools.yang.model.api.stmt.UnknownEffectiveStatement;
13
14 /**
15  * Contains the methods for getting the details about the unknown node.
16  */
17 public interface UnknownSchemaNode extends SchemaNode, CopyableNode,
18         EffectiveStatementEquivalent<UnknownEffectiveStatement<?, ?>> {
19     /**
20      * Returns QName instance with the name of the unknown node. This corresponds to
21      * {@link ExtensionDefinition#getQName()} of the {@code extension} statement which defined it.
22      *
23      * @return QName with name the name of the unknown node.
24      */
25     @NonNull QName getNodeType();
26
27     /**
28      * Returns name of the unknown node.
29      *
30      * @return string with the name of unknown node.
31      */
32     String getNodeParameter();
33 }