*/
package org.opendaylight.yangtools.yang.common;
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat;
+import com.google.common.base.Strings;
+import com.google.common.collect.Interner;
+import com.google.common.collect.Interners;
import java.io.Serializable;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-
+import javax.annotation.Nonnull;
+import javax.annotation.RegEx;
import org.opendaylight.yangtools.concepts.Immutable;
/**
* The QName from XML consists of local name of element and XML namespace, but
* for our use, we added module revision to it.
*
+ * <p>
* In YANG context QName is full name of defined node, type, procedure or
* notification. QName consists of XML namespace, YANG model revision and local
* name of defined type. It is used to prevent name clashes between nodes with
* node in the YANG module</li>
* </ul>
*
+ * <p>
* QName may also have <code>prefix</code> assigned, but prefix does not
* affect equality and identity of two QNames and carry only information
* which may be useful for serializers / deserializers.
- *
- *
*/
public final class QName implements Immutable, Serializable, Comparable<QName> {
+ private static final Interner<QName> INTERNER = Interners.newWeakInterner();
private static final long serialVersionUID = 5398411242927766414L;
static final String QNAME_REVISION_DELIMITER = "?revision=";
static final String QNAME_LEFT_PARENTHESIS = "(";
static final String QNAME_RIGHT_PARENTHESIS = ")";
- private static final Pattern QNAME_PATTERN_FULL = Pattern.compile("^\\((.+)\\" + QNAME_REVISION_DELIMITER
- + "(.+)\\)(.+)$");
- private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile("^\\((.+)\\)(.+)$");
- private static final Pattern QNAME_PATTERN_NO_NAMESPACE_NO_REVISION = Pattern.compile("^(.+)$");
+ @RegEx
+ private static final String QNAME_STRING_FULL = "^\\((.+)\\?revision=(.+)\\)(.+)$";
+ private static final Pattern QNAME_PATTERN_FULL = Pattern.compile(QNAME_STRING_FULL);
- private static final char[] ILLEGAL_CHARACTERS = new char[] { '?', '(', ')', '&' };
+ @RegEx
+ private static final String QNAME_STRING_NO_REVISION = "^\\((.+)\\)(.+)$";
+ private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile(QNAME_STRING_NO_REVISION);
- // Mandatory
+ @RegEx
+ private static final String QNAME_STRING_NO_NAMESPACE_NO_REVISION = "^(.+)$";
+ private static final Pattern QNAME_PATTERN_NO_NAMESPACE_NO_REVISION =
+ Pattern.compile(QNAME_STRING_NO_NAMESPACE_NO_REVISION);
+
+ private static final char[] ILLEGAL_CHARACTERS = new char[] { '?', '(', ')', '&', ':' };
+
+ // Non-null
private final QNameModule module;
- // Mandatory
+ // Non-null
private final String localName;
- // Nullable
- private final String prefix;
+ private transient int hash;
- private QName(final QNameModule module, final String prefix, final String localName) {
+ private QName(final QNameModule module, final String localName) {
this.localName = checkLocalName(localName);
- this.prefix = prefix;
this.module = module;
}
- /**
- * QName Constructor.
- *
- * @param namespace
- * the namespace assigned to the YANG module
- * @param revision
- * the revision of the YANG module
- * @param prefix
- * locally defined prefix assigned to local name
- * @param localName
- * YANG schema identifier
- *
- */
- public QName(final URI namespace, final Date revision, final String prefix, final String localName) {
- this(QNameModule.create(namespace, revision), prefix, localName);
- }
-
/**
* QName Constructor.
*
* YANG schema identifier
*/
public QName(final URI namespace, final String localName) {
- this(namespace, null, "", localName);
+ this(QNameModule.create(namespace, null), localName);
}
private static String checkLocalName(final String localName) {
- if (localName == null) {
- throw new IllegalArgumentException("Parameter 'localName' may not be null.");
- }
- if (localName.length() == 0) {
- throw new IllegalArgumentException("Parameter 'localName' must be a non-empty string.");
- }
+ checkArgument(localName != null, "Parameter 'localName' may not be null.");
+ checkArgument(!Strings.isNullOrEmpty(localName), "Parameter 'localName' must be a non-empty string.");
- for (char c : ILLEGAL_CHARACTERS) {
+ for (final char c : ILLEGAL_CHARACTERS) {
if (localName.indexOf(c) != -1) {
throw new IllegalArgumentException(String.format(
"Parameter 'localName':'%s' contains illegal character '%s'", localName, c));
return localName;
}
+ public static QName create(final String input) {
+ Matcher matcher = QNAME_PATTERN_FULL.matcher(input);
+ if (matcher.matches()) {
+ final String namespace = matcher.group(1);
+ final String revision = matcher.group(2);
+ final String localName = matcher.group(3);
+ return create(namespace, revision, localName);
+ }
+ matcher = QNAME_PATTERN_NO_REVISION.matcher(input);
+ if (matcher.matches()) {
+ final URI namespace = URI.create(matcher.group(1));
+ final String localName = matcher.group(2);
+ return new QName(namespace, localName);
+ }
+ matcher = QNAME_PATTERN_NO_NAMESPACE_NO_REVISION.matcher(input);
+ if (matcher.matches()) {
+ final String localName = matcher.group(1);
+ return new QName((URI) null, localName);
+ }
+ throw new IllegalArgumentException("Invalid input:" + input);
+ }
+
+ public static QName create(final QName base, final String localName) {
+ return create(base.getModule(), localName);
+ }
+
/**
- * QName Constructor.
+ * Creates new QName.
+ *
+ * @param qnameModule
+ * Namespace and revision enclosed as a QNameModule
+ * @param localName
+ * Local name part of QName. MUST NOT BE null.
+ * @return Instance of QName
+ */
+ public static QName create(final QNameModule qnameModule, final String localName) {
+ return new QName(requireNonNull(qnameModule, "module may not be null"), localName);
+ }
+
+ /**
+ * Creates new QName.
*
* @param namespace
- * the namespace assigned to the YANG module
+ * Namespace of QName or null if namespace is undefined.
* @param revision
- * the revision of the YANG module
+ * Revision of namespace or null if revision is unspecified.
* @param localName
- * YANG schema identifier
- *
- * @deprecated Use {@link #create(URI, Date, String)} instead.
+ * Local name part of QName. MUST NOT BE null.
+ * @return Instance of QName
*/
- @Deprecated
- public QName(final URI namespace, final Date revision, final String localName) {
- this(QNameModule.create(namespace, revision), null, localName);
+ public static QName create(final URI namespace, final Date revision, final String localName) {
+ return create(QNameModule.create(namespace, revision), localName);
}
/**
- * Construct new QName which reuses namespace, revision and prefix from
- * base.
+ * Creates new QName.
*
- * @param base
+ * @param namespace
+ * Namespace of QName or null if namespace is undefined.
+ * @param revision
+ * Revision of namespace or null if revision is unspecified.
* @param localName
- * @deprecated Use {@link #create(QName, String)} instead.
+ * Local name part of QName. MUST NOT BE null.
+ * @return Instance of QName
*/
- @Deprecated
- public QName(final QName base, final String localName) {
- this(base.getNamespace(), base.getRevision(), base.getPrefix(), localName);
+ public static QName create(final String namespace, final String localName, final Date revision) {
+ final URI namespaceUri = parseNamespace(namespace);
+ return create(QNameModule.create(namespaceUri, revision), localName);
}
/**
- * @deprecated Use {@link #create(String)} instead. This implementation is
- * broken.
+ * Creates new QName.
+ *
+ * @param namespace
+ * Namespace of QName, MUST NOT BE Null.
+ * @param revision
+ * Revision of namespace / YANG module. MUST NOT BE null, MUST BE
+ * in format <code>YYYY-mm-dd</code>.
+ * @param localName
+ * Local name part of QName. MUST NOT BE null.
+ * @return A new QName
+ * @throws NullPointerException
+ * If any of parameters is null.
+ * @throws IllegalArgumentException
+ * If <code>namespace</code> is not valid URI or
+ * <code>revision</code> is not according to format
+ * <code>YYYY-mm-dd</code>.
*/
- @Deprecated
- public QName(final String input) throws ParseException {
- final String nsAndRev = input.substring(input.indexOf("(") + 1, input.indexOf(")"));
- final Date revision;
- final URI namespace;
- if (nsAndRev.contains("?")) {
- String[] splitted = nsAndRev.split("\\?");
- namespace = URI.create(splitted[0]);
- revision = getRevisionFormat().parse(splitted[1]);
- } else {
- namespace = URI.create(nsAndRev);
- revision = null;
- }
-
- this.localName = checkLocalName(input.substring(input.indexOf(")") + 1));
- this.prefix = null;
- this.module = QNameModule.create(namespace, revision);
+ public static QName create(final String namespace, final String revision, final String localName) {
+ final URI namespaceUri = parseNamespace(namespace);
+ final Date revisionDate = parseRevision(revision);
+ return create(namespaceUri, revisionDate, localName);
}
- public static QName create(final String input) {
- Matcher matcher = QNAME_PATTERN_FULL.matcher(input);
- if (matcher.matches()) {
- String namespace = matcher.group(1);
- String revision = matcher.group(2);
- String localName = matcher.group(3);
- return create(namespace, revision, localName);
- }
- matcher = QNAME_PATTERN_NO_REVISION.matcher(input);
- if (matcher.matches()) {
- URI namespace = URI.create(matcher.group(1));
- String localName = matcher.group(2);
- return new QName(namespace, localName);
- }
- matcher = QNAME_PATTERN_NO_NAMESPACE_NO_REVISION.matcher(input);
- if (matcher.matches()) {
- String localName = matcher.group(1);
- return new QName((URI) null, localName);
- }
- throw new IllegalArgumentException("Invalid input:" + input);
+ /**
+ * Creates new QName.
+ *
+ * @param namespace
+ * Namespace of QName, MUST NOT BE Null.
+ * @param localName
+ * Local name part of QName. MUST NOT BE null.
+ * @return A new QName
+ * @throws NullPointerException
+ * If any of parameters is null.
+ * @throws IllegalArgumentException
+ * If <code>namespace</code> is not valid URI.
+ */
+ public static QName create(final String namespace, final String localName) {
+ return create(parseNamespace(namespace), null, localName);
}
/**
/**
* Returns YANG schema identifier which were defined for this node in the
- * YANG module
+ * YANG module.
*
* @return YANG schema identifier which were defined for this node in the
* YANG module
/**
* Returns revision of the YANG module if the module has defined revision,
- * otherwise returns <code>null</code>
+ * otherwise returns <code>null</code>.
*
* @return revision of the YANG module if the module has defined revision,
* otherwise returns <code>null</code>
}
/**
- * Returns locally defined prefix assigned to local name
+ * Return an interned reference to a equivalent QName.
*
- * @return locally defined prefix assigned to local name
+ * @return Interned reference, or this object if it was interned.
*/
- public String getPrefix() {
- return prefix;
+ public QName intern() {
+ // We also want to make sure we keep the QNameModule cached
+ final QNameModule cacheMod = module.intern();
+
+ // Identity comparison is here on purpose, as we are deciding whether to potentially store 'qname' into the
+ // interner. It is important that it does not hold user-supplied reference (such a String instance from
+ // parsing of an XML document).
+ final QName template = cacheMod == module ? this : QName.create(cacheMod, localName.intern());
+
+ return INTERNER.intern(template);
}
@Override
public int hashCode() {
- final int prime = 31;
- int result = 1;
- result = prime * result + ((localName == null) ? 0 : localName.hashCode());
- result = prime * result + module.hashCode();
- return result;
+ if (hash == 0) {
+ hash = Objects.hash(module, localName);
+ }
+ return hash;
}
/**
- *
* Compares the specified object with this list for equality. Returns
* <tt>true</tt> if and only if the specified object is also instance of
* {@link QName} and its {@link #getLocalName()}, {@link #getNamespace()} and
* {@link #getRevision()} are equals to same properties of this instance.
*
- * @param o the object to be compared for equality with this QName
+ * @param obj the object to be compared for equality with this QName
* @return <tt>true</tt> if the specified object is equal to this QName
*
*/
return false;
}
final QName other = (QName) obj;
- if (localName == null) {
- if (other.localName != null) {
- return false;
- }
- } else if (!localName.equals(other.localName)) {
- return false;
- }
- return module.equals(other.module);
- }
-
- public static QName create(final QName base, final String localName) {
- return new QName(base, localName);
- }
-
- /**
- * Creates new QName.
- *
- * @param qnameModule
- * Namespace and revision enclosed as a QNameModule
- * @param prefix
- * Namespace prefix
- * @param localName
- * Local name part of QName. MUST NOT BE null.
- * @return Instance of QName
- */
- public static QName create(final QNameModule module, final String prefix, final String localName) {
- if (module == null) {
- throw new NullPointerException("module may not be null");
- }
- return new QName(module, prefix, localName);
+ return Objects.equals(localName, other.localName) && module.equals(other.module);
}
- /**
- * Creates new QName.
- *
- * @param qnameModule
- * Namespace and revision enclosed as a QNameModule
- * @param localName
- * Local name part of QName. MUST NOT BE null.
- * @return Instance of QName
- */
- public static QName create(final QNameModule qnameModule, final String localName) {
- return new QName(qnameModule, null, localName);
- }
-
- /**
- * Creates new QName.
- *
- * @param namespace
- * Namespace of QName or null if namespace is undefined.
- * @param revision
- * Revision of namespace or null if revision is unspecified.
- * @param localName
- * Local name part of QName. MUST NOT BE null.
- * @return Instance of QName
- */
- public static QName create(final URI namespace, final Date revision, final String localName) {
- return new QName(QNameModule.create(namespace, revision), null, localName);
- }
-
- /**
- *
- * Creates new QName.
- *
- * @param namespace
- * Namespace of QName, MUST NOT BE Null.
- * @param revision
- * Revision of namespace / YANG module. MUST NOT BE null, MUST BE
- * in format <code>YYYY-mm-dd</code>.
- * @param localName
- * Local name part of QName. MUST NOT BE null.
- * @return
- * @throws NullPointerException
- * If any of paramaters is null.
- * @throws IllegalArgumentException
- * If <code>namespace</code> is not valid URI or
- * <code>revision</code> is not according to format
- * <code>YYYY-mm-dd</code>.
- */
- public static QName create(final String namespace, final String revision, final String localName)
- throws IllegalArgumentException {
- final URI namespaceUri;
+ private static URI parseNamespace(final String namespace) {
try {
- namespaceUri = new URI(namespace);
- } catch (URISyntaxException ue) {
+ return new URI(namespace);
+ } catch (final URISyntaxException ue) {
throw new IllegalArgumentException(String.format("Namespace '%s' is not a valid URI", namespace), ue);
}
-
- Date revisionDate = parseRevision(revision);
- return create(namespaceUri, revisionDate, localName);
}
@Override
public String toString() {
- StringBuilder sb = new StringBuilder();
+ final StringBuilder sb = new StringBuilder();
if (getNamespace() != null) {
- sb.append(QNAME_LEFT_PARENTHESIS + getNamespace());
+ sb.append(QNAME_LEFT_PARENTHESIS).append(getNamespace());
if (getFormattedRevision() != null) {
- sb.append(QNAME_REVISION_DELIMITER + getFormattedRevision());
+ sb.append(QNAME_REVISION_DELIMITER).append(getFormattedRevision());
}
sb.append(QNAME_RIGHT_PARENTHESIS);
}
}
/**
- * Return string representation of revision in format
- * <code>YYYY-mm-dd</code>
+ * Return string representation of revision in format <code>YYYY-mm-dd</code>
*
+ * <p>
* YANG Specification defines format for <code>revision</code> as
* YYYY-mm-dd. This format for revision is reused accross multiple places
* such as capabilities URI, YANG modules, etc.
* @return copy of this QName with revision and prefix unset.
*/
public QName withoutRevision() {
- return QName.create(getNamespace(), null, localName);
+ return create(getNamespace(), null, localName);
}
+ @SuppressWarnings("checkstyle:illegalCatch")
public static Date parseRevision(final String formatedDate) {
try {
return getRevisionFormat().parse(formatedDate);
* Formats {@link Date} representing revision to format
* <code>YYYY-mm-dd</code>
*
+ * <p>
* YANG Specification defines format for <code>revision</code> as
* YYYY-mm-dd. This format for revision is reused accross multiple places
* such as capabilities URI, YANG modules, etc.
}
/**
- *
* Compares this QName to other, without comparing revision.
*
+ * <p>
* Compares instance of this to other instance of QName and returns true if
* both instances have equal <code>localName</code> ({@link #getLocalName()}
* ) and <code>namespace</code> ({@link #getNamespace()}).
}
@Override
- public int compareTo(final QName other) {
+ public int compareTo(@Nonnull final QName other) {
// compare mandatory localName parameter
int result = localName.compareTo(other.localName);
if (result != 0) {
Code Review / yangtools.git / blobdiff