org.sonar.plugins.api
Class Java

java.lang.Object
  org.sonar.plugins.api.AbstractLanguage
      org.sonar.plugins.api.Java

All Implemented Interfaces:

Language, Extension, MavenExtension, ServerExtension

public class Java
extends AbstractLanguage

Field Summary

static java.lang.String	DEFAULT_PACKAGE_NAME
static java.lang.String	KEY
static java.lang.String[]	SUFFIXES

Constructor Summary

Java()

Method Summary

java.lang.String[]	getFileSuffixes()
Resource	getParent(Resource resource) The parent in the resources tree.
boolean	matchExclusionPattern(Resource resource, java.lang.String wildcardPattern) Used to exclude resources from analysis.
static Resource	newClass(java.lang.String key) Example : "org.foo.MyClass"
static Resource	newClass(java.lang.String key, boolean hasJavaSuffix) examples : newClass("org.foo.MyClass", false) newClass("org.foo.MyClass.java", true)
static Resource	newClass(java.lang.String packageKey, java.lang.String classKey, boolean hasJavaSuffix) examples : newClass("org.foo", "MyClass", false) newClass("org.foo", "MyClass.java", true)
static Resource	newClassFromAbsolutePath(java.lang.String path, java.util.List<java.lang.String> sourceDirs)
static Resource	newPackage(java.lang.String key) example : org.foo or null for default java package
static Resource	newUnitTestClass(java.lang.String key, boolean hasJavaSuffix)
static Resource	newUnitTestClass(java.lang.String packageKey, java.lang.String classKey, boolean hasJavaSuffix)
static Resource	newUnitTestClassFromAbsolutePath(java.lang.String path, java.util.List<java.lang.String> sourceDirs)

Methods inherited from class org.sonar.plugins.api.AbstractLanguage

equals, getKey, getName, hashCode, setName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

DEFAULT_PACKAGE_NAME

public static final java.lang.String DEFAULT_PACKAGE_NAME

See Also:

Constant Field Values

SUFFIXES

public static final java.lang.String[] SUFFIXES

Constructor Detail

Java

public Java()

Method Detail

getFileSuffixes

public java.lang.String[] getFileSuffixes()

newPackage

public static Resource newPackage(java.lang.String key)

example : org.foo or null for default java package

newClass

public static Resource newClass(java.lang.String packageKey,
                                java.lang.String classKey,
                                boolean hasJavaSuffix)

examples :

• newClass("org.foo", "MyClass", false)
• newClass("org.foo", "MyClass.java", true)

newClass

public static Resource newClass(java.lang.String key)

Example : "org.foo.MyClass"

newClass

public static Resource newClass(java.lang.String key,
                                boolean hasJavaSuffix)

examples :

• newClass("org.foo.MyClass", false)
• newClass("org.foo.MyClass.java", true)

newUnitTestClass

public static Resource newUnitTestClass(java.lang.String packageKey,
                                        java.lang.String classKey,
                                        boolean hasJavaSuffix)

newUnitTestClass

public static Resource newUnitTestClass(java.lang.String key,
                                        boolean hasJavaSuffix)

newClassFromAbsolutePath

public static Resource newClassFromAbsolutePath(java.lang.String path,
                                                java.util.List<java.lang.String> sourceDirs)

newUnitTestClassFromAbsolutePath

public static Resource newUnitTestClassFromAbsolutePath(java.lang.String path,
                                                        java.util.List<java.lang.String> sourceDirs)

getParent

public Resource getParent(Resource resource)

Description copied from interface: Language

The parent in the resources tree. For example Java packages are parents of Java classes. Projects are not taken into account, so Java packages have no parent and getParent(a Java package) returns null.

matchExclusionPattern

public boolean matchExclusionPattern(Resource resource,
                                     java.lang.String wildcardPattern)

Description copied from interface: Language

Used to exclude resources from analysis.