Skip to content

Commit 0f26f95

Browse files
committed
Fixed CheckStyle issues
1 parent 5eca487 commit 0f26f95

File tree

3 files changed

+25
-9
lines changed

3 files changed

+25
-9
lines changed

src/com/magento/idea/magento2plugin/indexes/EventIndex.java

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* Copyright © Magento, Inc. All rights reserved.
33
* See COPYING.txt for license details.
44
*/
5+
56
package com.magento.idea.magento2plugin.indexes;
67

78
import com.intellij.openapi.project.Project;
@@ -15,7 +16,6 @@
1516
import com.magento.idea.magento2plugin.stubs.indexes.EventNameIndex;
1617
import com.magento.idea.magento2plugin.stubs.indexes.EventObserverIndex;
1718
import com.magento.idea.magento2plugin.util.xml.XmlPsiTreeUtil;
18-
1919
import java.util.ArrayList;
2020
import java.util.Collection;
2121

@@ -24,6 +24,9 @@ public class EventIndex {
2424
private static EventIndex INSTANCE; //NOPMD
2525
private Project project;
2626

27+
/**
28+
* Gets singleton instance.
29+
*/
2730
public static EventIndex getInstance(final Project project) {
2831
if (null == INSTANCE) { //NOPMD
2932
INSTANCE = new EventIndex();
@@ -33,7 +36,13 @@ public static EventIndex getInstance(final Project project) {
3336
return INSTANCE;
3437
}
3538

36-
public Collection<PsiElement> getEventElements(final String name, final GlobalSearchScope scope) {
39+
/**
40+
* Gets event elements by event name.
41+
*/
42+
public Collection<PsiElement> getEventElements(
43+
final String name,
44+
final GlobalSearchScope scope
45+
) {
3746
final Collection<PsiElement> result = new ArrayList<>();
3847

3948
final Collection<VirtualFile> virtualFiles =
@@ -48,22 +57,26 @@ public Collection<PsiElement> getEventElements(final String name, final GlobalSe
4857
return result;
4958
}
5059

51-
public Collection<PsiElement> getObserver(
60+
/**
61+
* Gets observers by event-observer name combination.
62+
*/
63+
public Collection<PsiElement> getObservers(
5264
final String eventName,
5365
final String observerName,
5466
final GlobalSearchScope scope
5567
) {
5668
final Collection<PsiElement> result = new ArrayList<>();
57-
final Collection<VirtualFile> virtualFiles = FileBasedIndex.getInstance().getContainingFiles(
58-
EventObserverIndex.KEY, eventName, scope
59-
);
69+
final Collection<VirtualFile> virtualFiles
70+
= FileBasedIndex.getInstance().getContainingFiles(
71+
EventObserverIndex.KEY, eventName, scope
72+
);
6073

6174
for (final VirtualFile virtualFile: virtualFiles) {
6275
final XmlFile eventsXmlFile
6376
= (XmlFile) PsiManager.getInstance(project).findFile(virtualFile);
6477
if (eventsXmlFile != null) {
6578
result.addAll(
66-
XmlPsiTreeUtil.findObserverTag(eventsXmlFile, eventName, observerName)
79+
XmlPsiTreeUtil.findObserverTags(eventsXmlFile, eventName, observerName)
6780
);
6881
}
6982
}

src/com/magento/idea/magento2plugin/reference/provider/ObserverNameReferenceProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class ObserverNameReferenceProvider extends @NotNull PsiReferenceProvider
3030

3131
final String observerName = ((XmlAttributeValueImpl) element).getValue();
3232
final Collection<PsiElement> observers
33-
= EventIndex.getInstance(element.getProject()).getObserver(
33+
= EventIndex.getInstance(element.getProject()).getObservers(
3434
eventName, observerName, GlobalSearchScope.allScope(element.getProject())
3535
);
3636

src/com/magento/idea/magento2plugin/util/xml/XmlPsiTreeUtil.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,10 @@ public static XmlTag getTypeTagOfArgument(final XmlElement psiArgumentValueEleme
5151
return PsiTreeUtil.getParentOfType(argumentsTag, XmlTag.class);
5252
}
5353

54-
public static Collection<XmlAttributeValue> findObserverTag(
54+
/**
55+
* Finds observer tags by event-observer name combination.
56+
*/
57+
public static Collection<XmlAttributeValue> findObserverTags(
5558
final XmlFile xmlFile,
5659
final String eventName,
5760
final String observerName

0 commit comments

Comments
 (0)