xpath/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangLiteralExpr.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, 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.xpath.api;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import org.eclipse.jdt.annotation.Nullable;
  14
  15 /**
  16  * An XPath literal expression.
  17  *
  18  * <p>
  19  * Note that a literal may be required to hold a value of {@code instance-identifier} or {@code identityref} type,
  20  * when the corresponding {@link YangXPathExpression} was parsed from reference String specification defined in RFC7950.
  21  * When such conversion is required, it should be performed through
  22  * {@link YangXPathExpression#interpretAsQName(YangLiteralExpr)} or
  23  * {@link YangXPathExpression#interpretAsInstanceIdentifier(YangLiteralExpr)}.
  24  *
  25  * <p>
  26  * A more type-safe alternative is {@link YangQNameExpr}, which should be preferred and used whenever possible.
  27  *
  28  * @author Robert Varga
  29  */
  30 @Beta
  31 public final class YangLiteralExpr implements YangExpr {
  32     private static final long serialVersionUID = 1L;
  33     private static final YangLiteralExpr EMPTY = new YangLiteralExpr("");
  34
  35     private final String literal;
  36
  37     YangLiteralExpr(final String literal) {
  38         this.literal = requireNonNull(literal);
  39     }
  40
  41     public static YangLiteralExpr empty() {
  42         return EMPTY;
  43     }
  44
  45     public static YangLiteralExpr of(final String literal) {
  46         return literal.isEmpty() ? EMPTY : new YangLiteralExpr(literal);
  47     }
  48
  49     public String getLiteral() {
  50         return literal;
  51     }
  52
  53     @Override
  54     public int hashCode() {
  55         return literal.hashCode();
  56     }
  57
  58     @Override
  59     public boolean equals(final @Nullable Object obj) {
  60         return this == obj || obj instanceof YangLiteralExpr && literal.equals(((YangLiteralExpr) obj).literal);
  61     }
  62
  63     @Override
  64     public String toString() {
  65         return literal;
  66     }
  67
  68     protected Object readResolve() {
  69         return literal.isEmpty() ? EMPTY : this;
  70     }
  71 }