org.sonar.api.resources
Class Library

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

public class Library
extends Resource

Field Summary

Fields inherited from class org.sonar.api.resources.Resource

QUALIFIER_CLASS, QUALIFIER_DIRECTORY, QUALIFIER_FIELD, QUALIFIER_FILE, QUALIFIER_LIB, QUALIFIER_METHOD, QUALIFIER_MODULE, QUALIFIER_PACKAGE, QUALIFIER_PROJECT, QUALIFIER_PROJECT_BRANCH, QUALIFIER_PROJECT_TRUNK, QUALIFIER_SUBVIEW, QUALIFIER_UNIT_TEST_CLASS, QUALIFIER_VIEW, SCOPE_DIRECTORY, SCOPE_ENTITY, SCOPE_FILE, SCOPE_LIBRARY, SCOPE_PROJECT, SCOPE_SET, SCOPE_SPACE

Constructor Summary

Library(String key, String version)

Method Summary

boolean	equals(Object o)
String	getDescription()
Language	getLanguage()
String	getLongName()
String	getName()
Resource	getParent() The parent is used to build the resources tree, for example for relations between classes, packages and projects.
String	getQualifier()
String	getScope()
String	getVersion()
int	hashCode()
boolean	matchFilePattern(String antPattern) Check resource against an Ant pattern, like mypackag?/*Foo.java.
Library	setDescription(String description)
Library	setName(String name)
Library	setQualifier(String qualifier)

Methods inherited from class org.sonar.api.resources.Resource

getEffectiveKey, getId, getKey, isExcluded, setEffectiveKey, setExcluded, setId, setKey

Methods inherited from class java.lang.Object

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

Constructor Detail

Library

public Library(String key,
               String version)

Method Detail

getVersion

public String getVersion()

setName

public Library setName(String name)

setDescription

public Library setDescription(String description)

getName

public String getName()

Specified by:

getName in class Resource

Returns:

the resource name

getLongName

public String getLongName()

Specified by:

getLongName in class Resource

Returns:

the resource long name

getDescription

public String getDescription()

Specified by:

getDescription in class Resource

Returns:

the resource description

getLanguage

public Language getLanguage()

Specified by:

getLanguage in class Resource

Returns:

the language

getScope

public String getScope()

Specified by:

getScope in class Resource

Returns:

the scope

getQualifier

public String getQualifier()

Specified by:

getQualifier in class Resource

Returns:

the qualifier

setQualifier

public Library setQualifier(String qualifier)

getParent

public Resource getParent()

Description copied from class: Resource

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.

Specified by:

getParent in class Resource

matchFilePattern

public boolean matchFilePattern(String antPattern)

Description copied from class: Resource

Check resource against an Ant pattern, like mypackag?/*Foo.java. It's used for example to match resource exclusions.

Specified by:

matchFilePattern in class Resource

Parameters:

antPattern - Ant-like pattern (with **, * and ?). It includes file suffixes.

Returns:

true if the resource matches the Ant pattern

equals

public boolean equals(Object o)

Overrides:

equals in class Resource

hashCode

public int hashCode()

Overrides:

hashCode in class Resource