opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/QNameFactory.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.node.utils;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.cache.CacheBuilder;
  13 import com.google.common.cache.CacheLoader;
  14 import com.google.common.cache.LoadingCache;
  15 import java.net.URI;
  16 import java.util.Objects;
  17 import java.util.concurrent.ExecutionException;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.yangtools.concepts.Immutable;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.common.QNameModule;
  23 import org.opendaylight.yangtools.yang.common.Revision;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  25
  26 @Deprecated(forRemoval = true)
  27 public final class QNameFactory {
  28     private static final class StringQName implements Immutable {
  29         private final @NonNull String localName;
  30         private final @NonNull String namespace;
  31         private final @Nullable String revision;
  32
  33         StringQName(final String localName, final String namespace, final String revision) {
  34             this.localName = requireNonNull(localName);
  35             this.namespace = requireNonNull(namespace);
  36             this.revision = revision;
  37         }
  38
  39         @Override
  40         public int hashCode() {
  41             return Objects.hash(localName, namespace, revision);
  42         }
  43
  44         @Override
  45         public boolean equals(final Object obj) {
  46             if (this == obj) {
  47                 return true;
  48             }
  49             if (!(obj instanceof StringQName)) {
  50                 return false;
  51             }
  52             final StringQName other = (StringQName) obj;
  53             return localName.equals(other.localName) && namespace.equals(other.namespace)
  54                     && Objects.equals(revision, other.revision);
  55         }
  56
  57         QName toQName() {
  58             return revision != null ? QName.create(namespace, revision, localName) : QName.create(namespace, localName);
  59         }
  60     }
  61
  62     private static final class ModuleQName implements Immutable {
  63         private final @NonNull QNameModule module;
  64         private final @NonNull String localName;
  65
  66         ModuleQName(final QNameModule module, final String localName) {
  67             this.module = requireNonNull(module);
  68             this.localName = requireNonNull(localName);
  69         }
  70
  71         @Override
  72         public int hashCode() {
  73             return 31 * module.hashCode() + localName.hashCode();
  74         }
  75
  76         @Override
  77         public boolean equals(final Object obj) {
  78             if (this == obj) {
  79                 return true;
  80             }
  81             if (!(obj instanceof ModuleQName)) {
  82                 return false;
  83             }
  84             final ModuleQName other = (ModuleQName) obj;
  85             return localName.equals(other.localName) && module.equals(other.module);
  86         }
  87
  88         QName toQName() {
  89             return QName.create(module, localName);
  90         }
  91     }
  92
  93     private static final class StringModule implements Immutable {
  94         private final @NonNull String namespace;
  95         private final @Nullable String revision;
  96
  97         StringModule(final String namespace, final String revision) {
  98             this.namespace = requireNonNull(namespace);
  99             this.revision = revision;
 100         }
 101
 102         @Override
 103         public int hashCode() {
 104             return 31 * namespace.hashCode() + Objects.hashCode(revision);
 105         }
 106
 107         @Override
 108         public boolean equals(final Object obj) {
 109             if (this == obj) {
 110                 return true;
 111             }
 112             if (!(obj instanceof StringModule)) {
 113                 return false;
 114             }
 115             final StringModule other = (StringModule) obj;
 116             return namespace.equals(other.namespace) && Objects.equals(revision, other.revision);
 117         }
 118
 119         QNameModule toQNameModule() {
 120             return QNameModule.create(URI.create(namespace), Revision.ofNullable(revision));
 121         }
 122     }
 123
 124     private static final int MAX_QNAME_CACHE_SIZE = Integer.getInteger(
 125         "org.opendaylight.controller.cluster.datastore.node.utils.qname-cache.max-size", 10000);
 126     private static final int MAX_MODULE_CACHE_SIZE = Integer.getInteger(
 127         "org.opendaylight.controller.cluster.datastore.node.utils.module-cache.max-size", 2000);
 128
 129     private static final LoadingCache<String, QName> LEGACY_CACHE = CacheBuilder.newBuilder()
 130             .maximumSize(MAX_QNAME_CACHE_SIZE).weakValues().build(new CacheLoader<String, QName>() {
 131                 @Override
 132                 public QName load(final String key) {
 133                     return QName.create(key).intern();
 134                 }
 135             });
 136     private static final LoadingCache<StringQName, QName> STRING_CACHE = CacheBuilder.newBuilder()
 137             .maximumSize(MAX_QNAME_CACHE_SIZE).weakValues().build(new CacheLoader<StringQName, QName>() {
 138                 @Override
 139                 public QName load(final StringQName key) {
 140                     return key.toQName().intern();
 141                 }
 142             });
 143     private static final LoadingCache<ModuleQName, QName> QNAME_CACHE = CacheBuilder.newBuilder()
 144             .maximumSize(MAX_QNAME_CACHE_SIZE).weakValues().build(new CacheLoader<ModuleQName, QName>() {
 145                 @Override
 146                 public QName load(final ModuleQName key) {
 147                     return key.toQName().intern();
 148                 }
 149             });
 150     private static final LoadingCache<StringModule, QNameModule> MODULE_CACHE = CacheBuilder.newBuilder()
 151             .maximumSize(MAX_MODULE_CACHE_SIZE).weakValues().build(new CacheLoader<StringModule, QNameModule>() {
 152                 @Override
 153                 public QNameModule load(final StringModule key) {
 154                     return key.toQNameModule().intern();
 155                 }
 156             });
 157     private static final LoadingCache<ModuleQName, NodeIdentifier> NODEID_CACHE = CacheBuilder.newBuilder()
 158             .maximumSize(MAX_QNAME_CACHE_SIZE).weakValues().build(new CacheLoader<ModuleQName, NodeIdentifier>() {
 159                 @Override
 160                 public NodeIdentifier load(final ModuleQName key) throws ExecutionException {
 161                     return NodeIdentifier.create(QNAME_CACHE.get(key));
 162                 }
 163             });
 164
 165     private QNameFactory() {
 166
 167     }
 168
 169     @Deprecated
 170     public static QName create(final String name) {
 171         return LEGACY_CACHE.getUnchecked(name);
 172     }
 173
 174     public static QName create(final String localName, final String namespace, final @Nullable String revision) {
 175         return STRING_CACHE.getUnchecked(new StringQName(localName, namespace, revision));
 176     }
 177
 178     public static QName create(final QNameModule module, final String localName) {
 179         return QNAME_CACHE.getUnchecked(new ModuleQName(module, localName));
 180     }
 181
 182     public static QNameModule createModule(final String namespace, final @Nullable String revision) {
 183         return MODULE_CACHE.getUnchecked(new StringModule(namespace, revision));
 184     }
 185
 186     public static @NonNull NodeIdentifier getNodeIdentifier(final QNameModule module, final String localName)
 187             throws ExecutionException {
 188         return NODEID_CACHE.get(new ModuleQName(module, localName));
 189     }
 190 }