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