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 org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.opendaylight.yangtools.concepts.Immutable;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.common.QNameModule;
  22 import org.opendaylight.yangtools.yang.common.Revision;
  23
  24 public final class QNameFactory {
  25     private static final class StringQName implements Immutable {
  26         private final @NonNull String localName;
  27         private final @NonNull String namespace;
  28         private final @Nullable String revision;
  29
  30         StringQName(final String localName, final String namespace, final String revision) {
  31             this.localName = requireNonNull(localName);
  32             this.namespace = requireNonNull(namespace);
  33             this.revision = revision;
  34         }
  35
  36         @Override
  37         public int hashCode() {
  38             return Objects.hash(localName, namespace, revision);
  39         }
  40
  41         @Override
  42         public boolean equals(final Object obj) {
  43             if (this == obj) {
  44                 return true;
  45             }
  46             if (!(obj instanceof StringQName)) {
  47                 return false;
  48             }
  49             final StringQName other = (StringQName) obj;
  50             return localName.equals(other.localName) && namespace.equals(other.namespace)
  51                     && Objects.equals(revision, other.revision);
  52         }
  53
  54         QName toQName() {
  55             return revision != null ? QName.create(namespace, revision, localName) : QName.create(namespace, localName);
  56         }
  57     }
  58
  59     private static final class ModuleQName implements Immutable {
  60         private final @NonNull QNameModule module;
  61         private final @NonNull String localName;
  62
  63         ModuleQName(final QNameModule module, final String localName) {
  64             this.module = requireNonNull(module);
  65             this.localName = requireNonNull(localName);
  66         }
  67
  68         @Override
  69         public int hashCode() {
  70             return 31 * module.hashCode() + localName.hashCode();
  71         }
  72
  73         @Override
  74         public boolean equals(final Object obj) {
  75             if (this == obj) {
  76                 return true;
  77             }
  78             if (!(obj instanceof ModuleQName)) {
  79                 return false;
  80             }
  81             final ModuleQName other = (ModuleQName) obj;
  82             return localName.equals(other.localName) && module.equals(other.module);
  83         }
  84
  85         QName toQName() {
  86             return QName.create(module, localName);
  87         }
  88     }
  89
  90     private static final class StringModule implements Immutable {
  91         private final @NonNull String namespace;
  92         private final @Nullable String revision;
  93
  94         StringModule(final String namespace, final String revision) {
  95             this.namespace = requireNonNull(namespace);
  96             this.revision = revision;
  97         }
  98
  99         @Override
 100         public int hashCode() {
 101             return 31 * namespace.hashCode() + Objects.hashCode(revision);
 102         }
 103
 104         @Override
 105         public boolean equals(final Object obj) {
 106             if (this == obj) {
 107                 return true;
 108             }
 109             if (!(obj instanceof StringModule)) {
 110                 return false;
 111             }
 112             final StringModule other = (StringModule) obj;
 113             return namespace.equals(other.namespace) && Objects.equals(revision, other.revision);
 114         }
 115
 116         QNameModule toQNameModule() {
 117             return QNameModule.create(URI.create(namespace), Revision.ofNullable(revision));
 118         }
 119     }
 120
 121     private static final int MAX_QNAME_CACHE_SIZE = Integer.getInteger(
 122         "org.opendaylight.controller.cluster.datastore.node.utils.qname-cache.max-size", 10000);
 123     private static final int MAX_MODULE_CACHE_SIZE = Integer.getInteger(
 124         "org.opendaylight.controller.cluster.datastore.node.utils.module-cache.max-size", 2000);
 125
 126     private static final LoadingCache<String, QName> LEGACY_CACHE = CacheBuilder.newBuilder()
 127             .maximumSize(MAX_QNAME_CACHE_SIZE).weakValues().build(new CacheLoader<String, QName>() {
 128                 @Override
 129                 public QName load(final String key) {
 130                     return QName.create(key).intern();
 131                 }
 132             });
 133     private static final LoadingCache<StringQName, QName> STRING_CACHE = CacheBuilder.newBuilder()
 134             .maximumSize(MAX_QNAME_CACHE_SIZE).weakValues().build(new CacheLoader<StringQName, QName>() {
 135                 @Override
 136                 public QName load(final StringQName key) {
 137                     return key.toQName().intern();
 138                 }
 139             });
 140     private static final LoadingCache<ModuleQName, QName> QNAME_CACHE = CacheBuilder.newBuilder()
 141             .maximumSize(MAX_QNAME_CACHE_SIZE).weakValues().build(new CacheLoader<ModuleQName, QName>() {
 142                 @Override
 143                 public QName load(final ModuleQName key) {
 144                     return key.toQName().intern();
 145                 }
 146             });
 147     private static final LoadingCache<StringModule, QNameModule> MODULE_CACHE = CacheBuilder.newBuilder()
 148             .maximumSize(MAX_MODULE_CACHE_SIZE).weakValues().build(new CacheLoader<StringModule, QNameModule>() {
 149                 @Override
 150                 public QNameModule load(final StringModule key) {
 151                     return key.toQNameModule().intern();
 152                 }
 153             });
 154
 155     private QNameFactory() {
 156
 157     }
 158
 159     @Deprecated
 160     public static QName create(final String name) {
 161         return LEGACY_CACHE.getUnchecked(name);
 162     }
 163
 164     public static QName create(final String localName, final String namespace, final @Nullable String revision) {
 165         return STRING_CACHE.getUnchecked(new StringQName(localName, namespace, revision));
 166     }
 167
 168     public static QName create(final QNameModule module, final String localName) {
 169         return QNAME_CACHE.getUnchecked(new ModuleQName(module, localName));
 170     }
 171
 172     public static QNameModule createModule(final String namespace, final @Nullable String revision) {
 173         return MODULE_CACHE.getUnchecked(new StringModule(namespace, revision));
 174     }
 175 }