opendaylight/md-sal/mdsal-trace/dom-impl/src/main/java/org/opendaylight/controller/md/sal/trace/closetracker/impl/CloseTrackedTrait.java

   1 /*
   2  * Copyright (c) 2017 Red Hat, 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.controller.md.sal.trace.closetracker.impl;
   9
  10 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  11 import java.util.Objects;
  12 import javax.annotation.Nullable;
  13
  14 /**
  15  * Implementation of {@link CloseTracked} which can be used as a field in
  16  * another class which implements {@link CloseTracked} and delegates its methods
  17  * to this.
  18  *
  19  * <p>This is useful if that class already has another parent class.
  20  * If it does not, then it's typically more convenient to just extend AbstractCloseTracked.
  21  *
  22  * @author Michael Vorburger.ch
  23  */
  24 public class CloseTrackedTrait<T extends CloseTracked<T>> implements CloseTracked<T> {
  25
  26     // NB: It's important that we keep a Throwable here, and not directly the StackTraceElement[] !
  27     // This is because creating a new Throwable() is a lot less expensive in terms of runtime overhead
  28     // than actually calling its getStackTrace(), which we can delay until we really need to.
  29     // see also e.g. https://stackoverflow.com/a/26122232/421602
  30     private final @Nullable Throwable allocationContext;
  31     private final CloseTrackedRegistry<T> closeTrackedRegistry;
  32     private final CloseTracked<T> realCloseTracked;
  33
  34     public CloseTrackedTrait(CloseTrackedRegistry<T> transactionChainRegistry, CloseTracked<T> realCloseTracked) {
  35         if (transactionChainRegistry.isDebugContextEnabled()) {
  36             // NB: We're NOT doing the (expensive) getStackTrace() here just yet (only below)
  37             // TODO When we're on Java 9, then instead use the new java.lang.StackWalker API..
  38             this.allocationContext = new Throwable();
  39         } else {
  40             this.allocationContext = null;
  41         }
  42         this.realCloseTracked = Objects.requireNonNull(realCloseTracked, "realCloseTracked");
  43         this.closeTrackedRegistry = Objects.requireNonNull(transactionChainRegistry, "transactionChainRegistry");
  44         this.closeTrackedRegistry.add(this);
  45     }
  46
  47     @Override
  48     @Nullable
  49     @SuppressFBWarnings("PZLA_PREFER_ZERO_LENGTH_ARRAYS")
  50     public StackTraceElement[] getAllocationContextStackTrace() {
  51         return allocationContext != null ? allocationContext.getStackTrace() : null;
  52     }
  53
  54     public void removeFromTrackedRegistry() {
  55         closeTrackedRegistry.remove(this);
  56     }
  57
  58     @Override
  59     public CloseTracked<T> getRealCloseTracked() {
  60         return realCloseTracked;
  61     }
  62
  63 }