From c23be817143593e187d4972fc82666c46249d4c2 Mon Sep 17 00:00:00 2001
From: Jean-Baptiste Vilain <jean-baptiste.vilain@sonarsource.com>
Date: Thu, 11 Apr 2013 18:03:07 +0200
Subject: [PATCH] SONAR-3893 Integrated last feedback on Highlightable API

---
 .../sonar/batch/scan/source/DefaultHighlightable.java  | 10 +++++-----
 .../batch/scan/source/DefaultHighlightableTest.java    | 10 +++++-----
 .../java/org/sonar/api/scan/source/Highlightable.java  |  8 ++++----
 3 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/sonar-batch/src/main/java/org/sonar/batch/scan/source/DefaultHighlightable.java b/sonar-batch/src/main/java/org/sonar/batch/scan/source/DefaultHighlightable.java
index 3327bdea837..75f10268870 100644
--- a/sonar-batch/src/main/java/org/sonar/batch/scan/source/DefaultHighlightable.java
+++ b/sonar-batch/src/main/java/org/sonar/batch/scan/source/DefaultHighlightable.java
@@ -38,8 +38,8 @@ public class DefaultHighlightable implements Highlightable {
   }
 
   @Override
-  public SyntaxHighlighter createHighlighter() {
-    return new DefaultSyntaxHighlighter();
+  public HighlightingBuilder newHighlighting() {
+    return new DefaultHighlightingBuilder();
   }
 
   @Override
@@ -56,16 +56,16 @@ public class DefaultHighlightable implements Highlightable {
     return highlightingRulesBuilder.build();
   }
 
-  private class DefaultSyntaxHighlighter implements SyntaxHighlighter {
+  private class DefaultHighlightingBuilder implements HighlightingBuilder {
 
     @Override
-    public SyntaxHighlighter highlightText(int startOffset, int endOffset, String typeOfText) {
+    public HighlightingBuilder highlight(int startOffset, int endOffset, String typeOfText) {
       highlightingRulesBuilder.registerHighlightingRule(startOffset, endOffset, typeOfText);
       return this;
     }
 
     @Override
-    public void applyHighlighting() {
+    public void done() {
       String serializedHighlightingRules = highlightingRulesBuilder.build().serializeAsString();
       syntaxHighlightingCache.registerSourceHighlighting(component().key(), serializedHighlightingRules);
     }
diff --git a/sonar-batch/src/test/java/org/sonar/batch/scan/source/DefaultHighlightableTest.java b/sonar-batch/src/test/java/org/sonar/batch/scan/source/DefaultHighlightableTest.java
index c3c18da4962..476252b703d 100644
--- a/sonar-batch/src/test/java/org/sonar/batch/scan/source/DefaultHighlightableTest.java
+++ b/sonar-batch/src/test/java/org/sonar/batch/scan/source/DefaultHighlightableTest.java
@@ -48,7 +48,7 @@ public class DefaultHighlightableTest {
   public void should_store_highlighting_rules() throws Exception {
 
     DefaultHighlightable highlightablePerspective = new DefaultHighlightable(null, null);
-    highlightablePerspective.createHighlighter().highlightText(0, 10, "k").highlightText(20, 30, "cppd");
+    highlightablePerspective.newHighlighting().highlight(0, 10, "k").highlight(20, 30, "cppd");
 
     assertThat(highlightablePerspective.getHighlightingRules().getSyntaxHighlightingRuleSet()).hasSize(2);
   }
@@ -62,10 +62,10 @@ public class DefaultHighlightableTest {
     SyntaxHighlightingCache highlightingCache = mock(SyntaxHighlightingCache.class);
 
     DefaultHighlightable highlightablePerspective = new DefaultHighlightable(component, highlightingCache);
-    highlightablePerspective.createHighlighter()
-            .highlightText(0, 10, "k")
-            .highlightText(20, 30, "cppd")
-            .applyHighlighting();
+    highlightablePerspective.newHighlighting()
+            .highlight(0, 10, "k")
+            .highlight(20, 30, "cppd")
+            .done();
 
     verify(highlightingCache).registerSourceHighlighting("myComponent", "0,10,k;20,30,cppd;");
   }
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/Highlightable.java b/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/Highlightable.java
index bcf64e54cd0..ea0c60dba8e 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/Highlightable.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/Highlightable.java
@@ -26,14 +26,14 @@ import org.sonar.api.component.Perspective;
  */
 public interface Highlightable extends Perspective {
 
-  interface SyntaxHighlighter {
+  interface HighlightingBuilder {
 
-    SyntaxHighlighter highlightText(int startOffset, int endOffset, String typeOfText);
+    HighlightingBuilder highlight(int startOffset, int endOffset, String typeOfText);
 
-    void applyHighlighting();
+    void done();
   }
 
-  SyntaxHighlighter createHighlighter();
+  HighlightingBuilder newHighlighting();
 
   /*
   * @deprecated in favor of the provided builder-based api
-- 
2.39.5