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  * Represents declared statement
  15  *
  16  * @param <A> Argument type ({@link Void} if statement does not have argument.)
  17  */
  18 public interface DeclaredStatement<A> extends ModelStatement<A> {
  19
  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      *
  30      * Returns collection of explicitly declared child statements, while preserving its original
  31      * ordering from original source.
  32      *
  33      * @return Collection of statements, which were explicitly declared in
  34      *         source of model.
  35      */
  36     @Nonnull Collection<? extends DeclaredStatement<?>> declaredSubstatements();
  37
  38 }