org.sonar.api.resources

Class ResourceType

java.lang.Object

org.sonar.api.resources.ResourceType

@Beta
@Immutable
public final class ResourceType
extends Object

Experimental extension to declare types of resources.

Since 3.0, ResourceType object can declare properties that give information about the capabilities of the resource type. Those properties may be used, of instance, to adapt the Web UI according to the type of the resource being displayed.
Currently, the following properties can be defined:

• "deletable": if set to "true", then this resource can be deleted/purged.
• "supportsMeasureFilters": if set to "true", then this resource can be displayed in measure filters
• "modifiable_history": if set to "true", then the history of this resource may be modified (deletion of snapshots, modification of events, ...)
• "updatable_key" (since 3.2): if set to "true", then it is possible to update the key of this resource
• "supportsGlobalDashboards" (since 3.2): if true, this resource can be displayed in global dashboards
• "hasRolePolicy" : if true, roles configuration is available in sidebar
• "comparable" (since 3.4) : if true, the resource can be compared to other resources

Since:

2.14

See Also:

in Sonar Core Plugin to see the default resource types

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceType.Builder Builder used to create ResourceType objects.

Method Summary

Methods

Modifier and Type	Method and Description
static ResourceType.Builder	builder(String qualifier) Creates a new ResourceType.Builder
boolean	equals(Object o)
boolean	getBooleanProperty(String key) Returns the value of the property for this resource type.
String	getIconPath() Returns the relative path of the icon used to represent the resource type
String	getQualifier() Qualifier is the unique key.
String	getStringProperty(String key) Returns the value of the property for this resource type.
int	hashCode()
boolean	hasProperty(String key)
boolean	hasSourceCode() Tells whether resources of this type has source code or not.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ResourceType.Builder builder(String qualifier)

Creates a new ResourceType.Builder

Parameters:

qualifier -

getQualifier

public String getQualifier()

Qualifier is the unique key.

Returns:

the qualifier

getIconPath

public String getIconPath()

Returns the relative path of the icon used to represent the resource type

Returns:

the relative path.

hasSourceCode

public boolean hasSourceCode()

Tells whether resources of this type has source code or not.

Returns:

true if the type has source code

hasProperty

public boolean hasProperty(String key)

getStringProperty

public String getStringProperty(String key)

Returns the value of the property for this resource type.

Returns:

the String value of the property, or NULL if the property hasn't been set.

Since:

3.0

getBooleanProperty

public boolean getBooleanProperty(String key)

Returns the value of the property for this resource type.

Returns:

the Boolean value of the property. If the property hasn't been set, False is returned.

Since:

3.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object