com.intellij.openapi.util.NlsSafe Maven / Gradle / Ivy

Go to download
// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.openapi.util;

import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NonNls;

import java.lang.annotation.*;

/**
 * Marker annotation for strings that don't require localization but still could be displayed in UI.
 * 
 * Examples:
 * 

 *   File name or path
 *   Project name
 *   URL
 *   Programming language or framework name
 * 
 * Avoid using NlsSafe just to suppress the "hardcoded string" inspection warning. Use {@link NonNls @NonNls}
 * if something is not intended to be displayed to the user: internal identifier, XML tag attribute,
 * substring to be searched in the external process output, etc.
 * 
 *   This annotation is primarily intended to be used on variable or method return values (in "producer" context).
 *   Avoid using it on method parameters (in "consumer" context), as this will simply allow called the method with anything,
 *   including hardcoded strings.
 * 
 */
@ApiStatus.Experimental
@Retention(RetentionPolicy.CLASS)
@Documented
@Target({ElementType.TYPE_USE, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.LOCAL_VARIABLE})
public @interface NlsSafe {
}