org.sonar.api.resources
Class JavaFile

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

All Implemented Interfaces:

Resource

public class JavaFile
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_PROJECT

Constructor Summary

JavaFile(java.lang.String key)

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

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

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

Method Summary

static JavaFile	fromAbsolutePath(java.lang.String path, java.util.List<java.io.File> sourceDirs, boolean unitTest)
static JavaFile	fromIOFile(java.io.File file, java.util.List<java.io.File> sourceDirs, boolean unitTest)
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.
JavaFile	setKey(java.lang.String key)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFile

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

JavaFile

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

JavaFile

public JavaFile(java.lang.String key)

JavaFile

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

Method Detail

setKey

public JavaFile setKey(java.lang.String key)

Overrides:

setKey in class AbstractResource<JavaPackage>

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

fromIOFile

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

fromAbsolutePath

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