* 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 String checkLocalName(final String localName) {
Preconditions.checkArgument(localName != null, "Parameter 'localName' may not be null.");
- Preconditions.checkArgument(!Strings.isNullOrEmpty(localName), "Parameter 'localName' must be a non-empty string.");
+ Preconditions.checkArgument(!Strings.isNullOrEmpty(localName),
+ "Parameter 'localName' must be a non-empty string.");
for (final char c : ILLEGAL_CHARACTERS) {
if (localName.indexOf(c) != -1) {
throw new IllegalArgumentException("Invalid input:" + input);
}
+ public static QName create(final QName base, final String localName) {
+ return create(base.getModule(), localName);
+ }
+
+ /**
+ * 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(Preconditions.checkNotNull(qnameModule,"module may not be 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 create(QNameModule.create(namespace, revision), 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 String namespace, final String localName, final Date revision) {
+ final URI namespaceUri = parseNamespace(namespace);
+ return create(QNameModule.create(namespaceUri, revision), 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 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>.
+ */
+ 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);
+ }
+
+ /**
+ * 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);
+ }
+
/**
* Get the module component of the QName.
*
/**
* 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>
}
/**
- *
* 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
return Objects.equals(localName, other.localName) && module.equals(other.module);
}
- public static QName create(final QName base, final String localName) {
- return create(base.getModule(), localName);
- }
-
- /**
- * 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(Preconditions.checkNotNull(qnameModule,"module may not be 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 create(QNameModule.create(namespace, revision), 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 String namespace, final String localName, final Date revision) {
- final URI namespaceUri = parseNamespace(namespace);
- return create(QNameModule.create(namespaceUri, revision), 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 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>.
- */
- 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);
- }
-
private static URI parseNamespace(final String namespace) {
try {
return new URI(namespace);
}
}
- /**
- * 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);
- }
-
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
}
/**
- * 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 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()}).