com.igormaznitsa.meta.common.templates.KeepCreationPointTemplate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of meta-common Show documentation

Set of annotations and auxuliary classes to mark code and make measurement and analyzing in runtime. It includes shaded FindBugs jsr-305 annotations from the com.google.code.findbugs library .

The newest version!

/*
 * Copyright 2016 Igor Maznitsa.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.igormaznitsa.meta.common.templates;

import com.igormaznitsa.meta.annotation.Warning;
import com.igormaznitsa.meta.common.utils.CallTrace;
import java.io.Serializable;
import java.util.Collections;
import java.util.Map;
import java.util.WeakHashMap;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.ThreadSafe;

/**
 * Allows to keep information about point where instance of the class was created.
 * 
 * @since 1.0
 * @see CallTrace
 */
@ThreadSafe
public abstract class KeepCreationPointTemplate implements Serializable {
  
  private static final long serialVersionUID = 2779254573622012575L;
  
  private static final Map REGISTRY = Collections.synchronizedMap(new WeakHashMap());

  /**
   * The Constructor.
   */
  @Warning("Must be called in successors, must not be called through constructor chain else you will see your constructors in stack trace!")
  public KeepCreationPointTemplate(){
    REGISTRY.put(this, new CallTrace(true, true, CallTrace.EOL_LINUX));
  }

  /**
   * Get the creation point stack trace for the instance.
   * @return the creation point stack trace
   */
  @Nonnull
  public final CallTrace getCreationPoint(){
    return REGISTRY.get(this);
  }

}