ProfileImporter (sonar-plugin-api 8.9)

java.lang.Object
- org.sonar.api.profiles.ProfileImporter

@ServerSide
@ExtensionPoint
public abstract class ProfileImporter
extends java.lang.Object

Create a quality profile from an external rules file.

Since:: 2.3

Constructor Summary

Constructors
Modifier Constructor Description

protected ProfileImporter(java.lang.String key, java.lang.String name)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getKey()`
`java.lang.String`	`getName()`
`java.lang.String[]`	`getSupportedLanguages()`
`int`	`hashCode()`
`abstract RulesProfile`	`importProfile(java.io.Reader reader, ValidationMessages messages)`	Import the profile from a reader.
`ProfileImporter`	`setKey(java.lang.String s)`
`ProfileImporter`	`setName(java.lang.String s)`
`protected ProfileImporter`	`setSupportedLanguages(java.lang.String... languages)`	Set the list of languages supported An empty value means that it will be available for every languages.
`java.lang.String`	`toString()`

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

Constructor Detail

ProfileImporter

protected ProfileImporter(java.lang.String key,
                          java.lang.String name)

Method Detail
- importProfile
```
public abstract RulesProfile importProfile(java.io.Reader reader,
                                           ValidationMessages messages)
```
  Import the profile from a reader. ValidationMessages.warnings can be used to return some warnings to the user, for instance when some rules doesn't exist. ValidationMessages.errors can be used when an unrecoverable error is generating during import. No quality profile will be created.
- getKey
```
public java.lang.String getKey()
```
- setKey
```
public final ProfileImporter setKey(java.lang.String s)
```
- getName
```
public final java.lang.String getName()
```
- setName
```
public final ProfileImporter setName(java.lang.String s)
```
- setSupportedLanguages
```
protected final ProfileImporter setSupportedLanguages(java.lang.String... languages)
```
  Set the list of languages supported An empty value means that it will be available for every languages.
- getSupportedLanguages
```
public java.lang.String[] getSupportedLanguages()
```
  Returns:
  
  if empty, then any languages are supported.
- equals
```
public final boolean equals(java.lang.Object o)
```
  Overrides:
  
  equals in class java.lang.Object
- hashCode
```
public final int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object