public abstract class Resource extends Object implements Serializable
Modifier and Type | Field and Description |
---|---|
static String |
QUALIFIER_CLASS
Deprecated.
since 2.6. Use Qualifiers.CLASS.
|
static String |
QUALIFIER_DIRECTORY
Deprecated.
since 2.6. Use Qualifiers.DIRECTORY.
|
static String |
QUALIFIER_FIELD
Deprecated.
since 2.6. Use Qualifiers.FIELD.
|
static String |
QUALIFIER_FILE
Deprecated.
since 2.6. Use Qualifiers.FILE.
|
static String |
QUALIFIER_LIB
Deprecated.
since 2.6. Use Qualifiers.LIBRARY.
|
static String |
QUALIFIER_METHOD
Deprecated.
since 2.6. Use Qualifiers.METHOD.
|
static String |
QUALIFIER_MODULE
Deprecated.
since 2.6. Use Qualifiers.MODULE.
|
static String |
QUALIFIER_PACKAGE
Deprecated.
since 2.6. Use Qualifiers.PACKAGE.
|
static String |
QUALIFIER_PROJECT
Deprecated.
since 2.6. Use Qualifiers.PROJECT.
|
static String |
QUALIFIER_SUBVIEW
Deprecated.
since 2.6. Use Qualifiers.SUBVIEW.
|
static String |
QUALIFIER_UNIT_TEST_CLASS
Deprecated.
since 2.6. Use Qualifiers.UNIT_TEST_FILE.
|
static String |
QUALIFIER_VIEW
Deprecated.
since 2.6. Use Qualifiers.VIEW.
|
static String |
SCOPE_ENTITY
Deprecated.
since 2.6. Use Scopes.FILE.
|
static String |
SCOPE_SET
Deprecated.
since 2.6. Use Scopes.PROJECT.
|
static String |
SCOPE_SPACE
Deprecated.
since 2.6. Use Scopes.DIRECTORY.
|
Constructor and Description |
---|
Resource() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
abstract String |
getDescription() |
String |
getEffectiveKey() |
Integer |
getId() |
String |
getKey() |
abstract Language |
getLanguage()
Deprecated.
since 5.1 use
language() |
abstract String |
getLongName() |
abstract String |
getName() |
abstract Resource |
getParent()
The parent is used to build the resources tree, for example for relations between files, directories and projects.
|
String |
getPath() |
abstract String |
getQualifier()
The qualifier tells the type of the resource.
|
abstract String |
getScope() |
String |
getUuid() |
int |
hashCode() |
boolean |
isExcluded()
Deprecated.
since 2.6.
|
String |
language() |
abstract boolean |
matchFilePattern(String antPattern)
Check resource against an Ant pattern, like mypackag?/*Foo.java.
|
protected static String |
normalize(String path) |
Resource |
setEffectiveKey(String effectiveKey)
Internal use only
|
Resource |
setExcluded(boolean b)
Deprecated.
since 2.6 should use SensorContext#isExcluded(resource). It will make inheritance of Resource easier.
|
Resource |
setId(Integer id)
Internal use only
|
void |
setKey(String s)
Internal use only
|
Resource |
setPath(String path) |
void |
setUuid(String s)
Internal use only
|
@Deprecated public static final String SCOPE_SET
@Deprecated public static final String SCOPE_SPACE
@Deprecated public static final String SCOPE_ENTITY
@Deprecated public static final String QUALIFIER_VIEW
@Deprecated public static final String QUALIFIER_SUBVIEW
@Deprecated public static final String QUALIFIER_LIB
@Deprecated public static final String QUALIFIER_PROJECT
@Deprecated public static final String QUALIFIER_MODULE
@Deprecated public static final String QUALIFIER_PACKAGE
@Deprecated public static final String QUALIFIER_DIRECTORY
@Deprecated public static final String QUALIFIER_FILE
@Deprecated public static final String QUALIFIER_CLASS
@Deprecated public static final String QUALIFIER_FIELD
@Deprecated public static final String QUALIFIER_METHOD
@Deprecated public static final String QUALIFIER_UNIT_TEST_CLASS
public Resource()
public abstract String getLongName()
public abstract String getDescription()
@Deprecated @CheckForNull public abstract Language getLanguage()
language()
File
s may have a non null value.@CheckForNull public String language()
File
s may have a non null value.public abstract String getQualifier()
for the list of qualifiers
,
to find out if a resource if a class, a unit test,... from its qualifier
@CheckForNull public abstract Resource getParent()
Return null if the parent is the current project (or module in case of multi-module).
public abstract boolean matchFilePattern(String antPattern)
antPattern
- Ant-like pattern (with **, * and ?). It includes file suffixes.@CheckForNull protected static String normalize(@Nullable String path)
public String getEffectiveKey()
public final Resource setEffectiveKey(String effectiveKey)
@Deprecated public final boolean isExcluded()
@Deprecated public final Resource setExcluded(boolean b)
Copyright © 2009–2015 SonarSource. All rights reserved.