model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/AbstractStatementDefinition.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o.  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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import java.util.Optional;
  16 import org.eclipse.jdt.annotation.NonNullByDefault;
  17 import org.eclipse.jdt.annotation.Nullable;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19
  20 /**
  21  * Abstract utility class to handle StatementArgumentDefinition aspect of {@link StatementDefinition}. Most users should
  22  * use this class or {@link DefaultStatementDefinition}.
  23  */
  24 @Beta
  25 @NonNullByDefault
  26 public abstract class AbstractStatementDefinition implements StatementDefinition {
  27     private final QName statementName;
  28     private final @Nullable QName argumentName;
  29     private final boolean yinElement;
  30
  31     protected AbstractStatementDefinition(final QName statementName) {
  32         this(statementName, false, null);
  33     }
  34
  35     protected AbstractStatementDefinition(final QName statementName, final boolean yinElement,
  36         final @Nullable QName argumentName) {
  37         this.statementName = requireNonNull(statementName);
  38         this.yinElement = yinElement;
  39         this.argumentName = argumentName;
  40     }
  41
  42     @Override
  43     public final QName getStatementName() {
  44         return statementName;
  45     }
  46
  47     @Override
  48     public final Optional<ArgumentDefinition> getArgumentDefinition() {
  49         return ArgumentDefinition.ofNullable(argumentName, yinElement);
  50     }
  51
  52     @Override
  53     public final String toString() {
  54         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
  55     }
  56
  57     protected ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  58         helper.add("name", statementName);
  59         if (argumentName != null) {
  60             helper.add("argument", argumentName).add("yin-element", yinElement);
  61         }
  62         return helper;
  63     }
  64 }