yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/BaseInternedStatementSupport.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.parser.rfc7950.stmt;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.cache.CacheBuilder;
  12 import com.google.common.cache.CacheLoader;
  13 import com.google.common.cache.LoadingCache;
  14 import com.google.common.collect.ImmutableList;
  15 import java.util.concurrent.ExecutionException;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  20 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  23
  24 /**
  25  * A {@link AbstractStatementSupport} specialized for global interning. This base class is useful when the argument can
  26  * be reasonably interned and it dominates the {@link EffectiveStatement} implementation. Typical examples include
  27  * {@code position} and {@code value} statements, which typically do not have substatements and are based on simple
  28  * types.
  29  *
  30  * <p>
  31  * Note: use of this base class implies context-independence.
  32  */
  33 @Beta
  34 public abstract class BaseInternedStatementSupport<A, D extends DeclaredStatement<A>,
  35         E extends EffectiveStatement<A, D>> extends AbstractStatementSupport<A, D, E> {
  36     private final LoadingCache<A, D> declaredCache = CacheBuilder.newBuilder().weakValues()
  37             .build(new CacheLoader<A, D>() {
  38                 @Override
  39                 public D load(final A key) {
  40                     return createEmptyDeclared(key);
  41                 }
  42             });
  43     private final LoadingCache<D, E> effectiveCache = CacheBuilder.newBuilder().weakValues()
  44             .build(new CacheLoader<D, E>() {
  45                 @Override
  46                 public E load(final D key) throws ExecutionException {
  47                     return createEmptyEffective(key);
  48                 }
  49             });
  50
  51     protected BaseInternedStatementSupport(final StatementDefinition publicDefinition,
  52             final StatementPolicy<A, D> policy) {
  53         super(publicDefinition, policy);
  54     }
  55
  56     @Override
  57     protected final D createEmptyDeclared(final StmtContext<A, D, ?> ctx) {
  58         return declaredCache.getUnchecked(ctx.getArgument());
  59     }
  60
  61     protected abstract @NonNull D createEmptyDeclared(@NonNull A argument);
  62
  63     @Override
  64     protected final E createEffective(final Current<A, D> stmt,
  65             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  66         return substatements.isEmpty() ? effectiveCache.getUnchecked(stmt.declared())
  67             : createEffective(stmt.declared(), substatements);
  68     }
  69
  70     protected abstract @NonNull E createEffective(@NonNull D declared,
  71         @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> substatements);
  72
  73     protected abstract @NonNull E createEmptyEffective(@NonNull D declared);
  74
  75     @Override
  76     protected final D createDeclared(final StmtContext<A, D, ?> ctx,
  77             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  78         return createDeclared(ctx.getArgument(), substatements);
  79     }
  80
  81     protected abstract @NonNull D createDeclared(@NonNull A argument,
  82             ImmutableList<? extends DeclaredStatement<?>> substatements);
  83 }