2 * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.codec.impl;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.collect.ImmutableMap;
13 import java.lang.invoke.MethodHandles;
14 import java.lang.invoke.VarHandle;
15 import java.util.Optional;
16 import org.eclipse.jdt.annotation.Nullable;
17 import org.opendaylight.yangtools.yang.binding.Augmentable;
18 import org.opendaylight.yangtools.yang.binding.Augmentation;
19 import org.opendaylight.yangtools.yang.binding.DataObject;
20 import org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer;
21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
24 * A base class for {@link DataObject}s which are also {@link Augmentable}, backed by {@link DataObjectCodecContext}.
25 * While this class is public, it not part of API surface and is an implementation detail. The only reason for it being
26 * public is that it needs to be accessible by code generated at runtime.
28 * @param <T> DataObject type
30 public abstract class AugmentableCodecDataObject<T extends DataObject & Augmentable<T>>
31 extends CodecDataObject<T> implements Augmentable<T> {
32 private static final VarHandle CACHED_AUGMENTATIONS;
36 CACHED_AUGMENTATIONS = MethodHandles.lookup().findVarHandle(AugmentableCodecDataObject.class,
37 "cachedAugmentations", ImmutableMap.class);
38 } catch (ReflectiveOperationException e) {
39 throw new ExceptionInInitializerError(e);
44 @SuppressWarnings("unused")
45 private volatile ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>> cachedAugmentations;
47 protected AugmentableCodecDataObject(final DataObjectCodecContext<T, ?> context,
48 final DistinctNodeContainer<?, ?> data) {
52 @SuppressWarnings("unchecked")
54 public final <A extends Augmentation<T>> @Nullable A augmentation(final Class<A> augmentationType) {
55 requireNonNull(augmentationType, "Supplied augmentation must not be null.");
57 final ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>> aug = acquireAugmentations();
59 return (A) aug.get(augmentationType);
62 @SuppressWarnings("rawtypes")
63 final Optional<DataContainerCodecContext<?, ?>> optAugCtx = codecContext().possibleStreamChild(
64 (Class) augmentationType);
65 if (optAugCtx.isPresent()) {
66 final DataContainerCodecContext<?, ?> augCtx = optAugCtx.get();
67 // Due to binding specification not representing grouping instantiations we can end up having the same
68 // augmentation applied to a grouping multiple times. While these augmentations have the same shape, they
69 // are still represented by distinct binding classes and therefore we need to make sure the result matches
70 // the augmentation the user is requesting -- otherwise a strict receiver would end up with a cryptic
71 // ClassCastException.
72 if (augmentationType.isAssignableFrom(augCtx.getBindingClass())) {
73 final NormalizedNode augData = codecData().childByArg(augCtx.getDomPathArgument());
74 if (augData != null) {
75 return (A) augCtx.deserialize(augData);
83 public final ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>> augmentations() {
84 final ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>> local = acquireAugmentations();
85 return local != null ? local : loadAugmentations();
88 private ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>> acquireAugmentations() {
89 return (ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>>) CACHED_AUGMENTATIONS.getAcquire(this);
92 @SuppressWarnings("unchecked")
93 private ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>> loadAugmentations() {
94 final ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>> ret = ImmutableMap.copyOf(
95 codecContext().getAllAugmentationsFrom(codecData()));
96 final Object witness = CACHED_AUGMENTATIONS.compareAndExchangeRelease(this, null, ret);
97 return witness == null ? ret : (ImmutableMap<Class<? extends Augmentation<T>>, Augmentation<T>>) witness;