patterntesting.runtime.annotation.DontLogMe 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.4.0

Show newest version

/**
 * $Id: DontLogMe.java,v 1.1 2010/01/05 13:26:17 oboehm Exp $
 *
 * Copyright (c) 2009 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 08.06.2009 by oliver ([email protected])
 */
package patterntesting.runtime.annotation;

import java.lang.annotation.*;

/**
 * E.g. the ProfileAspect together with the AbstractProfileAspect logs also
 * the arguments for long running methods. But sometimes you don't want to see
 * the value of an argument, e.g.
 * 
 *  
 *      if the argument is a password (you should never log passwords!)
 *  
 *  
 *      if the argument contains personal infos which should not appear in
 *      the log (like the age of a woman;-)
 *  
 *  
 *      if the value of the argument would be too long and would make the
 *      output unreadable
 *  
 *  
 *      or other reasons.
 *  
 * 
 * Now you can prefix these arguments with this annotation.
 *
 * @author oliver
 * @since 08.06.2009
 * @version $Revision: 1.1 $
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER})
public @interface DontLogMe {

}

/**
 * $Log: DontLogMe.java,v $
 * Revision 1.1  2010/01/05 13:26:17  oboehm
 * begin with 1.0
 *
 * Revision 1.2  2009/12/19 22:34:09  oboehm
 * trailing spaces removed
 *
 * Revision 1.1  2009/06/10 19:56:57  oboehm
 * DontLogMe annotation added to hide parameters logged by @ProfileMe
 *
 * $Source: /cvsroot/patterntesting/PatternTesting10/patterntesting-rt/src/main/java/patterntesting/runtime/annotation/DontLogMe.java,v $
 */