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.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import java.util.Optional;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.opendaylight.yangtools.concepts.Immutable;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19
  20 @Beta
  21 public abstract class ArgumentDefinition implements Immutable {
  22     private static final class YinAttribute extends ArgumentDefinition {
  23         YinAttribute(final QName argumentName) {
  24             super(argumentName);
  25         }
  26
  27         @Override
  28         public boolean isYinElement() {
  29             return false;
  30         }
  31     }
  32
  33     private static final class YinElement extends ArgumentDefinition {
  34         YinElement(final QName argumentName) {
  35             super(argumentName);
  36         }
  37
  38         @Override
  39         public boolean isYinElement() {
  40             return true;
  41         }
  42     }
  43
  44     private final @NonNull QName argumentName;
  45
  46     ArgumentDefinition(final QName argumentName) {
  47         this.argumentName = requireNonNull(argumentName);
  48     }
  49
  50     public static @NonNull ArgumentDefinition of(final QName argumentName, final boolean yinElement) {
  51         return yinElement ? new YinElement(argumentName) : new YinAttribute(argumentName);
  52     }
  53
  54     public static @NonNull Optional<ArgumentDefinition> ofNullable(final @Nullable QName argumentName,
  55             final boolean yinElement) {
  56         return argumentName == null ? Optional.empty() : Optional.of(of(argumentName, yinElement));
  57     }
  58
  59
  60     public final @NonNull QName getArgumentName() {
  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         if (this == obj) {
  80             return true;
  81         }
  82         if (!(obj instanceof ArgumentDefinition)) {
  83             return false;
  84         }
  85         final ArgumentDefinition other = (ArgumentDefinition) obj;
  86         return isYinElement() == other.isYinElement() && argumentName.equals(other.argumentName);
  87     }
  88
  89     @Override
  90     public final String toString() {
  91         return MoreObjects.toStringHelper(ArgumentDefinition.class).add("argumentName", argumentName)
  92                 .add("yinElement", isYinElement()).toString();
  93     }
  94 }