Cleanup yang.model.api.meta
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / meta / DeclaredStatement.java
1 /*
2  * Copyright (c) 2015 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.meta;
9
10 import java.util.Collection;
11 import javax.annotation.Nonnull;
12 import javax.annotation.Nullable;
13
14 /**
15  * Represents declared statement
16  *
17  * @param <A> Argument type ({@link Void} if statement does not have argument.)
18  */
19 public interface DeclaredStatement<A> extends ModelStatement<A> {
20
21     /**
22      * Returns statement argument as was present in original source.
23      *
24      * @return statement argument as was present in original source or null, if statement does not take argument.
25      */
26     @Nullable String rawArgument();
27
28     /**
29      * Returns collection of explicitly declared child statements, while preserving its original
30      * ordering from original source.
31      *
32      * @return Collection of statements, which were explicitly declared in
33      *         source of model.
34      */
35     @Nonnull Collection<? extends DeclaredStatement<?>> declaredSubstatements();
36 }