revision,
+ final String localName) {
+ return create(QNameModule.create(namespace, revision), localName);
}
/**
- * QName Constructor.
+ * Creates new QName.
*
- * @param namespace
- * the namespace assigned to the YANG module
- * @param revision
- * the revision of the YANG module
- * @param localName
- * YANG schema identifier
+ * @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 QName(final URI namespace, final Date revision, final String localName) {
- this(namespace, revision, null, localName);
+ public static @NonNull QName create(final String namespace, final String localName, final Revision revision) {
+ return create(QNameModule.create(XMLNamespace.of(namespace), revision), localName);
}
- public QName(final QName base, final String localName) {
- this(base.getNamespace(), base.getRevision(), base.getPrefix(), 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}.
+ * @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} is not valid URI or {@code revision} does not conform
+ * to {@code YYYY-mm-dd}.
+ */
+ public static @NonNull QName create(final String namespace, final String revision, final String localName) {
+ return create(XMLNamespace.of(namespace), Revision.of(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 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} is not valid URI.
*/
- @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;
- }
+ public static @NonNull QName create(final String namespace, final String localName) {
+ return create(XMLNamespace.of(namespace), localName);
+ }
- this.localName = checkLocalName(input.substring(input.indexOf(")") + 1));
- this.prefix = null;
- this.module = QNameModule.create(namespace, revision);
+ /**
+ * 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 namespace is not valid URI.
+ */
+ public static @NonNull QName create(final XMLNamespace namespace, final String localName) {
+ return new QName(namespace, 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);
+ /**
+ * Read a QName from a DataInput. The format is expected to match the output format of {@link #writeTo(DataOutput)}.
+ *
+ * @param in DataInput to read
+ * @return A QName instance
+ * @throws IOException if I/O error occurs
+ */
+ public static @NonNull QName readFrom(final DataInput in) throws IOException {
+ if (in instanceof QNameAwareDataInput) {
+ return ((QNameAwareDataInput) in).readQName();
}
- throw new IllegalArgumentException("Invalid input:" + input);
+
+ final QNameModule module = QNameModule.readFrom(in);
+ return new QName(module, checkLocalName(in.readUTF()));
}
/**
- * Returns XMLNamespace assigned to the YANG module.
+ * Creates new QName composed of specified module and local name. This method does not perform lexical checking of
+ * localName, and it is the caller's responsibility to performs these checks.
*
- * @return XMLNamespace assigned to the YANG module.
+ *
+ * When in doubt, use {@link #create(QNameModule, String)} instead.
+ *
+ * @param qnameModule Namespace and revision enclosed as a QNameModule
+ * @param localName Local name part of QName, required to have been validated
+ * @return Instance of QName
+ * @throws NullPointerException if any of the arguments is null
*/
- public URI getNamespace() {
- return module.getNamespace();
+ @Beta
+ public static @NonNull QName unsafeOf(final @NonNull QNameModule qnameModule, final @NonNull String localName) {
+ return new QName(qnameModule, localName);
}
/**
- * Returns YANG schema identifier which were defined for this node in the
- * YANG module
+ * Get the module component of the QName.
*
- * @return YANG schema identifier which were defined for this node in the
- * YANG module
+ * @return Module component
*/
- public String getLocalName() {
- return localName;
+ public @NonNull QNameModule getModule() {
+ return module;
}
/**
- * Returns revision of the YANG module if the module has defined revision,
- * otherwise returns null
+ * Returns XMLNamespace assigned to the YANG module.
*
- * @return revision of the YANG module if the module has defined revision,
- * otherwise returns null
+ * @return XMLNamespace assigned to the YANG module.
*/
- public Date getRevision() {
- return module.getRevision();
+ public @NonNull XMLNamespace getNamespace() {
+ return module.getNamespace();
}
/**
- * Returns locally defined prefix assigned to local name
+ * Returns revision of the YANG module if the module has defined revision.
*
- * @return locally defined prefix assigned to local name
+ * @return revision of the YANG module if the module has defined revision.
*/
- public String getPrefix() {
- return prefix;
+ public @NonNull Optional getRevision() {
+ return module.getRevision();
+ }
+
+ @Override
+ public @NonNull 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 : new QName(cacheMod, getLocalName().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 + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
- result = prime * result + ((getFormattedRevision() == null) ? 0 : getFormattedRevision().hashCode());
- return result;
+ if (hash == 0) {
+ hash = Objects.hash(module, getLocalName());
+ }
+ return hash;
}
+ /**
+ * Compares the specified object with this list for equality. Returns {@code true} 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 obj the object to be compared for equality with this QName
+ * @return {@code true} if the specified object is equal to this QName
+ */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
@@ -233,132 +313,89 @@ public final class QName implements Immutable, Serializable, Comparable {
return false;
}
final QName other = (QName) obj;
- if (localName == null) {
- if (other.localName != null) {
- return false;
- }
- } else if (!localName.equals(other.localName)) {
- return false;
- }
- if (getNamespace() == null) {
- if (other.getNamespace() != null) {
- return false;
- }
- } else if (!getNamespace().equals(other.getNamespace())) {
- return false;
- }
- if (getFormattedRevision() == null) {
- if (other.getFormattedRevision() != null) {
- return false;
- }
- } else if (!getRevision().equals(other.getRevision())) {
- return false;
- }
- return true;
- }
-
- public static QName create(final QName base, final String localName){
- return new QName(base, localName);
- }
-
- public static QName create(final URI namespace, final Date revision, final String localName){
- return new QName(namespace, revision, localName);
- }
-
-
- public static QName create(final String namespace, final String revision, final String localName) throws IllegalArgumentException{
- final URI namespaceUri;
- try {
- namespaceUri = new URI(namespace);
- } catch (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);
+ return Objects.equals(getLocalName(), other.getLocalName()) && module.equals(other.module);
}
@Override
- public String toString() {
- StringBuilder sb = new StringBuilder();
- if (getNamespace() != null) {
- sb.append(QNAME_LEFT_PARENTHESIS + getNamespace());
-
- if (getFormattedRevision() != null) {
- sb.append(QNAME_REVISION_DELIMITER + getFormattedRevision());
- }
- sb.append(QNAME_RIGHT_PARENTHESIS);
+ public @NonNull String toString() {
+ final StringBuilder sb = new StringBuilder().append('(').append(getNamespace());
+ final Optional rev = getRevision();
+ if (rev.isPresent()) {
+ sb.append("?revision=").append(rev.get());
}
- sb.append(localName);
- return sb.toString();
- }
-
- public String getFormattedRevision() {
- return module.getFormattedRevision();
+ return sb.append(')').append(getLocalName()).toString();
}
- public QName withoutRevision() {
- return QName.create(getNamespace(), null, localName);
+ @Override
+ public @NonNull QName bindTo(final QNameModule namespace) {
+ return module.equals(namespace) ? this : super.bindTo(namespace);
}
- public static Date parseRevision(final String formatedDate) {
- try {
- return getRevisionFormat().parse(formatedDate);
- } catch (ParseException| RuntimeException e) {
- throw new IllegalArgumentException(String.format("Revision '%s'is not in a supported format", formatedDate), e);
- }
+ /**
+ * Returns a QName with the same namespace and local name, but with no revision. If this QName does not have
+ * a Revision, this object is returned.
+ *
+ * @return a QName with the same namespace and local name, but with no revision.
+ */
+ public @NonNull QName withoutRevision() {
+ final QNameModule newModule;
+ return (newModule = module.withoutRevision()) == module ? this : new QName(newModule, getLocalName());
}
- public static String formattedRevision(final Date revision) {
- if(revision == null) {
- return null;
- }
- return getRevisionFormat().format(revision);
+ /**
+ * Formats {@link Revision} representing revision to format {@code YYYY-mm-dd}
+ *
+ *
+ * YANG Specification defines format for {@code revision<} as YYYY-mm-dd. This format for revision is reused across
+ * multiple places such as capabilities URI, YANG modules, etc.
+ *
+ * @param revision Date object to format
+ * @return String representation or null if the input was null.
+ */
+ public static @Nullable String formattedRevision(final Optional revision) {
+ return revision.map(Revision::toString).orElse(null);
}
+ /**
+ * Compares this QName to other, without comparing revision.
+ *
+ *
+ * Compares instance of this to other instance of QName and returns true if both instances have equal
+ * {@code localName} ({@link #getLocalName()}) and @{code namespace} ({@link #getNamespace()}).
+ *
+ * @param other Other QName. Must not be null.
+ * @return true if this instance and other have equals localName and namespace.
+ * @throws NullPointerException if {@code other} is null.
+ */
public boolean isEqualWithoutRevision(final QName other) {
- return localName.equals(other.getLocalName()) && Objects.equals(getNamespace(), other.getNamespace());
+ return getLocalName().equals(other.getLocalName()) && Objects.equals(getNamespace(), other.getNamespace());
}
+ // FIXME: this comparison function looks odd. We are sorting first by local name and then by module? What is
+ // the impact on iteration order of SortedMap?
@Override
- public int compareTo(final QName other) {
+ @SuppressWarnings("checkstyle:parameterName")
+ public int compareTo(final QName o) {
// compare mandatory localName parameter
- int result = localName.compareTo(other.localName);
+ int result = getLocalName().compareTo(o.getLocalName());
if (result != 0) {
return result;
}
+ return module.compareTo(o.module);
+ }
- // compare nullable namespace parameter
- if (getNamespace() == null) {
- if (other.getNamespace() != null) {
- return -1;
- }
- } else {
- if (other.getNamespace() == null) {
- return 1;
- }
- result = getNamespace().compareTo(other.getNamespace());
- if (result != 0) {
- return result;
- }
- }
-
- // compare nullable revision parameter
- if (getRevision() == null) {
- if (other.getRevision() != null) {
- return -1;
- }
+ @Override
+ public void writeTo(final DataOutput out) throws IOException {
+ if (out instanceof QNameAwareDataOutput) {
+ ((QNameAwareDataOutput) out).writeQName(this);
} else {
- if (other.getRevision() == null) {
- return 1;
- }
- result = getRevision().compareTo(other.getRevision());
- if (result != 0) {
- return result;
- }
+ module.writeTo(out);
+ out.writeUTF(getLocalName());
}
-
- return result;
}
+ @Override
+ Object writeReplace() {
+ return new QNv1(this);
+ }
}