org.sonar.api.resources
Class Resource<PARENT extends Resource>

java.lang.Object
  extended by org.sonar.api.resources.Resource<PARENT>
Direct Known Subclasses:
Directory, File, JavaFile, JavaPackage, Library, Project

public abstract class Resource<PARENT extends Resource>
extends java.lang.Object

The interface to implement to create a resource in Sonar

Since:
1.10

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

SCOPE_SET

public static final java.lang.String SCOPE_SET
See Also:
Constant Field Values

SCOPE_SPACE

public static final java.lang.String SCOPE_SPACE
See Also:
Constant Field Values

SCOPE_ENTITY

public static final java.lang.String SCOPE_ENTITY
See Also:
Constant Field Values

SCOPE_PROJECT

@Deprecated
public static final java.lang.String SCOPE_PROJECT
Deprecated. 
Use SCOPE_SET instead

See Also:
Constant Field Values

SCOPE_DIRECTORY

@Deprecated
public static final java.lang.String SCOPE_DIRECTORY
Deprecated. 
Use SCOPE_SPACE instead

See Also:
Constant Field Values

SCOPE_FILE

@Deprecated
public static final java.lang.String SCOPE_FILE
Deprecated. 
Use SCOPE_ENTITY instead

See Also:
Constant Field Values

QUALIFIER_VIEW

public static final java.lang.String QUALIFIER_VIEW
See Also:
Constant Field Values

QUALIFIER_SUBVIEW

public static final java.lang.String QUALIFIER_SUBVIEW
See Also:
Constant Field Values

QUALIFIER_LIB

public static final java.lang.String QUALIFIER_LIB
See Also:
Constant Field Values

QUALIFIER_PROJECT

public static final java.lang.String QUALIFIER_PROJECT
See Also:
Constant Field Values

QUALIFIER_MODULE

public static final java.lang.String QUALIFIER_MODULE
See Also:
Constant Field Values

QUALIFIER_PACKAGE

public static final java.lang.String QUALIFIER_PACKAGE
See Also:
Constant Field Values

QUALIFIER_DIRECTORY

public static final java.lang.String QUALIFIER_DIRECTORY
See Also:
Constant Field Values

QUALIFIER_FILE

public static final java.lang.String QUALIFIER_FILE
See Also:
Constant Field Values

QUALIFIER_CLASS

public static final java.lang.String QUALIFIER_CLASS
See Also:
Constant Field Values

QUALIFIER_FIELD

public static final java.lang.String QUALIFIER_FIELD
See Also:
Constant Field Values

QUALIFIER_METHOD

public static final java.lang.String QUALIFIER_METHOD
See Also:
Constant Field Values

QUALIFIER_UNIT_TEST_CLASS

public static final java.lang.String QUALIFIER_UNIT_TEST_CLASS
See Also:
Constant Field Values

QUALIFIER_PROJECT_TRUNK

@Deprecated
public static final java.lang.String QUALIFIER_PROJECT_TRUNK
Deprecated. 
Use QUALIFIER_PROJECT instead

See Also:
Constant Field Values

QUALIFIER_PROJECT_BRANCH

@Deprecated
public static final java.lang.String QUALIFIER_PROJECT_BRANCH
Deprecated. 
Use QUALIFIER_MODULE instead

See Also:
Constant Field Values
Constructor Detail

Resource

public Resource()
Method Detail

getKey

public final java.lang.String getKey()
Returns:
the resource key

setKey

protected void setKey(java.lang.String s)

getName

public abstract java.lang.String getName()
Returns:
the resource name

getLongName

public abstract java.lang.String getLongName()
Returns:
the resource long name

getDescription

public abstract java.lang.String getDescription()
Returns:
the resource description

getLanguage

public abstract Language getLanguage()
Returns:
the language

getScope

public abstract java.lang.String getScope()
Returns:
the scope

getQualifier

public abstract java.lang.String getQualifier()
Returns:
the qualifier

getParent

public abstract PARENT getParent()
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.


matchFilePattern

public abstract boolean matchFilePattern(java.lang.String antPattern)
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

getId

public final java.lang.Integer getId()

setId

public Resource setId(java.lang.Integer id)
Internal use only


getEffectiveKey

public final java.lang.String getEffectiveKey()

setEffectiveKey

public final Resource setEffectiveKey(java.lang.String effectiveKey)
Internal use only


isExcluded

public final boolean isExcluded()

setExcluded

public final Resource setExcluded(boolean b)
Internal use only


equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2009-2010 SonarSource SA. All Rights Reserved.