binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/AugmentationReader.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies 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.mdsal.binding.javav2.dom.codec.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.lang.reflect.InvocationHandler;
  12 import java.util.Map;
  13 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
  14 import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentation;
  15
  16 /**
  17  * Interface which should be implemented by proxy {@link InvocationHandler} to
  18  * obtain augmentations from proxy implementations of {@link Augmentable}
  19  * object.
  20  *
  21  * <p>
  22  * If implemented proxy does not implement this interface, its augmentations are
  23  * not properly serialized / deserialized.
  24  */
  25 @Beta
  26 public interface AugmentationReader {
  27
  28     /**
  29      * Get augmentations.
  30      *
  31      * @param obj
  32      *            - object implemented this interface
  33      * @return augmentations
  34      */
  35     Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(Object obj);
  36 }