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

Go to download
/*
 * Copyright 2002-2019 Igor Maznitsa (http://www.igormaznitsa.com)
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 javax.annotation.Nonnull;
import javax.annotation.concurrent.ThreadSafe;
import java.io.Serializable;
import java.util.Collections;
import java.util.Map;
import java.util.WeakHashMap;

/**
 * Allows to keep information about point where instance of the class was created.
 *
 * @see CallTrace
 * @since 1.0
 */
@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);
  }

}