org.sonar.api.resources

Class Directory

java.lang.Object

org.sonar.api.resources.Resource

org.sonar.api.resources.Directory

All Implemented Interfaces:

Serializable

Deprecated.

since 5.6 replaced by InputDir.

@Deprecated
public class Directory
extends Resource

Since:

1.10

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT Deprecated.
static String	SEPARATOR Deprecated.

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

QUALIFIER_DIRECTORY, QUALIFIER_FILE, QUALIFIER_LIB, QUALIFIER_MODULE, QUALIFIER_PROJECT, QUALIFIER_SUBVIEW, QUALIFIER_VIEW, SCOPE_ENTITY, SCOPE_SET, SCOPE_SPACE

Method Summary

Modifier and Type	Method and Description
static Directory	create(String relativePathFromBaseDir) Deprecated. since 5.1 use FileSystem.inputDir(java.io.File)
static Directory	fromIOFile(File dir, Project module) Deprecated. since 5.1 use FileSystem.inputDir(java.io.File)
String	getDescription() Deprecated.
Language	getLanguage() Deprecated.
String	getLongName() Deprecated.
String	getName() Deprecated.
Resource	getParent() Deprecated. The parent is used to build the resources tree, for example for relations between files, directories and projects.
String	getQualifier() Deprecated. The qualifier tells the type of the resource.
String	getScope() Deprecated.
boolean	matchFilePattern(String antPattern) Deprecated. Check resource against an Ant pattern, like mypackag?/*Foo.java.
static String	parseKey(String key) Deprecated.
String	relativePathFromSourceDir() Deprecated. Internal.
String	toString() Deprecated.

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

equals, getEffectiveKey, getId, getKey, getPath, getUuid, hashCode, isExcluded, language, normalize, setEffectiveKey, setExcluded, setId, setKey, setPath, setUuid

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

Deprecated.

See Also:

Constant Field Values

ROOT

public static final String ROOT

Deprecated.

See Also:

Constant Field Values

Method Detail

relativePathFromSourceDir

public String relativePathFromSourceDir()

Deprecated.

Internal.

getName

public String getName()

Deprecated.

Specified by:

getName in class Resource

Returns:

the resource name

getLongName

public String getLongName()

Deprecated.

Specified by:

getLongName in class Resource

Returns:

the resource long name

getDescription

public String getDescription()

Deprecated.

Specified by:

getDescription in class Resource

Returns:

the resource description

getLanguage

public Language getLanguage()

Deprecated.

Specified by:

getLanguage in class Resource

Returns:

the language of the resource. Only Files may have a non null value.

getScope

public String getScope()

Deprecated.

Specified by:

getScope in class Resource

Returns:

the scope

getQualifier

public String getQualifier()

Deprecated.

Description copied from class: Resource

The qualifier tells the type of the resource. For example, it can be a File, a Class, a Project, a Unit Test...

Specified by:

getQualifier in class Resource

Returns:

the qualifier

See Also:

for the list of qualifiers, to find out if a resource if a class, a unit test,... from its qualifier

getParent

public Resource getParent()

Deprecated.

Description copied from class: Resource

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

Return null if the parent is the current project (or module in case of multi-module).

Specified by:

getParent in class Resource

matchFilePattern

public boolean matchFilePattern(String antPattern)

Deprecated.

Description copied from class: Resource

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

Specified by:

matchFilePattern in class Resource

Parameters:

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

Returns:

true if the resource matches the Ant pattern

parseKey

public static String parseKey(String key)

Deprecated.

fromIOFile

@Deprecated
 @CheckForNull
public static Directory fromIOFile(File dir,
                                                              Project module)

Deprecated. since 5.1 use FileSystem.inputDir(java.io.File)

Since:

4.2

create

@Deprecated
public static Directory create(String relativePathFromBaseDir)

Deprecated. since 5.1 use FileSystem.inputDir(java.io.File)

Internal use only.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object