SONAR-3893 First symbol API version

2 files changed, 84 insertions, 0 deletions

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/Symbol.java b/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/Symbol.java
new file mode 100644
index 00000000000..a5d7c17a9d8
--- /dev/null
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/Symbol.java
@@ -0,0 +1,30 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2012 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+
+package org.sonar.api.scan.source;
+
+public interface Symbol {
+
+  public int getDeclarationStartOffset();
+
+  public int getDeclarationEndOffset();
+
+  public String getFullyQualifiedName();
+}
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/SymbolPerspective.java b/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/SymbolPerspective.java
new file mode 100644
index 00000000000..7c1248d4f18
--- /dev/null
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/scan/source/SymbolPerspective.java
@@ -0,0 +1,54 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2012 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+
+package org.sonar.api.scan.source;
+
+import org.sonar.api.component.Perspective;
+
+/**
+ * @since 3.6
+ */
+public interface SymbolPerspective extends Perspective {
+
+  interface SymbolBuilder {
+
+    SymbolBuilder setDeclaration(int startOffset, int endOffset);
+
+    SymbolBuilder setFullyQualifiedName(String fullyQualifiedName);
+
+    Symbol build();
+  }
+
+  interface ReferencesBuilder {
+
+    ReferencesBuilder addReference(int startOffset);
+  }
+
+  SymbolPerspective begin();
+
+  SymbolBuilder newSymbol();
+
+  ReferencesBuilder declareReferences(Symbol symbol);
+
+  void end();
+}
+
+
+