import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;
-import com.google.common.base.Strings;
+import com.google.common.base.CharMatcher;
import com.google.common.collect.Interner;
import com.google.common.collect.Interners;
import java.io.DataInput;
import org.opendaylight.yangtools.concepts.WritableObject;
/**
- * The QName from XML consists of local name of element and XML namespace, but
- * for our use, we added module revision to it.
+ * 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
- * same local name, but from different schemas.
+ * 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 same local
+ * name, but from different schemas.
+ *
+ * <p>
+ * The local name must conform to <a href="https://tools.ietf.org/html/rfc7950#section-6.2">RFC7950 Section 6.2</a>.
*
* <ul>
* <li><b>XMLNamespace</b> - {@link #getNamespace()} - the namespace assigned to the YANG module which
* <li><b>LocalName</b> - {@link #getLocalName()} - the YANG schema identifier which were defined for this
* 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>, Identifier, WritableObject {
private static final Interner<QName> INTERNER = Interners.newWeakInterner();
private static final String QNAME_STRING_NO_REVISION = "^\\((.+)\\)(.+)$";
private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile(QNAME_STRING_NO_REVISION);
- private static final char[] ILLEGAL_CHARACTERS = new char[] { '?', '(', ')', '&', ':' };
+ private static final CharMatcher IDENTIFIER_START =
+ CharMatcher.inRange('A', 'Z').or(CharMatcher.inRange('a', 'z').or(CharMatcher.is('_'))).precomputed();
+ private static final CharMatcher NOT_IDENTIFIER_PART =
+ IDENTIFIER_START.or(CharMatcher.inRange('0', '9')).or(CharMatcher.anyOf("-.")).negate().precomputed();
private final @NonNull QNameModule module;
private final @NonNull String localName;
- private transient int hash;
+ private transient int hash = 0;
- private QName(final QNameModule module, final String localName) {
+ private QName(final QNameModule module, final @NonNull String localName) {
this.module = requireNonNull(module);
this.localName = requireNonNull(localName);
}
this(QNameModule.create(namespace), checkLocalName(localName));
}
- private static String checkLocalName(final String localName) {
+ private static @NonNull String checkLocalName(final String localName) {
checkArgument(localName != null, "Parameter 'localName' may not be null.");
- 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(String.format(
- "Parameter 'localName':'%s' contains illegal character '%s'", localName, c));
- }
- }
+ checkArgument(!localName.isEmpty(), "Parameter 'localName' must be a non-empty string.");
+ checkArgument(IDENTIFIER_START.matches(localName.charAt(0)) && NOT_IDENTIFIER_PART.indexIn(localName, 1) == -1,
+ "String '%s' is not a valid identifier", localName);
return localName;
}
- public static QName create(final String input) {
+ public static @NonNull QName create(final String input) {
Matcher matcher = QNAME_PATTERN_FULL.matcher(input);
if (matcher.matches()) {
final String namespace = matcher.group(1);
throw new IllegalArgumentException("Invalid input: " + input);
}
- public static QName create(final QName base, final String localName) {
+ public static @NonNull QName create(final QName base, final String localName) {
return create(base.getModule(), localName);
}
* Local name part of QName. MUST NOT BE null.
* @return Instance of QName
*/
- public static QName create(final QNameModule qnameModule, final String localName) {
+ public static @NonNull QName create(final QNameModule qnameModule, final String localName) {
return new QName(requireNonNull(qnameModule, "module may not be null"), checkLocalName(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.
+ * @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 @Nullable Revision revision, final String localName) {
+ public static @NonNull QName create(final URI namespace, final @Nullable Revision 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.
- * @param localName
- * Local name part of QName. MUST NOT BE null.
+ * @param namespace Namespace of QName or null if namespace is undefined.
+ * @param revision Revision of namespace.
+ * @param localName Local name part of QName. MUST NOT BE null.
* @return Instance of QName
*/
- public static QName create(final URI namespace, final Optional<Revision> revision, final String localName) {
+ public static @NonNull QName create(final URI namespace, final Optional<Revision> 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.
+ * @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 Revision revision) {
- final URI namespaceUri = parseNamespace(namespace);
- return create(QNameModule.create(namespaceUri, revision), localName);
+ public static @NonNull QName create(final String namespace, final String localName, final Revision revision) {
+ return create(QNameModule.create(parseNamespace(namespace), 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.
+ * @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</code> is not valid URI or
- * <code>revision</code> is not according to format
- * <code>YYYY-mm-dd</code>.
+ * @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 QName create(final String namespace, final String revision, final String localName) {
- final URI namespaceUri = parseNamespace(namespace);
- final Revision revisionDate = Revision.of(revision);
- return create(namespaceUri, revisionDate, localName);
+ public static @NonNull QName create(final String namespace, final String revision, final String localName) {
+ return create(parseNamespace(namespace), Revision.of(revision), localName);
}
/**
* Creates new QName.
*
- * @param namespace
- * Namespace of QName, MUST NOT BE Null.
- * @param localName
- * Local name part of QName. MUST NOT BE null.
+ * @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.
+ * @throws NullPointerException If any of parameters is null.
+ * @throws IllegalArgumentException If {@code namespace} is not valid URI.
*/
- public static QName create(final String namespace, final String localName) {
+ public static @NonNull QName create(final String namespace, final String localName) {
return create(parseNamespace(namespace), localName);
}
/**
* Creates new QName.
*
- * @param namespace
- * Namespace of QName, MUST NOT BE null.
- * @param localName
- * Local name part of QName. MUST NOT BE null.
+ * @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.
+ * @throws NullPointerException If any of parameters is null.
+ * @throws IllegalArgumentException If <code>namespace</code> is not valid URI.
*/
- public static QName create(final URI namespace, final String localName) {
+ public static @NonNull QName create(final URI namespace, final String localName) {
return new QName(namespace, localName);
}
*
* @return Module component
*/
- public QNameModule getModule() {
+ public @NonNull QNameModule getModule() {
return module;
}
*
* @return XMLNamespace assigned to the YANG module.
*/
- public URI getNamespace() {
+ public @NonNull URI getNamespace() {
return module.getNamespace();
}
* @return YANG schema identifier which were defined for this node in the
* YANG module
*/
- public String getLocalName() {
+ public @NonNull String getLocalName() {
return localName;
}
*
* @return revision of the YANG module if the module has defined revision.
*/
- public Optional<Revision> getRevision() {
+ public @NonNull Optional<Revision> getRevision() {
return module.getRevision();
}
*
* @return Interned reference, or this object if it was interned.
*/
- public QName intern() {
+ public @NonNull QName intern() {
// We also want to make sure we keep the QNameModule cached
final QNameModule cacheMod = module.intern();
}
/**
- * 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
+ * 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 obj the object to be compared for equality with this QName
* @return <tt>true</tt> if the specified object is equal to this QName
- *
*/
@Override
public boolean equals(final Object obj) {
return Objects.equals(localName, other.localName) && module.equals(other.module);
}
- private static URI parseNamespace(final String namespace) {
+ private static @NonNull URI parseNamespace(final String namespace) {
try {
return new URI(namespace);
} catch (final URISyntaxException ue) {
- throw new IllegalArgumentException(String.format("Namespace '%s' is not a valid URI", namespace), ue);
+ throw new IllegalArgumentException("Namespace '" + namespace + "' is not a valid URI", ue);
}
}
@Override
- public String toString() {
+ public @NonNull String toString() {
final StringBuilder sb = new StringBuilder();
if (getNamespace() != null) {
sb.append(QNAME_LEFT_PARENTHESIS).append(getNamespace());
return sb.toString();
}
+ /**
+ * Returns a QName with the specified QNameModule and the same localname as this one.
+ *
+ * @param newModule New QNameModule to use
+ * @return a QName with specified QNameModule and same local name as this one
+ */
+ public @NonNull QName withModule(final QNameModule newModule) {
+ return new QName(newModule, localName);
+ }
+
/**
* 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 retured.
+ * a Revision, this object is returned.
*
* @return a QName with the same namespace and local name, but with no revision.
*/
- public QName withoutRevision() {
- return getRevision().isPresent() ? new QName(module.withoutRevision(), localName) : this;
+ public @NonNull QName withoutRevision() {
+ final QNameModule newModule;
+ return (newModule = module.withoutRevision()) == module ? this : new QName(newModule, localName);
}
/**
- * Formats {@link Revision} representing revision to format <code>YYYY-mm-dd</code>
+ * Formats {@link Revision} representing revision to format {@code YYYY-mm-dd}
*
* <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.
+ * 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
+ * @param revision Date object to format
* @return String representation or null if the input was null.
*/
- public static String formattedRevision(final Optional<Revision> revision) {
+ public static @Nullable String formattedRevision(final Optional<Revision> revision) {
return revision.map(Revision::toString).orElse(null);
}
* 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()}).
+ * 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</code> is null.
+ * @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 module.compareTo(o.module);
}
-
@Override
public void writeTo(final DataOutput out) throws IOException {
module.writeTo(out);
Code Review / yangtools.git / blobdiff