aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-check-api/src/main/java/org/sonar/check/AnnotationIntrospector.java
blob: d368a616240a056a145ec3ba4c21189f7aad7e79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2009 SonarSource SA
 * 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.check;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

/**
 * @since 2.1 (experimental)
 * @deprecated since 2.3
 */
@Deprecated
public final class AnnotationIntrospector {

  private AnnotationIntrospector() {
    // only static methods
  }

  public static String getCheckKey(Class annotatedClass) {
    Check checkAnnotation = getCheckAnnotation(annotatedClass);
    if (checkAnnotation == null) {
      return null;
    }

    String key = checkAnnotation.key();
    if (key == null || "".equals(key.trim())) {
      key = annotatedClass.getCanonicalName();
    }
    return key;
  }

  public static Check getCheckAnnotation(Class annotatedClass) {
    return (Check) annotatedClass.getAnnotation(Check.class);
  }

  public static List<Field> getPropertyFields(Class annotatedClass) {
    List<Field> fields = new ArrayList<Field>();
    for (Field field : annotatedClass.getDeclaredFields()) {
      org.sonar.check.CheckProperty propertyAnnotation = field.getAnnotation(org.sonar.check.CheckProperty.class);
      if (propertyAnnotation != null) {
        fields.add(field);
      }
    }
    return fields;
  }

  public static String getPropertyFieldKey(Field field) {
    String key = null;
    org.sonar.check.CheckProperty propertyAnnotation = field.getAnnotation(org.sonar.check.CheckProperty.class);
    if (propertyAnnotation != null) {
      key = propertyAnnotation.key();
      if (key == null || "".equals(key)) {
        key = field.getName();
      }
    }
    return key;
  }
}