|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.api.resources.Resource<PARENT>
public abstract class Resource<PARENT extends Resource>
The interface to implement to create a resource in Sonar
Field Summary | |
---|---|
static java.lang.String |
QUALIFIER_CLASS
|
static java.lang.String |
QUALIFIER_DIRECTORY
|
static java.lang.String |
QUALIFIER_FIELD
|
static java.lang.String |
QUALIFIER_FILE
|
static java.lang.String |
QUALIFIER_LIB
|
static java.lang.String |
QUALIFIER_METHOD
|
static java.lang.String |
QUALIFIER_MODULE
|
static java.lang.String |
QUALIFIER_PACKAGE
|
static java.lang.String |
QUALIFIER_PROJECT
|
static java.lang.String |
QUALIFIER_PROJECT_BRANCH
Deprecated. |
static java.lang.String |
QUALIFIER_PROJECT_TRUNK
Deprecated. |
static java.lang.String |
QUALIFIER_SUBVIEW
|
static java.lang.String |
QUALIFIER_UNIT_TEST_CLASS
|
static java.lang.String |
QUALIFIER_VIEW
|
static java.lang.String |
SCOPE_DIRECTORY
Deprecated. |
static java.lang.String |
SCOPE_ENTITY
|
static java.lang.String |
SCOPE_FILE
Deprecated. |
static java.lang.String |
SCOPE_PROJECT
Deprecated. |
static java.lang.String |
SCOPE_SET
|
static java.lang.String |
SCOPE_SPACE
|
Constructor Summary | |
---|---|
Resource()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
abstract java.lang.String |
getDescription()
|
java.lang.String |
getEffectiveKey()
|
java.lang.Integer |
getId()
|
java.lang.String |
getKey()
|
abstract Language |
getLanguage()
|
abstract java.lang.String |
getLongName()
|
abstract java.lang.String |
getName()
|
abstract PARENT |
getParent()
The parent is used to build the resources tree, for example for relations between classes, packages and projects. |
abstract java.lang.String |
getQualifier()
|
abstract java.lang.String |
getScope()
|
int |
hashCode()
|
boolean |
isExcluded()
|
abstract boolean |
matchFilePattern(java.lang.String antPattern)
Check resource against an Ant pattern, like mypackag?/*Foo.java. |
Resource |
setEffectiveKey(java.lang.String effectiveKey)
Internal use only |
Resource |
setExcluded(boolean b)
Internal use only |
Resource |
setId(java.lang.Integer id)
Internal use only |
protected void |
setKey(java.lang.String s)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SCOPE_SET
public static final java.lang.String SCOPE_SPACE
public static final java.lang.String SCOPE_ENTITY
@Deprecated public static final java.lang.String SCOPE_PROJECT
@Deprecated public static final java.lang.String SCOPE_DIRECTORY
@Deprecated public static final java.lang.String SCOPE_FILE
public static final java.lang.String QUALIFIER_VIEW
public static final java.lang.String QUALIFIER_SUBVIEW
public static final java.lang.String QUALIFIER_LIB
public static final java.lang.String QUALIFIER_PROJECT
public static final java.lang.String QUALIFIER_MODULE
public static final java.lang.String QUALIFIER_PACKAGE
public static final java.lang.String QUALIFIER_DIRECTORY
public static final java.lang.String QUALIFIER_FILE
public static final java.lang.String QUALIFIER_CLASS
public static final java.lang.String QUALIFIER_FIELD
public static final java.lang.String QUALIFIER_METHOD
public static final java.lang.String QUALIFIER_UNIT_TEST_CLASS
@Deprecated public static final java.lang.String QUALIFIER_PROJECT_TRUNK
@Deprecated public static final java.lang.String QUALIFIER_PROJECT_BRANCH
Constructor Detail |
---|
public Resource()
Method Detail |
---|
public final java.lang.String getKey()
protected void setKey(java.lang.String s)
public abstract java.lang.String getName()
public abstract java.lang.String getLongName()
public abstract java.lang.String getDescription()
public abstract Language getLanguage()
public abstract java.lang.String getScope()
public abstract java.lang.String getQualifier()
public abstract PARENT getParent()
Return null if the parent is the project.
public abstract boolean matchFilePattern(java.lang.String antPattern)
antPattern
- Ant-like pattern (with **, * and ?). It includes file suffixes.
public final java.lang.Integer getId()
public Resource setId(java.lang.Integer id)
public final java.lang.String getEffectiveKey()
public final Resource setEffectiveKey(java.lang.String effectiveKey)
public final boolean isExcluded()
public final Resource setExcluded(boolean b)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |