yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/LeafInterner.java

   1 /*
   2  * Copyright (c) 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.yangtools.yang.data.util;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.Interner;
  12 import com.google.common.collect.Interners;
  13 import java.util.Objects;
  14 import javax.annotation.Nonnull;
  15 import javax.annotation.Nullable;
  16 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  17 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  18 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
  20 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 /**
  26  * Utility class for sharing instances of {@link LeafNode}s which have low cardinality-- e.g. those which hold
  27  * boolean or enumeration values. Instances containing attributes are not interned.
  28  *
  29  * <p>
  30  * Such objects have cardinality which is capped at the product of QNAMES * TYPE_CARDINALITY, where QNAMES is the total
  31  * number of different QNames where the type is used and TYPE_CARDINALITY is the number of possible values for the type.
  32  * Boolean has cardinality of 2, enumerations have cardinality equal to the number of enum statements.
  33  *
  34  * <p>
  35  * The theory here is that we tend to have a large number (100K+) of entries in a few places, which could end up hogging
  36  * the heap retained via the DataTree with duplicate objects (same QName, same value, different object). Using this
  37  * utility, such objects will end up reusing the same object, preventing this overhead.
  38  */
  39 @Beta
  40 public final class LeafInterner {
  41     private static final Logger LOG = LoggerFactory.getLogger(LeafInterner.class);
  42     private static final Interner<Object> INTERNER = Interners.newWeakInterner();
  43
  44     private LeafInterner() {
  45         throw new UnsupportedOperationException();
  46     }
  47
  48     private static <T extends LeafNode<?>> T intern(final T sample) {
  49         if (sample.getAttributes().isEmpty()) {
  50             @SuppressWarnings("unchecked")
  51             final T ret = (T) INTERNER.intern(sample);
  52             LOG.trace("Interned object {} to {}", sample, ret);
  53             return ret;
  54         }
  55
  56         // Non-empty attributes, do not intern
  57         return sample;
  58     }
  59
  60     /**
  61      * Return a {@link LeafInterner} for a particular schema. Interner instances must not be reused for leaves of
  62      * different types, otherwise they may produce unexpected results.
  63      *
  64      * @param schema The leaf node's schema
  65      * @return An interner instance
  66      */
  67     @Nonnull public static <T extends LeafNode<?>> Interner<T> forSchema(@Nullable final LeafSchemaNode schema) {
  68         if (schema != null) {
  69             final TypeDefinition<?> type = schema.getType();
  70             if (type instanceof BooleanTypeDefinition || type instanceof EnumTypeDefinition
  71                     || type instanceof IdentityrefTypeDefinition) {
  72                 return LeafInterner::intern;
  73             }
  74         }
  75
  76         return Objects::requireNonNull;
  77     }
  78 }