model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/UnrecognizedStatement.java

   1 /*
   2  * Copyright (c) 2017 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.stmt;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.opendaylight.yangtools.yang.common.Empty;
  12
  13 /**
  14  * Common interface for unrecognized unknown statements. An {@link UnrecognizedStatement} is an instance of a statement
  15  * defined via an {@code extension} statement, for which the parser did not have semantic support (in which case the
  16  * statement would result in a corresponding semantic subclass of {@link UnknownStatement}).
  17  *
  18  * <p>
  19  * This construct does not have a {@link UnknownEffectiveStatement} counterpart because we cannot reasonably build an
  20  * effective model of something we do not recognize.
  21  */
  22 @Beta
  23 public interface UnrecognizedStatement extends UnknownStatement<Object> {
  24     /**
  25      * {@inheritDoc}
  26      *
  27      * <p>
  28      * This method can returns
  29      * <ul>
  30      *   <li>{@link String} if the statement has an argument</li>
  31      *   <li>{@link Empty} if the statement does not have an argument</li>
  32      * </ul>
  33      */
  34     @Override
  35     Object argument();
  36 }