001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017
018package org.apache.logging.log4j.util;
019
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022
023/**
024 * Indicates that a particular annotated construct was written with certain performance constraints in mind that
025 * should be considered when modifying or testing. Descriptive values should be similar to the conventions used by
026 * {@link SuppressWarnings}. For example, code that should not be allocating objects (like iterators) could use the
027 * description "allocation".
028 *
029 * @since 2.6
030 */
031// Not @Documented: Do not (yet) make this annotation part of the public API of annotated elements.
032// No @Target: No restrictions yet on what code elements may be annotated or not.
033@Retention(RetentionPolicy.CLASS) // Currently no need to reflectively discover this annotation at runtime.
034public @interface PerformanceSensitive {
035    /** Description of why this is written the way it is. */
036    String[] value() default "";
037}