code-generator/binding-data-codec/src/main/java/org/opendaylight/yangtools/binding/data/codec/impl/LazyDataObject.java

   1 /*
   2  * Copyright (c) 2014 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.binding.data.codec.impl;
   9
  10 import com.google.common.base.Objects.ToStringHelper;
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.ImmutableMap;
  14 import java.lang.reflect.InvocationHandler;
  15 import java.lang.reflect.InvocationTargetException;
  16 import java.lang.reflect.Method;
  17 import java.lang.reflect.Proxy;
  18 import java.util.Map;
  19 import java.util.Objects;
  20 import java.util.concurrent.ConcurrentHashMap;
  21 import org.opendaylight.yangtools.binding.data.codec.util.AugmentationReader;
  22 import org.opendaylight.yangtools.yang.binding.Augmentable;
  23 import org.opendaylight.yangtools.yang.binding.Augmentation;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 class LazyDataObject implements InvocationHandler, AugmentationReader {
  31
  32     private static final Logger LOG = LoggerFactory.getLogger(LazyDataObject.class);
  33     private static final String GET_IMPLEMENTED_INTERFACE = "getImplementedInterface";
  34     private static final String TO_STRING = "toString";
  35     private static final String EQUALS = "equals";
  36     private static final String GET_AUGMENTATION = "getAugmentation";
  37     private static final String HASHCODE = "hashCode";
  38     private static final Object NULL_VALUE = new Object();
  39
  40     private final ConcurrentHashMap<Method, Object> cachedData = new ConcurrentHashMap<>();
  41     private final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data;
  42     private final DataObjectCodecContext<?> context;
  43
  44     private volatile ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> cachedAugmentations = null;
  45     private volatile Integer cachedHashcode = null;
  46
  47     @SuppressWarnings({ "rawtypes", "unchecked" })
  48     LazyDataObject(final DataObjectCodecContext<?> ctx, final NormalizedNodeContainer data) {
  49         this.context = Preconditions.checkNotNull(ctx, "Context must not be null");
  50         this.data = Preconditions.checkNotNull(data, "Data must not be null");
  51     }
  52
  53     @Override
  54     public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
  55         if (method.getParameterTypes().length == 0) {
  56             final String name = method.getName();
  57             if (GET_IMPLEMENTED_INTERFACE.equals(name)) {
  58                 return context.bindingClass();
  59             } else if (TO_STRING.equals(name)) {
  60                 return bindingToString();
  61             } else if (HASHCODE.equals(name)) {
  62                 return bindingHashCode();
  63             }
  64             return getBindingData(method);
  65         } else if (GET_AUGMENTATION.equals(method.getName())) {
  66             return getAugmentationImpl((Class<?>) args[0]);
  67         } else if (EQUALS.equals(method.getName())) {
  68             return bindingEquals(args[0]);
  69         }
  70         throw new UnsupportedOperationException("Unsupported method " + method);
  71     }
  72
  73     private boolean bindingEquals(final Object other) {
  74         if (other == null) {
  75             return false;
  76         }
  77         if (!context.bindingClass().isAssignableFrom(other.getClass())) {
  78             return false;
  79         }
  80         try {
  81             for (final Method m : context.getHashCodeAndEqualsMethods()) {
  82                 final Object thisValue = getBindingData(m);
  83                 final Object otherValue = m.invoke(other);
  84                 if(!Objects.equals(thisValue, otherValue)) {
  85                     return false;
  86                 }
  87             }
  88         } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
  89             LOG.warn("Can not determine equality of {} and {}", this, other, e);
  90             return false;
  91         }
  92         return true;
  93     }
  94
  95     private Integer bindingHashCode() {
  96         final Integer ret = cachedHashcode;
  97         if (ret != null) {
  98             return ret;
  99         }
 100
 101         final int prime = 31;
 102         int result = 1;
 103         for (final Method m : context.getHashCodeAndEqualsMethods()) {
 104             final Object value = getBindingData(m);
 105             result += prime * result + ((value == null) ? 0 : value.hashCode());
 106         }
 107         if (Augmentation.class.isAssignableFrom(context.bindingClass())) {
 108             result += prime * result + (getAugmentations(this).hashCode());
 109         }
 110         cachedHashcode = result;
 111         return result;
 112     }
 113
 114     private Object getBindingData(final Method method) {
 115         Object cached = cachedData.get(method);
 116         if (cached == null) {
 117             final Object readedValue = context.getBindingChildValue(method, data);
 118             if (readedValue == null) {
 119                 cached = NULL_VALUE;
 120             } else {
 121                 cached = readedValue;
 122             }
 123             cachedData.putIfAbsent(method, cached);
 124         }
 125
 126         return cached == NULL_VALUE ? null : cached;
 127     }
 128
 129     private Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentationsImpl() {
 130         ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> ret = cachedAugmentations;
 131         if (ret == null) {
 132             synchronized (this) {
 133                 ret = cachedAugmentations;
 134                 if (ret == null) {
 135                     ret = ImmutableMap.copyOf(context.getAllAugmentationsFrom(data));
 136                     cachedAugmentations = ret;
 137                 }
 138             }
 139         }
 140
 141         return ret;
 142     }
 143
 144     @Override
 145     public Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Object obj) {
 146         Preconditions.checkArgument(this == Proxy.getInvocationHandler(obj),
 147                 "Supplied object is not associated with this proxy handler");
 148
 149         return getAugmentationsImpl();
 150     }
 151
 152     private Object getAugmentationImpl(final Class<?> cls) {
 153         final ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> aug = cachedAugmentations;
 154         if (aug != null) {
 155             return aug.get(cls);
 156         }
 157         Preconditions.checkNotNull(cls,"Supplied augmentation must not be null.");
 158         final Optional<DataContainerCodecContext<?>> augCtx= context.getPossibleStreamChild(cls);
 159         if(augCtx.isPresent()) {
 160             final Optional<NormalizedNode<?, ?>> augData = data.getChild(augCtx.get().getDomPathArgument());
 161             if (augData.isPresent()) {
 162                 return augCtx.get().dataFromNormalizedNode(augData.get());
 163             }
 164         }
 165         return null;
 166     }
 167
 168     public String bindingToString() {
 169         final ToStringHelper helper = com.google.common.base.Objects.toStringHelper(context.bindingClass()).omitNullValues();
 170
 171         for (final Method m :context.getHashCodeAndEqualsMethods()) {
 172             helper.add(m.getName(), getBindingData(m));
 173         }
 174         if (Augmentable.class.isAssignableFrom(context.bindingClass())) {
 175             helper.add("augmentations", getAugmentationsImpl());
 176         }
 177         return helper.toString();
 178     }
 179
 180     @Override
 181     public int hashCode() {
 182         final int prime = 31;
 183         int result = 1;
 184         result = prime * result + context.hashCode();
 185         result = prime * result + data.hashCode();
 186         return result;
 187     }
 188
 189     @Override
 190     public boolean equals(final Object obj) {
 191         if (this == obj) {
 192             return true;
 193         }
 194         if (obj == null) {
 195             return false;
 196         }
 197         if (getClass() != obj.getClass()) {
 198             return false;
 199         }
 200         final LazyDataObject other = (LazyDataObject) obj;
 201         if (context == null) {
 202             if (other.context != null) {
 203                 return false;
 204             }
 205         } else if (!context.equals(other.context)) {
 206             return false;
 207         }
 208         if (data == null) {
 209             if (other.data != null) {
 210                 return false;
 211             }
 212         } else if (!data.equals(other.data)) {
 213             return false;
 214         }
 215         return true;
 216     }
 217 }