From 918eddc194003b8ab2fb36a6d44a7cbf9542f657 Mon Sep 17 00:00:00 2001 From: Aleksey Pivovarov Date: Tue, 18 Aug 2020 22:23:55 +0300 Subject: [PATCH] vcs: i18n - annotate with Nls GitOrigin-RevId: 774c0759bce5a21f86a3b69567a5b08d0d13d79c --- .../src/com/intellij/openapi/ui/InputValidator.java | 6 ++++-- platform/core-ui/src/ui/TextAccessor.java | 3 +++ .../src/com/intellij/dvcs/push/PushTargetPanel.java | 3 ++- .../dvcs/push/ui/PushTargetEditorListener.java | 3 ++- platform/dvcs-impl/src/com/intellij/dvcs/DvcsUtil.java | 2 +- .../src/com/intellij/dvcs/push/PushController.java | 7 ++----- .../com/intellij/dvcs/push/RepositoryNodeListener.java | 3 ++- .../src/com/intellij/dvcs/push/ui/PushLog.java | 7 ++++--- .../src/com/intellij/dvcs/push/ui/RepositoryNode.java | 2 +- .../dvcs/push/ui/RepositoryWithBranchPanel.java | 2 +- .../src/com/intellij/openapi/wm/StatusBarWidget.java | 6 ++---- .../src/com/intellij/ui/EditorTextComponent.java | 2 ++ .../com/intellij/ide/file/BatchFileChangeListener.java | 3 ++- .../vcs/changes/ignore/lang/IgnoreLanguage.java | 2 +- .../intellij/util/ui/VcsExecutablePathSelector.java | 5 +++-- .../vcs-impl/src/com/intellij/vcs/VcsLocaleHelper.java | 10 ++++++---- .../src/com/intellij/vcs/log/impl/SimpleRefGroup.java | 7 ++++--- .../src/com/intellij/vcs/log/impl/SimpleRefType.java | 5 +++-- 18 files changed, 45 insertions(+), 33 deletions(-) diff --git a/platform/analysis-api/src/com/intellij/openapi/ui/InputValidator.java b/platform/analysis-api/src/com/intellij/openapi/ui/InputValidator.java index 552617f3e87d..2332f47bd4ee 100644 --- a/platform/analysis-api/src/com/intellij/openapi/ui/InputValidator.java +++ b/platform/analysis-api/src/com/intellij/openapi/ui/InputValidator.java @@ -15,6 +15,8 @@ */ package com.intellij.openapi.ui; +import org.jetbrains.annotations.NonNls; + /** * The validator for input dialogs. * @@ -31,7 +33,7 @@ public interface InputValidator { * @param inputString the input to check * @return true if input string is valid */ - boolean checkInput(String inputString); + boolean checkInput(@NonNls String inputString); /** * This method is invoked just before message dialog is closed with OK code. @@ -40,5 +42,5 @@ public interface InputValidator { * @param inputString the input to check * @return true if the dialog could be closed, false otherwise. */ - boolean canClose(String inputString); + boolean canClose(@NonNls String inputString); } diff --git a/platform/core-ui/src/ui/TextAccessor.java b/platform/core-ui/src/ui/TextAccessor.java index c6ea8652a343..d440d47e688e 100644 --- a/platform/core-ui/src/ui/TextAccessor.java +++ b/platform/core-ui/src/ui/TextAccessor.java @@ -1,8 +1,11 @@ // Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. package com.intellij.ui; +import com.intellij.openapi.util.NlsSafe; + public interface TextAccessor { void setText(String text); + @NlsSafe String getText(); } diff --git a/platform/dvcs-api/src/com/intellij/dvcs/push/PushTargetPanel.java b/platform/dvcs-api/src/com/intellij/dvcs/push/PushTargetPanel.java index cfbe45bd206e..a30cc6a47366 100644 --- a/platform/dvcs-api/src/com/intellij/dvcs/push/PushTargetPanel.java +++ b/platform/dvcs-api/src/com/intellij/dvcs/push/PushTargetPanel.java @@ -18,6 +18,7 @@ package com.intellij.dvcs.push; import com.intellij.dvcs.push.ui.PushTargetEditorListener; import com.intellij.openapi.ui.ValidationInfo; import com.intellij.ui.ColoredTreeCellRenderer; +import org.jetbrains.annotations.Nls; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -31,7 +32,7 @@ public abstract class PushTargetPanel extends JPanel { abstract public void render(@NotNull ColoredTreeCellRenderer renderer, boolean isSelected, boolean isActive, - @Nullable String forceRenderedText); + @Nullable @Nls String forceRenderedText); @Nullable abstract public T getValue(); diff --git a/platform/dvcs-api/src/com/intellij/dvcs/push/ui/PushTargetEditorListener.java b/platform/dvcs-api/src/com/intellij/dvcs/push/ui/PushTargetEditorListener.java index ce1de64fd9c5..fac2142bb9d8 100644 --- a/platform/dvcs-api/src/com/intellij/dvcs/push/ui/PushTargetEditorListener.java +++ b/platform/dvcs-api/src/com/intellij/dvcs/push/ui/PushTargetEditorListener.java @@ -15,8 +15,9 @@ */ package com.intellij.dvcs.push.ui; +import org.jetbrains.annotations.Nls; import org.jetbrains.annotations.NotNull; public interface PushTargetEditorListener { - void onTargetInEditModeChanged(@NotNull String value); + void onTargetInEditModeChanged(@NotNull @Nls String value); } diff --git a/platform/dvcs-impl/src/com/intellij/dvcs/DvcsUtil.java b/platform/dvcs-impl/src/com/intellij/dvcs/DvcsUtil.java index 7cd163e5ab00..a969ffba1d62 100644 --- a/platform/dvcs-impl/src/com/intellij/dvcs/DvcsUtil.java +++ b/platform/dvcs-impl/src/com/intellij/dvcs/DvcsUtil.java @@ -165,7 +165,7 @@ public final class DvcsUtil { } @NotNull - public static AccessToken workingTreeChangeStarted(@NotNull Project project, @Nullable String activityName) { + public static AccessToken workingTreeChangeStarted(@NotNull Project project, @Nullable @Nls String activityName) { BackgroundTaskUtil.syncPublisher(BatchFileChangeListener.TOPIC).batchChangeStarted(project, activityName); return new AccessToken() { @Override diff --git a/platform/dvcs-impl/src/com/intellij/dvcs/push/PushController.java b/platform/dvcs-impl/src/com/intellij/dvcs/push/PushController.java index fb7a4f6e017c..2524269e90cb 100644 --- a/platform/dvcs-impl/src/com/intellij/dvcs/push/PushController.java +++ b/platform/dvcs-impl/src/com/intellij/dvcs/push/PushController.java @@ -23,10 +23,7 @@ import com.intellij.util.concurrency.SequentialTaskExecutor; import com.intellij.util.containers.ContainerUtil; import com.intellij.util.progress.StepsProgressIndicator; import com.intellij.vcs.log.VcsFullCommitDetails; -import org.jetbrains.annotations.CalledInAny; -import org.jetbrains.annotations.NonNls; -import org.jetbrains.annotations.NotNull; -import org.jetbrains.annotations.Nullable; +import org.jetbrains.annotations.*; import javax.swing.*; import javax.swing.tree.DefaultMutableTreeNode; @@ -233,7 +230,7 @@ public final class PushController implements Disposable { } @Override - public void onTargetInEditMode(@NotNull String currentValue) { + public void onTargetInEditMode(@NotNull @Nls String currentValue) { myPushLog.fireEditorUpdated(currentValue); } }); diff --git a/platform/dvcs-impl/src/com/intellij/dvcs/push/RepositoryNodeListener.java b/platform/dvcs-impl/src/com/intellij/dvcs/push/RepositoryNodeListener.java index 2cb2f72e8e4a..5e0a0c4c4970 100644 --- a/platform/dvcs-impl/src/com/intellij/dvcs/push/RepositoryNodeListener.java +++ b/platform/dvcs-impl/src/com/intellij/dvcs/push/RepositoryNodeListener.java @@ -15,6 +15,7 @@ */ package com.intellij.dvcs.push; +import org.jetbrains.annotations.Nls; import org.jetbrains.annotations.NotNull; public interface RepositoryNodeListener { @@ -23,5 +24,5 @@ public interface RepositoryNodeListener { void onSelectionChanged(boolean isSelected); - void onTargetInEditMode(@NotNull String currentValue); + void onTargetInEditMode(@NotNull @Nls String currentValue); } diff --git a/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/PushLog.java b/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/PushLog.java index 4c4a439fe6bc..4fc4baa9260c 100644 --- a/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/PushLog.java +++ b/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/PushLog.java @@ -37,6 +37,7 @@ import com.intellij.vcs.log.ui.VcsLogActionPlaces; import com.intellij.vcs.log.ui.details.commit.CommitDetailsPanel; import kotlin.Unit; import one.util.streamex.StreamEx; +import org.jetbrains.annotations.Nls; import org.jetbrains.annotations.NonNls; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -70,7 +71,7 @@ public final class PushLog extends JPanel implements DataProvider { private final MyShowDetailsAction myShowDetailsAction; private boolean myShouldRepaint = false; private boolean mySyncStrategy; - @Nullable private String mySyncRenderedText; + @Nullable private @Nls String mySyncRenderedText; private final boolean myAllowSyncStrategy; public PushLog(Project project, final CheckedTreeNode root, final boolean allowSyncStrategy) { @@ -574,11 +575,11 @@ public final class PushLog extends JPanel implements DataProvider { } } - private void setSyncText(String value) { + private void setSyncText(@Nls String value) { mySyncRenderedText = value; } - public void fireEditorUpdated(@NotNull String currentText) { + public void fireEditorUpdated(@NotNull @Nls String currentText) { if (mySyncStrategy) { //update ui model List repositoryNodes = diff --git a/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryNode.java b/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryNode.java index 5c655a858d38..18d899ddd3d6 100644 --- a/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryNode.java +++ b/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryNode.java @@ -58,7 +58,7 @@ public class RepositoryNode extends CheckedTreeNode implements EditableTreeNode, render(renderer, null); } - public void render(@NotNull ColoredTreeCellRenderer renderer, @Nullable String syncEditingText) { + public void render(@NotNull ColoredTreeCellRenderer renderer, @Nullable @Nls String syncEditingText) { int repoFixedWidth = 120; SimpleTextAttributes repositoryDetailsTextAttributes = PushLogTreeUtil .addTransparencyIfNeeded(renderer, SimpleTextAttributes.REGULAR_ATTRIBUTES, isChecked()); diff --git a/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryWithBranchPanel.java b/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryWithBranchPanel.java index 3f40cd9d62c1..4e1e5e9653a4 100644 --- a/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryWithBranchPanel.java +++ b/platform/dvcs-impl/src/com/intellij/dvcs/push/ui/RepositoryWithBranchPanel.java @@ -144,7 +144,7 @@ public class RepositoryWithBranchPanel extends NonOpaquePa myDestPushTargetPanelComponent.addTargetEditorListener(new PushTargetEditorListener() { @Override - public void onTargetInEditModeChanged(@NotNull String value) { + public void onTargetInEditModeChanged(@NotNull @Nls String value) { for (RepositoryNodeListener listener : myListeners) { listener.onTargetInEditMode(value); } diff --git a/platform/platform-api/src/com/intellij/openapi/wm/StatusBarWidget.java b/platform/platform-api/src/com/intellij/openapi/wm/StatusBarWidget.java index e906f8348ded..f96960d72778 100644 --- a/platform/platform-api/src/com/intellij/openapi/wm/StatusBarWidget.java +++ b/platform/platform-api/src/com/intellij/openapi/wm/StatusBarWidget.java @@ -8,10 +8,7 @@ import com.intellij.openapi.util.NlsContexts.Tooltip; import com.intellij.openapi.util.SystemInfo; import com.intellij.util.Consumer; import com.intellij.util.ui.JBUI; -import org.jetbrains.annotations.ApiStatus; -import org.jetbrains.annotations.NonNls; -import org.jetbrains.annotations.NotNull; -import org.jetbrains.annotations.Nullable; +import org.jetbrains.annotations.*; import javax.swing.*; import javax.swing.border.Border; @@ -59,6 +56,7 @@ public interface StatusBarWidget extends Disposable { @Tooltip String getTooltipText(); + @Nls @Nullable default String getShortcutText() { return null; } diff --git a/platform/platform-api/src/com/intellij/ui/EditorTextComponent.java b/platform/platform-api/src/com/intellij/ui/EditorTextComponent.java index f18eb90fead5..a8c2915a0be5 100644 --- a/platform/platform-api/src/com/intellij/ui/EditorTextComponent.java +++ b/platform/platform-api/src/com/intellij/ui/EditorTextComponent.java @@ -17,12 +17,14 @@ package com.intellij.ui; import com.intellij.openapi.editor.Document; import com.intellij.openapi.editor.event.DocumentListener; +import com.intellij.openapi.util.NlsSafe; import org.jetbrains.annotations.NotNull; import javax.swing.*; public interface EditorTextComponent { + @NlsSafe String getText(); JComponent getComponent(); diff --git a/platform/platform-impl/src/com/intellij/ide/file/BatchFileChangeListener.java b/platform/platform-impl/src/com/intellij/ide/file/BatchFileChangeListener.java index 4c4619321532..9681742d4e61 100644 --- a/platform/platform-impl/src/com/intellij/ide/file/BatchFileChangeListener.java +++ b/platform/platform-impl/src/com/intellij/ide/file/BatchFileChangeListener.java @@ -3,6 +3,7 @@ package com.intellij.ide.file; import com.intellij.openapi.project.Project; import com.intellij.util.messages.Topic; +import org.jetbrains.annotations.Nls; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -19,7 +20,7 @@ public interface BatchFileChangeListener { * @param project Project where many file changes are expected to happen * @param activityName the name of the activity (a noun phrase) causing this file change */ - default void batchChangeStarted(@NotNull Project project, @Nullable String activityName) {} + default void batchChangeStarted(@NotNull Project project, @Nullable @Nls String activityName) {} default void batchChangeCompleted(@NotNull Project project) {} } diff --git a/platform/vcs-impl/src/com/intellij/openapi/vcs/changes/ignore/lang/IgnoreLanguage.java b/platform/vcs-impl/src/com/intellij/openapi/vcs/changes/ignore/lang/IgnoreLanguage.java index 79df8c702ab5..fb2d2863ab4b 100644 --- a/platform/vcs-impl/src/com/intellij/openapi/vcs/changes/ignore/lang/IgnoreLanguage.java +++ b/platform/vcs-impl/src/com/intellij/openapi/vcs/changes/ignore/lang/IgnoreLanguage.java @@ -50,7 +50,7 @@ public class IgnoreLanguage extends Language { this("IgnoreLang", "ignore"); } - protected IgnoreLanguage(@NotNull String name, @NotNull String extension) { + protected IgnoreLanguage(@NotNull @NonNls String name, @NotNull @NonNls String extension) { super(INSTANCE, name, ArrayUtilRt.EMPTY_STRING_ARRAY); myExtension = extension; } diff --git a/platform/vcs-impl/src/com/intellij/util/ui/VcsExecutablePathSelector.java b/platform/vcs-impl/src/com/intellij/util/ui/VcsExecutablePathSelector.java index a55ccc93697c..64ed4067bbca 100644 --- a/platform/vcs-impl/src/com/intellij/util/ui/VcsExecutablePathSelector.java +++ b/platform/vcs-impl/src/com/intellij/util/ui/VcsExecutablePathSelector.java @@ -13,6 +13,7 @@ import com.intellij.ui.components.JBLabel; import com.intellij.ui.components.JBTextField; import com.intellij.util.ObjectUtils; import com.intellij.util.ui.components.BorderLayoutPanel; +import org.jetbrains.annotations.Nls; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -31,11 +32,11 @@ public class VcsExecutablePathSelector { @NotNull private String myAutoDetectedPath = ""; @Deprecated - public VcsExecutablePathSelector(@NotNull String vcsName, @NotNull Consumer executableTester) { + public VcsExecutablePathSelector(@NotNull @Nls String vcsName, @NotNull Consumer executableTester) { this(vcsName, null, (path) -> executableTester.accept(path)); } - public VcsExecutablePathSelector(@NotNull String vcsName, @Nullable Disposable disposable, @NotNull ExecutableHandler handler) { + public VcsExecutablePathSelector(@NotNull @Nls String vcsName, @Nullable Disposable disposable, @NotNull ExecutableHandler handler) { BorderLayoutPanel panel = JBUI.Panels.simplePanel(UIUtil.DEFAULT_HGAP, 0); myPathSelector = new TextFieldWithBrowseButton(null, disposable); diff --git a/platform/vcs-impl/src/com/intellij/vcs/VcsLocaleHelper.java b/platform/vcs-impl/src/com/intellij/vcs/VcsLocaleHelper.java index 6845cbd969de..792372d26076 100644 --- a/platform/vcs-impl/src/com/intellij/vcs/VcsLocaleHelper.java +++ b/platform/vcs-impl/src/com/intellij/vcs/VcsLocaleHelper.java @@ -2,6 +2,7 @@ package com.intellij.vcs; import com.intellij.openapi.util.registry.Registry; +import org.jetbrains.annotations.NonNls; import org.jetbrains.annotations.NotNull; import java.util.LinkedHashMap; @@ -10,11 +11,12 @@ import java.util.MissingResourceException; public final class VcsLocaleHelper { - private static final String DEFAULT_EXECUTABLE_LOCALE_VALUE = "en_US.UTF-8"; - private static final String REGISTRY_KEY_SUFFIX = ".executable.locale"; + private static final @NonNls String DEFAULT_EXECUTABLE_LOCALE_VALUE = "en_US.UTF-8"; + private static final @NonNls String REGISTRY_KEY_SUFFIX = ".executable.locale"; + @NonNls @NotNull - public static String getDefaultLocaleFromRegistry(@NotNull String prefix) { + public static String getDefaultLocaleFromRegistry(@NotNull @NonNls String prefix) { String registryKey = prefix + REGISTRY_KEY_SUFFIX; try { return Registry.stringValue(registryKey); @@ -25,7 +27,7 @@ public final class VcsLocaleHelper { } @NotNull - public static Map getDefaultLocaleEnvironmentVars(@NotNull String prefix) { + public static Map getDefaultLocaleEnvironmentVars(@NotNull @NonNls String prefix) { Map envMap = new LinkedHashMap<>(); String defaultLocale = getDefaultLocaleFromRegistry(prefix); if (defaultLocale.isEmpty()) { // let skip locale definition if needed diff --git a/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefGroup.java b/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefGroup.java index 04622eed132b..2e1f93b2eb51 100644 --- a/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefGroup.java +++ b/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefGroup.java @@ -6,6 +6,7 @@ import com.intellij.util.containers.MultiMap; import com.intellij.vcs.log.RefGroup; import com.intellij.vcs.log.VcsRef; import com.intellij.vcs.log.VcsRefType; +import org.jetbrains.annotations.Nls; import org.jetbrains.annotations.NotNull; import java.awt.*; @@ -13,15 +14,15 @@ import java.util.List; import java.util.*; public class SimpleRefGroup implements RefGroup { - @NotNull private final String myName; + @NotNull private final @Nls String myName; @NotNull private final List myRefs; private final boolean myExpanded; - public SimpleRefGroup(@NotNull String name, @NotNull List refs) { + public SimpleRefGroup(@NotNull @Nls String name, @NotNull List refs) { this(name, refs, false); } - public SimpleRefGroup(@NotNull String name, @NotNull List refs, boolean expanded) { + public SimpleRefGroup(@NotNull @Nls String name, @NotNull List refs, boolean expanded) { myName = name; myRefs = refs; myExpanded = expanded; diff --git a/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefType.java b/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefType.java index 25462337c82d..f0523399bf6b 100644 --- a/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefType.java +++ b/platform/vcs-log/impl/src/com/intellij/vcs/log/impl/SimpleRefType.java @@ -2,17 +2,18 @@ package com.intellij.vcs.log.impl; import com.intellij.vcs.log.VcsRefType; +import org.jetbrains.annotations.NonNls; import org.jetbrains.annotations.NotNull; import java.awt.*; import java.util.Objects; public class SimpleRefType implements VcsRefType { - @NotNull private final String myName; + @NotNull private final @NonNls String myName; private final boolean myIsBranch; @NotNull private final Color myColor; - public SimpleRefType(@NotNull String name, boolean isBranch, @NotNull Color color) { + public SimpleRefType(@NotNull @NonNls String name, boolean isBranch, @NotNull Color color) { myName = name; myIsBranch = isBranch; myColor = color;