Package org.sonar.api.profiles
Class ProfileExporter
- java.lang.Object
-
- org.sonar.api.profiles.ProfileExporter
-
@ServerSide @ExtensionPoint public abstract class ProfileExporter extends java.lang.Object
Export quality profile rules to a file- Since:
- 2.3
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedProfileExporter(java.lang.String key, java.lang.String name)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object o)abstract voidexportProfile(RulesProfile profile, java.io.Writer writer)Export activated rule from a quality profile to a writer Note that the quality profile can contain some rules from other plugins.java.lang.StringgetKey()java.lang.StringgetMimeType()java.lang.StringgetName()java.lang.String[]getSupportedLanguages()inthashCode()ProfileExportersetKey(java.lang.String s)ProfileExportersetMimeType(java.lang.String s)Set the mime type of the exported fileProfileExportersetName(java.lang.String s)protected ProfileExportersetSupportedLanguages(java.lang.String... languages)Set the list of languages supported An empty value means that it will be available for every languages.java.lang.StringtoString()
-
-
-
Method Detail
-
exportProfile
public abstract void exportProfile(RulesProfile profile, java.io.Writer writer)
Export activated rule from a quality profile to a writer Note that the quality profile can contain some rules from other plugins. It should not fail in this case.
-
getKey
public java.lang.String getKey()
-
setKey
public final ProfileExporter setKey(java.lang.String s)
-
getName
public final java.lang.String getName()
-
setName
public final ProfileExporter setName(java.lang.String s)
-
setSupportedLanguages
protected final ProfileExporter setSupportedLanguages(java.lang.String... languages)
Set the list of languages supported An empty value means that it will be available for every languages.
-
getMimeType
public java.lang.String getMimeType()
-
setMimeType
public final ProfileExporter setMimeType(java.lang.String s)
Set the mime type of the exported file
-
getSupportedLanguages
public java.lang.String[] getSupportedLanguages()
- Returns:
- if empty, then any languages are supported.
-
equals
public final boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-