import com.google.common.base.MoreObjects;
import com.google.common.collect.Interner;
import com.google.common.collect.Interners;
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
import java.io.Serializable;
import java.net.URI;
-import java.net.URISyntaxException;
import java.util.Objects;
import java.util.Optional;
-import javax.annotation.Nullable;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.concepts.Identifier;
import org.opendaylight.yangtools.concepts.Immutable;
+import org.opendaylight.yangtools.concepts.WritableObject;
-public final class QNameModule implements Comparable<QNameModule>, Immutable, Serializable {
+public final class QNameModule implements Comparable<QNameModule>, Immutable, Serializable, Identifier, WritableObject {
private static final Interner<QNameModule> INTERNER = Interners.newWeakInterner();
private static final long serialVersionUID = 3L;
- private final URI namespace;
+ private final @NonNull URI namespace;
+ private final @Nullable Revision revision;
- //Nullable
- private final Revision revision;
+ private transient int hash = 0;
- private transient int hash;
-
- private QNameModule(final URI namespace, final Revision revision) {
+ private QNameModule(final URI namespace, final @Nullable Revision revision) {
this.namespace = requireNonNull(namespace);
this.revision = revision;
}
*
* @return Interned reference, or this object if it was interned.
*/
- public QNameModule intern() {
+ public @NonNull QNameModule intern() {
return INTERNER.intern(this);
}
* @param namespace Module namespace
* @param revision Module revision
* @return A new, potentially shared, QNameModule instance
+ * @throws NullPointerException if any argument is null
*/
- public static QNameModule create(final URI namespace, final Optional<Revision> revision) {
+ public static @NonNull QNameModule create(final URI namespace, final Optional<Revision> revision) {
return new QNameModule(namespace, revision.orElse(null));
}
/**
- * Create a new QName module instance with specified namespace and norevision.
+ * Create a new QName module instance with specified namespace and no revision.
*
* @param namespace Module namespace
* @return A new, potentially shared, QNameModule instance
+ * @throws NullPointerException if {@code namespace} is null
*/
- public static QNameModule create(final URI namespace) {
+ public static @NonNull QNameModule create(final URI namespace) {
return new QNameModule(namespace, null);
}
* @param namespace Module namespace
* @param revision Module revision
* @return A new, potentially shared, QNameModule instance
+ * @throws NullPointerException if any argument is null
*/
- public static QNameModule create(final URI namespace, @Nullable final Revision revision) {
+ public static @NonNull QNameModule create(final URI namespace, final @Nullable Revision revision) {
return new QNameModule(namespace, revision);
}
/**
- * Returns the namespace of the module which is specified as argument of
- * YANG Module <b><font color="#00FF00">namespace</font></b> keyword.
+ * Read a QNameModule from a DataInput. The format is expected to match the output format
+ * of {@link #writeTo(DataOutput)}.
+ *
+ * @param in DataInput to read
+ * @return A QNameModule instance
+ * @throws IOException if I/O error occurs
+ */
+ public static @NonNull QNameModule readFrom(final DataInput in) throws IOException {
+ final String namespace = in.readUTF();
+ final String revision = in.readUTF();
+ return new QNameModule(URI.create(namespace), revision.isEmpty() ? null : Revision.of(revision));
+ }
+
+ /**
+ * Returns the namespace of the module which is specified as argument of YANG Module {@code namespace} keyword.
*
* @return URI format of the namespace of the module
*/
- public URI getNamespace() {
+ public @NonNull URI getNamespace() {
return namespace;
}
/**
* Returns the revision date for the module.
*
- * @return date of the module revision which is specified as argument of
- * YANG Module <b><font color="#339900">revison</font></b> keyword
+ * @return date of the module revision which is specified as argument of YANG Module {@code revision} keyword
*/
- public Optional<Revision> getRevision() {
+ public @NonNull Optional<Revision> getRevision() {
return Optional.ofNullable(revision);
}
return Revision.compare(revision, o.revision);
}
+ /**
+ * Returns a QNameModule with the same namespace, but with no revision. If this QNameModule does not have
+ * a revision, this object is returned.
+ *
+ * @return a QNameModule with the same namespace, but with no revision.
+ */
+ public @NonNull QNameModule withoutRevision() {
+ return revision == null ? this : new QNameModule(namespace, null);
+ }
+
+ @Override
+ public void writeTo(final DataOutput out) throws IOException {
+ out.writeUTF(namespace.toString());
+ out.writeUTF(revision == null ? "" : revision.toString());
+ }
+
@Override
public int hashCode() {
if (hash == 0) {
return false;
}
final QNameModule other = (QNameModule) obj;
- return Objects.equals(revision, other.revision) && Objects.equals(namespace, other.namespace);
- }
-
- /**
- * Returns a namespace in form defined by section 5.6.4. of
- * <a href=https://tools.ietf.org/html/rfc6020">RFC6020</a>, for example
- * {@code http://example.acme.com/system?revision=2008-04-01}.
- *
- * @return Namespace in form defined by section 5.6.4. of RFC6020.
- * @throws URISyntaxException on incorrect namespace definition
- *
- */
- URI getRevisionNamespace() throws URISyntaxException {
- final String query = revision == null ? "" : "revision=" + revision.toString();
- return new URI(namespace.getScheme(), namespace.getUserInfo(), namespace.getHost(), namespace.getPort(),
- namespace.getPath(), query, namespace.getFragment());
+ return Objects.equals(revision, other.revision) && namespace.equals(other.namespace);
}
@Override
- public String toString() {
- return MoreObjects.toStringHelper(QNameModule.class).omitNullValues().add("ns", getNamespace())
+ public @NonNull String toString() {
+ return MoreObjects.toStringHelper(QNameModule.class).omitNullValues().add("ns", namespace)
.add("rev", revision).toString();
}
+
+ Object writeReplace() {
+ return new NSv1(this);
+ }
}
Code Review / yangtools.git / blobdiff