org.sonar.xoo.rule.XooFakeImporterWithMessages Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-xoo-plugin Show documentation

Sample of plugin to document and test available APIs

There is a newer version: 5.1

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.xoo.rule;

import org.sonar.api.profiles.ProfileImporter;
import org.sonar.api.profiles.RulesProfile;
import org.sonar.api.utils.ValidationMessages;

import java.io.Reader;

/**
 * Fake importer just for test, it will NOT take into account the given file but will display some info and warning messages
 */
public class XooFakeImporterWithMessages extends ProfileImporter {
  public XooFakeImporterWithMessages() {
    super("XooFakeImporterWithMessages", "Xoo Profile Importer With Messages");
  }

  @Override
  public String[] getSupportedLanguages() {
    return new String[] {};
  }

  @Override
  public RulesProfile importProfile(Reader reader, ValidationMessages messages) {
    messages.addWarningText("a warning");
    messages.addInfoText("an info");
    return RulesProfile.create();
  }
}