Top Description Inners Methods
org.jetbrains.annotations

public @Interface Nls

extends Annotation
Annotations
@Documented
@Retention:CLASS
@Target:METHOD, FIELD, PARAMETER, LOCAL_VARIABLE, TYPE_USE, TYPE, PACKAGE
Imports
java.lang.annotation.Documented, .ElementType, .Retention, .RetentionPolicy, .Target

Specifies that an element of the program is a 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 and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Method Summary

Modifier and TypeMethod and Description
public Nls.Capitalization
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

capitalizationback to summary
public Nls.Capitalization capitalization()
org.jetbrains.annotations back to summary

public final Enum Nls.Capitalization

extends Enum<Nls.Capitalization>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Nls.Capitalization
public static final Nls.Capitalization
Sentence

e.g. This is a sentence

public static final Nls.Capitalization
Title

e.g. This Is a Title

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static Nls.Capitalization
public static Nls.Capitalization[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

NotSpecifiedback to summary
public static final Nls.Capitalization NotSpecified
Sentenceback to summary
public static final Nls.Capitalization Sentence

e.g. This is a sentence

Titleback to summary
public static final Nls.Capitalization Title

e.g. This Is a Title

Constructor Detail

Capitalizationback to summary
private Capitalization()

Method Detail

valueOfback to summary
public static Nls.Capitalization valueOf(String name)
valuesback to summary
public static Nls.Capitalization[] values()