Class ProfileExporter


  • @ServerSide
    @ExtensionPoint
    public abstract class ProfileExporter
    extends java.lang.Object
    Export quality profile rules to a file
    Since:
    2.3
    • Constructor Detail

      • ProfileExporter

        protected ProfileExporter​(java.lang.String key,
                                  java.lang.String name)
    • 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()
      • getName

        public final java.lang.String getName()
      • 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:
        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