org.sonar.api.resources
Class JavaClass

java.lang.Object
  org.sonar.api.resources.AbstractResource<JavaPackage>
      org.sonar.api.resources.JavaClass

All Implemented Interfaces:

Resource

public class JavaClass
extends AbstractResource<JavaPackage>

Field Summary

Fields inherited from interface org.sonar.api.resources.Resource

QUALIFIER_CLASS, QUALIFIER_DIRECTORY, QUALIFIER_FILE, QUALIFIER_PACKAGE, QUALIFIER_PROJECT_BRANCH, QUALIFIER_PROJECT_TRUNK, QUALIFIER_UNIT_TEST_CLASS, SCOPE_DIRECTORY, SCOPE_FILE, SCOPE_FUNCTION, SCOPE_PROJECT

Constructor Summary

JavaClass(java.lang.String key)

JavaClass(java.lang.String key, boolean unitTest)

JavaClass(java.lang.String packageName, java.lang.String className)

JavaClass(java.lang.String packageName, java.lang.String className, boolean unitTest)

Method Summary

static JavaClass	fromAbsolutePath(java.lang.String path, java.util.List<java.io.File> sourceDirs, boolean unitTest)
static JavaClass	fromFile(java.io.File file, java.util.List<java.io.File> sourceDirs, boolean unitTest)
java.lang.String	getClassName()
java.lang.String	getPackageName()
JavaPackage	getParent() The parent is used to build the resources tree, for example for relations between classes, packages and projects.
boolean	matchFilePattern(java.lang.String antPattern) Check resource against an Ant pattern, like mypackag?/*Foo.java.

Methods inherited from class org.sonar.api.resources.AbstractResource

equals, getDescription, getKey, getLanguage, getName, getQualifier, getScope, hashCode, setDescription, setKey, setLanguage, setName, setQualifier, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaClass

public JavaClass(java.lang.String packageName,
                 java.lang.String className)

JavaClass

public JavaClass(java.lang.String packageName,
                 java.lang.String className,
                 boolean unitTest)

JavaClass

public JavaClass(java.lang.String key)

JavaClass

public JavaClass(java.lang.String key,
                 boolean unitTest)

Method Detail

getPackageName

public java.lang.String getPackageName()

getClassName

public java.lang.String getClassName()

getParent

public JavaPackage getParent()

Description copied from interface: Resource

The parent is used to build the resources tree, for example for relations between classes, packages and projects.

Return null if the parent is the project.

Specified by:

getParent in interface Resource

Overrides:

getParent in class AbstractResource<JavaPackage>

matchFilePattern

public boolean matchFilePattern(java.lang.String antPattern)

Description copied from interface: Resource

Check resource against an Ant pattern, like mypackag?/*Foo.java. It's used for example to match resource exclusions.

Parameters:

antPattern - Ant-like pattern (with **, * and ?). It includes file suffixes.

Returns:

true if the resource matches the Ant pattern

fromFile

public static JavaClass fromFile(java.io.File file,
                                 java.util.List<java.io.File> sourceDirs,
                                 boolean unitTest)

fromAbsolutePath

public static JavaClass fromAbsolutePath(java.lang.String path,
                                         java.util.List<java.io.File> sourceDirs,
                                         boolean unitTest)