model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/ArgumentDefinition.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.base.MoreObjects;
  13 import java.util.Optional;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.eclipse.jdt.annotation.Nullable;
  16 import org.opendaylight.yangtools.concepts.Immutable;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18
  19 /**
  20  * Definition of an argument to a YANG statement.
  21  */
  22 public abstract sealed class ArgumentDefinition implements Immutable {
  23     private static final class YinAttribute extends ArgumentDefinition {
  24         YinAttribute(final QName argumentName) {
  25             super(argumentName);
  26         }
  27
  28         @Override
  29         public boolean isYinElement() {
  30             return false;
  31         }
  32     }
  33
  34     private static final class YinElement extends ArgumentDefinition {
  35         YinElement(final QName argumentName) {
  36             super(argumentName);
  37         }
  38
  39         @Override
  40         public boolean isYinElement() {
  41             return true;
  42         }
  43     }
  44
  45     private final @NonNull QName argumentName;
  46
  47     ArgumentDefinition(final QName argumentName) {
  48         this.argumentName = requireNonNull(argumentName);
  49     }
  50
  51     public static @NonNull ArgumentDefinition of(final QName argumentName, final boolean yinElement) {
  52         return yinElement ? new YinElement(argumentName) : new YinAttribute(argumentName);
  53     }
  54
  55     public static @NonNull Optional<ArgumentDefinition> ofNullable(final @Nullable QName argumentName,
  56             final boolean yinElement) {
  57         return argumentName == null ? Optional.empty() : Optional.of(of(argumentName, yinElement));
  58     }
  59
  60     public final @NonNull QName argumentName() {
  61         return argumentName;
  62     }
  63
  64     /**
  65      * Returns true, if argument of statement is represented as value of YIN element. If argument of statement is
  66      * represented as argument of YIN element, returns false.
  67      *
  68      * @return returns true, if statement argument is represented as value of YIN element, otherwise returns false.
  69      */
  70     public abstract boolean isYinElement();
  71
  72     @Override
  73     public final int hashCode() {
  74         return Boolean.hashCode(isYinElement()) * 31 + argumentName.hashCode();
  75     }
  76
  77     @Override
  78     public final boolean equals(final Object obj) {
  79         return this == obj || obj instanceof ArgumentDefinition other && isYinElement() == other.isYinElement()
  80             && argumentName.equals(other.argumentName);
  81     }
  82
  83     @Override
  84     public final String toString() {
  85         return MoreObjects.toStringHelper(ArgumentDefinition.class)
  86             .add("argumentName", argumentName)
  87             .add("yinElement", isYinElement())
  88             .toString();
  89     }
  90 }