Resource (SonarQube :: Plugin API 6.0 API)

java.lang.Object
- org.sonar.api.resources.Resource

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Directory, File, Library, Project

Deprecated.
since 5.6 replaced by InputComponent
```
@Deprecated
public abstract class Resource
extends Object
implements Serializable
```
Since:

1.10

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`QUALIFIER_DIRECTORY` Deprecated. since 2.6. Use Qualifiers.DIRECTORY.
`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_MODULE` Deprecated. since 2.6. Use Qualifiers.MODULE.
`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_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 Summary

Constructors
Constructor and Description

Resource()
Deprecated.

Constructors
Constructor and Description
`Resource()` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Deprecated.
`abstract String`	`getDescription()` Deprecated.
`String`	`getEffectiveKey()` Deprecated.
`Integer`	`getId()` Deprecated.
`String`	`getKey()` Deprecated.
`abstract Language`	`getLanguage()` Deprecated. since 5.1 use `language()`
`abstract String`	`getLongName()` Deprecated.
`abstract String`	`getName()` Deprecated.
`abstract Resource`	`getParent()` Deprecated. The parent is used to build the resources tree, for example for relations between files, directories and projects.
`String`	`getPath()` Deprecated.
`abstract String`	`getQualifier()` Deprecated. The qualifier tells the type of the resource.
`abstract String`	`getScope()` Deprecated.
`String`	`getUuid()` Deprecated.
`int`	`hashCode()` Deprecated.
`boolean`	`isExcluded()` Deprecated. since 2.6.
`String`	`language()` Deprecated.
`abstract boolean`	`matchFilePattern(String antPattern)` Deprecated. Check resource against an Ant pattern, like mypackag?/*Foo.java.
`protected static String`	`normalize(String path)` Deprecated.
`Resource`	`setEffectiveKey(String effectiveKey)` Deprecated. 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)` Deprecated. Internal use only
`void`	`setKey(String s)` Deprecated. Internal use only
`Resource`	`setPath(String path)` Deprecated.
`void`	`setUuid(String s)` Deprecated. Internal use only

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCOPE_SET
```
@Deprecated
public static final String SCOPE_SET
```
    Deprecated. since 2.6. Use Scopes.PROJECT.
    
    See Also:
    
    Constant Field Values
  - SCOPE_SPACE
```
@Deprecated
public static final String SCOPE_SPACE
```
    Deprecated. since 2.6. Use Scopes.DIRECTORY.
    
    See Also:
    
    Constant Field Values
  - SCOPE_ENTITY
```
@Deprecated
public static final String SCOPE_ENTITY
```
    Deprecated. since 2.6. Use Scopes.FILE.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER_VIEW
```
@Deprecated
public static final String QUALIFIER_VIEW
```
    Deprecated. since 2.6. Use Qualifiers.VIEW.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER_SUBVIEW
```
@Deprecated
public static final String QUALIFIER_SUBVIEW
```
    Deprecated. since 2.6. Use Qualifiers.SUBVIEW.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER_LIB
```
@Deprecated
public static final String QUALIFIER_LIB
```
    Deprecated. since 2.6. Use Qualifiers.LIBRARY.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER_PROJECT
```
@Deprecated
public static final String QUALIFIER_PROJECT
```
    Deprecated. since 2.6. Use Qualifiers.PROJECT.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER_MODULE
```
@Deprecated
public static final String QUALIFIER_MODULE
```
    Deprecated. since 2.6. Use Qualifiers.MODULE.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER_DIRECTORY
```
@Deprecated
public static final String QUALIFIER_DIRECTORY
```
    Deprecated. since 2.6. Use Qualifiers.DIRECTORY.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER_FILE
```
@Deprecated
public static final String QUALIFIER_FILE
```
    Deprecated. since 2.6. Use Qualifiers.FILE.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Resource
```
public Resource()
```
    Deprecated.
- Method Detail
  - getKey
```
public final String getKey()
```
    Deprecated.
    
    Returns:
    
    the resource key
  - setKey
```
public void setKey(String s)
```
    Deprecated.
    
    Internal use only
  - getUuid
```
public final String getUuid()
```
    Deprecated.
    
    Since:
    
    5.0
  - setUuid
```
public void setUuid(String s)
```
    Deprecated.
    
    Internal use only
  - getName
```
public abstract String getName()
```
    Deprecated.
    
    Returns:
    
    the resource name
  - getLongName
```
public abstract String getLongName()
```
    Deprecated.
    
    Returns:
    
    the resource long name
  - getDescription
```
public abstract String getDescription()
```
    Deprecated.
    
    Returns:
    
    the resource description
  - getLanguage
```
@Deprecated
 @CheckForNull
public abstract Language getLanguage()
```
    Deprecated. since 5.1 use language()
    
    Returns:
    
    the language of the resource. Only Files may have a non null value.
  - language
```
@CheckForNull
public String language()
```
    Deprecated.
    
    Returns:
    
    the language of the resource. Only Files may have a non null value.
  - getScope
```
public abstract String getScope()
```
    Deprecated.
    
    Returns:
    
    the scope
  - getQualifier
```
public abstract String getQualifier()
```
    Deprecated.
    
    The qualifier tells the type of the resource. For example, it can be a File, a Class, a Project, a Unit Test...
    
    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
```
@CheckForNull
public abstract Resource getParent()
```
    Deprecated.
    
    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).
  - matchFilePattern
```
public abstract boolean matchFilePattern(String antPattern)
```
    Deprecated.
    
    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 Integer getId()
```
    Deprecated.
  - setId
```
public Resource setId(Integer id)
```
    Deprecated.
    
    Internal use only
  - getPath
```
public String getPath()
```
    Deprecated.
  - setPath
```
public Resource setPath(@Nullable
                        String path)
```
    Deprecated.
  - normalize
```
@CheckForNull
protected static String normalize(@Nullable
                                                String path)
```
    Deprecated.
  - getEffectiveKey
```
public String getEffectiveKey()
```
    Deprecated.
  - setEffectiveKey
```
public final Resource setEffectiveKey(String effectiveKey)
```
    Deprecated.
    
    Internal use only
  - isExcluded
```
@Deprecated
public final boolean isExcluded()
```
    Deprecated. since 2.6.
  - setExcluded
```
@Deprecated
public final Resource setExcluded(boolean b)
```
    Deprecated. since 2.6 should use SensorContext#isExcluded(resource). It will make inheritance of Resource easier.
    
    Internal use only
  - equals
```
public boolean equals(Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object

Class Resource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCOPE_SET

SCOPE_SPACE

SCOPE_ENTITY

QUALIFIER_VIEW

QUALIFIER_SUBVIEW

QUALIFIER_LIB

QUALIFIER_PROJECT

QUALIFIER_MODULE

QUALIFIER_DIRECTORY

QUALIFIER_FILE

Constructor Detail

Resource

Method Detail

getKey

setKey

getUuid

setUuid

getName

getLongName

getDescription

getLanguage

language

getScope

getQualifier

getParent

matchFilePattern

getId

setId

getPath

setPath

normalize

getEffectiveKey

setEffectiveKey

isExcluded

setExcluded

equals

hashCode