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

Java language impl

Field Summary

static java.lang.String	DEFAULT_PACKAGE_NAME Default package name for classes without package def
static java.lang.String	KEY Java langauge key
static java.lang.String[]	SUFFIXES Java files knows suffixes

Constructor Summary

Java()
Default constructor

Method Summary

java.lang.String[]	getFileSuffixes() return the java files knows suffixes
Resource	getParent(Resource resource) Return the parent resource or null if resource has no parents
boolean	matchExclusionPattern(Resource resource, java.lang.String wildcardPattern) Matches an exclusion pattern on a given resource name without its suffix
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.io.File> sourceDirs)
static Resource	newClassFromFile(java.io.File file, java.util.List<java.io.File> 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) Creates a new unit test class
static Resource	newUnitTestClass(java.lang.String packageKey, java.lang.String classKey, boolean hasJavaSuffix) Creates a new unit test class
static Resource	newUnitTestClassFromAbsolutePath(java.lang.String path, java.util.List<java.io.File> sourceDirs)

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

equals, getKey, getName, getRelativePath, hashCode, matchExclusionPattern, 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

Java langauge key

See Also:

Constant Field Values

DEFAULT_PACKAGE_NAME

public static final java.lang.String DEFAULT_PACKAGE_NAME

Default package name for classes without package def

See Also:

Constant Field Values

SUFFIXES

public static final java.lang.String[] SUFFIXES

Java files knows suffixes

Constructor Detail

Java

public Java()

Default constructor

Method Detail

getFileSuffixes

public java.lang.String[] getFileSuffixes()

return the java files knows suffixes

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)

Creates a new unit test class

Parameters:

packageKey - the class package

classKey - the class name

hasJavaSuffix - true if the class name contains a java suffix at his end

Returns:

a new unit test class resource

newUnitTestClass

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

Creates a new unit test class

Parameters:

key - the resource key

hasJavaSuffix - true if the class name contains a java suffix at his end

Returns:

a new unit test class resource

newClassFromFile

public static Resource newClassFromFile(java.io.File file,
                                        java.util.List<java.io.File> sourceDirs)

newClassFromAbsolutePath

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

newUnitTestClassFromAbsolutePath

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

getParent

public Resource getParent(Resource resource)

Return the parent resource or null if resource has no parents

matchExclusionPattern

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

Matches an exclusion pattern on a given resource name without its suffix