2 * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.common;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.collect.Interner;
13 import com.google.common.collect.Interners;
14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
15 import java.io.DataInput;
16 import java.io.DataOutput;
17 import java.io.IOException;
18 import org.eclipse.jdt.annotation.NonNullByDefault;
19 import org.eclipse.jdt.annotation.Nullable;
22 * An unresolved, unqualified {@link QName}. It is guaranteed to hold a valid {@link #getLocalName()}, in the default
23 * namespace, which is not resolved. A resolved {@link QName} can be constructed through {@link #bindTo(QNameModule)}.
27 public final class UnqualifiedQName extends AbstractQName implements Comparable<UnqualifiedQName> {
28 private static final long serialVersionUID = 1L;
29 private static final Interner<UnqualifiedQName> INTERNER = Interners.newWeakInterner();
31 private UnqualifiedQName(final String localName) {
36 * Create a new unqualified QName.
38 * @param localName The local name of this unqualified QName
39 * @return An UnqualifiedQName instance
40 * @throws NullPointerException if localName is null
41 * @throws IllegalArgumentException if localName is not a valid YANG identifier
43 public static UnqualifiedQName of(final String localName) {
44 return new UnqualifiedQName(checkLocalName(localName));
48 * Create a new unqualified QName.
50 * @param localName The local name of this unqualified QName
51 * @return An UnqualifiedQName instance, or null if localName is not valid
53 @SuppressFBWarnings(value = "NP_NONNULL_RETURN_VIOLATION", justification = "Non-grok of @Nullable")
54 public static @Nullable UnqualifiedQName tryCreate(final String localName) {
55 return isValidLocalName(localName) ? new UnqualifiedQName(localName) : null;
59 * Read an UnqualifiedQName from a DataInput. The format is expected to match the output format of
60 * {@link #writeTo(DataOutput)}.
62 * @param in DataInput to read
63 * @return An UnqualifiedQName instance
64 * @throws IOException if I/O error occurs
66 public static UnqualifiedQName readFrom(final DataInput in) throws IOException {
67 return of(in.readUTF());
71 @SuppressFBWarnings(value = "ES_COMPARING_STRINGS_WITH_EQ", justification = "Interning identity check")
72 public UnqualifiedQName intern() {
73 // Make sure to intern the string and check whether it refers to the same name as we are
74 final String name = getLocalName();
75 final String internedName = name.intern();
76 final UnqualifiedQName template = internedName == name ? this : new UnqualifiedQName(internedName);
77 return INTERNER.intern(template);
81 @SuppressWarnings("checkstyle:parameterName")
82 public int compareTo(final UnqualifiedQName o) {
83 return getLocalName().compareTo(o.getLocalName());
87 public void writeTo(final DataOutput out) throws IOException {
88 out.writeUTF(getLocalName());
92 public int hashCode() {
93 return getLocalName().hashCode();
97 public boolean equals(final @Nullable Object obj) {
98 return this == obj || obj instanceof UnqualifiedQName
99 && getLocalName().equals(((AbstractQName) obj).getLocalName());
103 public String toString() {
104 return MoreObjects.toStringHelper(this).add("localName", getLocalName()).toString();
108 Object writeReplace() {
109 return new UQNv1(this);