1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17
18 package org.apache.logging.log4j.util;
19
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22
23 /**
24 * Indicates that a particular annotated construct was written with certain performance constraints in mind that
25 * should be considered when modifying or testing. Descriptive values should be similar to the conventions used by
26 * {@link SuppressWarnings}. For example, code that should not be allocating objects (like iterators) could use the
27 * description "allocation".
28 *
29 * @since 2.6
30 */
31 // Not @Documented: Do not (yet) make this annotation part of the public API of annotated elements.
32 // No @Target: No restrictions yet on what code elements may be annotated or not.
33 @Retention(RetentionPolicy.CLASS) // Currently no need to reflectively discover this annotation at runtime.
34 public @interface PerformanceSensitive {
35 /** Description of why this is written the way it is. */
36 String[] value() default "";
37 }