patterntesting.runtime.annotation.ProfileMe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-rt Show documentation

PatternTesting Runtime (patterntesting-rt) is the runtime component for the PatternTesting framework. It provides the annotations and base classes for the PatternTesting testing framework (e.g. patterntesting-check, patterntesting-concurrent or patterntesting-exception) but can be also used standalone for classpath monitoring or profiling. It uses AOP and AspectJ to perform this feat.

There is a newer version: 2.5.0

Show newest version

/**
 * Copyright (c) 2008-2020 by Oliver Boehm
 *
 * 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 19.12.2008 by oliver ([email protected])
 */
package patterntesting.runtime.annotation;

import java.lang.annotation.*;

/**
 * You want to measure a method or constructor? Mark it with @ProfileMe. You
 * want to measure all methods or constructors in a class? Mark the class
 * with @ProfileMe.
 * 
 * You want to find constructors or methods of a class which are never called?
 * Mark the class with @ProfileMe and look at the constructors and methods which
 * has a hit of "0". This feature works only if you mark the whole class
 * with @ProfileMe because in this case the ProfileStatisticMBean initializes
 * the ProfileMonitor for each method in this class.
 * 
 * 
 * For all other methods or constructors the attached ProfileMonitor is
 * initialized at the first call. So you don't see the ProfileMonitor if the
 * method or constructor is never called.
 * 
 * 
 * Note: This works only for classes which are really loaded. If a
 * class is loaded you can see it with the ClasspathMonitorMBean.
 * 
 *
 * @author oliver
 * @see DontProfileMe
 * @see patterntesting.runtime.monitor.ProfileStatistic
 * @see patterntesting.runtime.monitor.ProfileMonitor
 * @since 19.12.2008
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.TYPE })
public @interface ProfileMe {

}