org.androidannotations.annotations.Trace Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of androidannotations-api Show documentation

The API jar containing the annotations and the runtime helpers

There is a newer version: 4.8.0

Show newest version

/**
 * Copyright (C) 2010-2016 eBusiness Information, Excilys Group
 * Copyright (C) 2016-2018 the AndroidAnnotations project
 *
 * 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 org.androidannotations.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.androidannotations.api.KotlinOpen;

import android.util.Log;

/**
 * 
 * This annotation is intended to be used on methods to log at runtime the
 * execution time.
 * 
 * 
 * Since AndroidAnnotations 3.1 log messages contain the method parameter
 * and return values.
 * 
 * 
 * All annotation values are optional :
 * 
 * 
 * tag: the tag used for the log message. (default: enclosing class
 * name)
 * level: the log level used for the log message. (default :
 * LOG.INFO).
 * 
 *
 * 
 * 
 * Example :
 * 
 *  * @Trace
 * void doWork() {
 * 	// ... Do Work ...
 * }
 * 
 * @Trace
 * boolean doMoreWork(String someString) {
 * 	// ... Do more Work ...
 * }
 * 
 * 
 * This will log these lines :
 * 
 *  * I/TracedMethodActivity(  302): Entering [void doWork() ]
 * I/TracedMethodActivity(  302): Exiting [void doWork() ], duration in ms: 1002
 * I/TracedMethodActivity(  302): Entering [boolean doMoreWork(someString = Hello World)]
 * I/TracedMethodActivity(  302): Exiting [boolean doMoreWork(String) returning: true], duration in ms: 651
 * 
 * 
 * 
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
@KotlinOpen
public @interface Trace {

	/**
	 * The string indicating that no tag was given for the log message.
	 */
	String DEFAULT_TAG = "NO_TAG";

	/**
	 * The tag used for the log message.
	 * 
	 * @return the tag of the message
	 */
	String tag() default DEFAULT_TAG;

	/**
	 * The log level used for the log message.
	 * 
	 * @return the logging level of the message
	 */
	int level() default Log.INFO;

}