common/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/AbstractQName.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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.common;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import org.eclipse.jdt.annotation.NonNullByDefault;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.yangtools.concepts.Identifier;
  16 import org.opendaylight.yangtools.concepts.WritableObject;
  17
  18 /**
  19  * Abstract superclass for sharing QName references, which can either be resolved {@link QName}s or unresolved
  20  * {@link UnresolvedQName.Unqualified} and {@link UnresolvedQName.Qualified}s.
  21  */
  22 @NonNullByDefault
  23 public abstract sealed class AbstractQName implements Identifier, WritableObject permits QName, UnresolvedQName {
  24     private static final long serialVersionUID = 1L;
  25
  26     private final String localName;
  27
  28     AbstractQName(final String localName) {
  29         this.localName = requireNonNull(localName);
  30     }
  31
  32     /**
  33      * Returns YANG schema identifier which were defined for this node in the YANG module.
  34      *
  35      * @return YANG schema identifier which were defined for this node in the YANG module
  36      */
  37     public final String getLocalName() {
  38         return localName;
  39     }
  40
  41     /**
  42      * Return an interned reference to an equivalent object.
  43      *
  44      * @return Interned reference, or this object if it was interned.
  45      */
  46     public abstract AbstractQName intern();
  47
  48     @Override
  49     public abstract int hashCode();
  50
  51     @Override
  52     public abstract boolean equals(@Nullable Object obj);
  53
  54     @Override
  55     public abstract String toString();
  56
  57     /**
  58      * Returns a QName with the specified namespace and the same local name as this one.
  59      *
  60      * @param namespace New namespace to use
  61      * @return a QName with specified QNameModule and same local name as this one
  62      * @throws NullPointerException if namespace is null
  63      */
  64     public QName bindTo(final QNameModule namespace) {
  65         return new QName(namespace, getLocalName());
  66     }
  67
  68     /**
  69      * Check whether a string is a valid {@code localName}.
  70      *
  71      * @param str String to check
  72      * @return True if the string usable as a local name, false otherwise
  73      */
  74     static final boolean isValidLocalName(final @Nullable String str) {
  75         return str != null && !str.isEmpty() && checkContent(str);
  76     }
  77
  78     abstract Object writeReplace();
  79
  80     static final String checkLocalName(final @Nullable String localName) {
  81         checkArgument(!localName.isEmpty(), "Parameter 'localName' must be a non-empty string.");
  82         checkArgument(checkContent(localName), "String '%s' is not a valid identifier", localName);
  83         return localName;
  84     }
  85
  86     private static boolean checkContent(final String localName) {
  87         return YangNames.IDENTIFIER_START.matches(localName.charAt(0))
  88             && YangNames.NOT_IDENTIFIER_PART.indexIn(localName, 1) == -1;
  89     }
  90 }