Package org.jetbrains.annotations

# Annotation Interface Nls

@Documented @Retention(CLASS) @Target({METHOD,FIELD,PARAMETER,LOCAL_VARIABLE,TYPE_USE,TYPE,PACKAGE}) public @interface Nls
Specifies that an element of the program is an user-visible string which needs to be localized. This annotation is intended to be used by localization tools for detecting strings which should be reported as requiring localization.

This annotation also could be used as a meta-annotation, to define derived annotations for convenience. E.g. the following annotation could be defined to annotate the strings that represent dialog titles:

     @Nls(capitalization = Capitalization.Title)
     @interface DialogTitle {}

Note that using the derived annotation as meta-annotation is not supported. Meta-annotation works only one level deep.

See Also:
  - `NonNls`

## Nested Class Summary

Nested Classes
Modifier and Type
Class
Description
`static enum`
`Nls.Capitalization`

## Optional Element Summary

Optional Elements
Modifier and Type
Optional Element
Description
`Nls.Capitalization`
`capitalization`

## Element Details

### capitalization

Nls.Capitalization capitalization

Default:
  `NotSpecified`