/*
* Copyright (c) 2007-2009, Osmorc Development Team
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of 'Osmorc Development Team' nor the names of its contributors may be
* used to endorse or promote products derived from this software without specific
* prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.osmorc.inspection;
import com.intellij.codeHighlighting.HighlightDisplayLevel;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.ProblemHighlightType;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.psi.*;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.osmorc.facet.OsmorcFacet;
/**
* Inspection that reports classes which are located in the default package. These classes cannot be imported or
* exported in OSGi.
*
* @author <a href="mailto:janthomae@janthomae.de">Jan Thomä</a>
* @version $Id$
*/
public class ClassInDefaultPackageInspection extends LocalInspectionTool
{
@Nls
@NotNull
public String getGroupDisplayName()
{
return "OSGi";
}
public boolean isEnabledByDefault()
{
return true;
}
@NotNull
public HighlightDisplayLevel getDefaultLevel()
{
return HighlightDisplayLevel.ERROR;
}
@Nls
@NotNull
public String getDisplayName()
{
return "Class is in default package";
}
@NonNls
@NotNull
public String getShortName()
{
return "osmorcClassInDefaultPackage";
}
@NotNull
public PsiElementVisitor buildVisitor(@NotNull final ProblemsHolder holder, boolean isOnTheFly)
{
return new JavaElementVisitor()
{
public void visitReferenceExpression(PsiReferenceExpression expression)
{
}
@Override
public void visitClass(PsiClass psiClass)
{
if (OsmorcFacet.hasOsmorcFacet(psiClass))
{
PsiJavaFile file = (PsiJavaFile) psiClass.getContainingFile();
if ("".equals(file.getPackageName()))
{
PsiIdentifier nameIdentifier = psiClass.getNameIdentifier();
if (nameIdentifier != null) {
holder.registerProblem(nameIdentifier, "Class is in default package",
ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
}
}
}
}
};
}
}