binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/api/BindingNormalizedNodeCachingCodec.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 org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
  12
  13 /**
  14  * Caching variant of Binding to Normalized Node codec.
  15  *
  16  * <p>
  17  * Caching may introduce performance penalty to serialization / deserialization
  18  * but may decrease use of heap for repetitive objects.
  19  *
  20  * @param <T>
  21  *            - Binding representation of data
  22  */
  23 @Beta
  24 public interface BindingNormalizedNodeCachingCodec<T extends TreeNode>
  25         extends BindingNormalizedNodeCodec<T>, AutoCloseable {
  26
  27     /**
  28      * Invoking close will invalidate this codec and any of its child codecs and
  29      * will invalidate cache.
  30      *
  31      * <p>
  32      * Any subsequent calls to this codec will fail with
  33      * {@link IllegalStateException} thrown.
  34      */
  35     @Override
  36     void close();
  37 }
  38