001 /*
002 * Copyright 2010-2015 JetBrains s.r.o.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017 package org.jetbrains.kotlin.load.java;
018
019 import kotlin.SetsKt;
020 import org.jetbrains.annotations.NotNull;
021 import org.jetbrains.kotlin.name.ClassId;
022 import org.jetbrains.kotlin.name.FqName;
023 import org.jetbrains.kotlin.name.Name;
024 import org.jetbrains.kotlin.resolve.jvm.JvmClassName;
025
026 import java.util.Arrays;
027 import java.util.HashSet;
028 import java.util.Set;
029
030 public final class JvmAnnotationNames {
031 public static final FqName KOTLIN_CLASS = new FqName("kotlin.jvm.internal.KotlinClass");
032 public static final FqName KOTLIN_FILE_FACADE = new FqName("kotlin.jvm.internal.KotlinFileFacade");
033 public static final FqName KOTLIN_MULTIFILE_CLASS = new FqName("kotlin.jvm.internal.KotlinMultifileClass");
034 public static final FqName KOTLIN_MULTIFILE_CLASS_PART = new FqName("kotlin.jvm.internal.KotlinMultifileClassPart");
035 public static final FqName KOTLIN_SYNTHETIC_CLASS = new FqName("kotlin.jvm.internal.KotlinSyntheticClass");
036 public static final FqName KOTLIN_FUNCTION = new FqName("kotlin.jvm.internal.KotlinFunction");
037 public static final FqName KOTLIN_INTERFACE_DEFAULT_IMPLS = new FqName("kotlin.jvm.internal.KotlinInterfaceDefaultImpls");
038 public static final FqName KOTLIN_LOCAL_CLASS = new FqName("kotlin.jvm.internal.KotlinLocalClass");
039
040 public static final FqName KOTLIN_DELEGATED_METHOD = new FqName("kotlin.jvm.internal.KotlinDelegatedMethod");
041 public static final String IMPLEMENTATION_CLASS_NAME_FIELD_NAME = "implementationClassName";
042
043 public static final String VERSION_FIELD_NAME = "version";
044 public static final String FILE_PART_CLASS_NAMES_FIELD_NAME = "filePartClassNames";
045 public static final String MULTIFILE_CLASS_NAME_FIELD_NAME = "multifileClassName";
046 public static final String DATA_FIELD_NAME = "data";
047 public static final String STRINGS_FIELD_NAME = "strings";
048 public static final String MODULE_NAME_FIELD_NAME = "moduleName";
049 public static final Name DEFAULT_ANNOTATION_MEMBER_NAME = Name.identifier("value");
050 public static final Name DEPRECATED_ANNOTATION_MESSAGE = Name.identifier("message");
051 public static final Name TARGET_ANNOTATION_MEMBER_NAME = Name.identifier("allowedTargets");
052
053 public static final FqName TARGET_ANNOTATION = new FqName("java.lang.annotation.Target");
054 public static final FqName RETENTION_ANNOTATION = new FqName("java.lang.annotation.Retention");
055 public static final FqName DOCUMENTED_ANNOTATION = new FqName("java.lang.annotation.Documented");
056
057 public static final FqName JETBRAINS_NOT_NULL_ANNOTATION = new FqName("org.jetbrains.annotations.NotNull");
058 public static final FqName JETBRAINS_NULLABLE_ANNOTATION = new FqName("org.jetbrains.annotations.Nullable");
059 public static final FqName JETBRAINS_MUTABLE_ANNOTATION = new FqName("org.jetbrains.annotations.Mutable");
060 public static final FqName JETBRAINS_READONLY_ANNOTATION = new FqName("org.jetbrains.annotations.ReadOnly");
061
062 public static final FqName PURELY_IMPLEMENTS_ANNOTATION = new FqName("kotlin.jvm.PurelyImplements");
063
064 // Just for internal use: there is no such real classes in bytecode
065 public static final FqName ENHANCED_NULLABILITY_ANNOTATION = new FqName("kotlin.jvm.internal.EnhancedNullability");
066 public static final FqName ENHANCED_MUTABILITY_ANNOTATION = new FqName("kotlin.jvm.internal.EnhancedMutability");
067
068 public static final String OLD_ABI_VERSION_FIELD_NAME = "abiVersion";
069
070 // When these annotations appear on a declaration, they are copied to the _type_ of the declaration, becoming type annotations
071 // See also DescriptorRendererOptions#excludedTypeAnnotationClasses
072 public static final Set<FqName> ANNOTATIONS_COPIED_TO_TYPES = SetsKt.setOf(
073 JETBRAINS_READONLY_ANNOTATION,
074 JETBRAINS_MUTABLE_ANNOTATION,
075 JETBRAINS_NOT_NULL_ANNOTATION,
076 JETBRAINS_NULLABLE_ANNOTATION
077 );
078
079 private static final Set<JvmClassName> SPECIAL_ANNOTATIONS = new HashSet<JvmClassName>();
080 private static final Set<JvmClassName> NULLABILITY_ANNOTATIONS = new HashSet<JvmClassName>();
081 private static final Set<JvmClassName> SPECIAL_META_ANNOTATIONS = new HashSet<JvmClassName>();
082 static {
083 for (FqName fqName : Arrays.asList(KOTLIN_CLASS, KOTLIN_SYNTHETIC_CLASS, KOTLIN_INTERFACE_DEFAULT_IMPLS, KOTLIN_LOCAL_CLASS)) {
084 SPECIAL_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
085 }
086
087 for (FqName fqName : Arrays.asList(JETBRAINS_NOT_NULL_ANNOTATION, JETBRAINS_NULLABLE_ANNOTATION)) {
088 NULLABILITY_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
089 }
090
091 for (FqName fqName : Arrays.asList(TARGET_ANNOTATION, RETENTION_ANNOTATION, DOCUMENTED_ANNOTATION)) {
092 SPECIAL_META_ANNOTATIONS.add(JvmClassName.byFqNameWithoutInnerClasses(fqName));
093 }
094 }
095
096 public static boolean isSpecialAnnotation(@NotNull ClassId classId, boolean javaSpecificAnnotationsAreSpecial) {
097 JvmClassName className = JvmClassName.byClassId(classId);
098 return (javaSpecificAnnotationsAreSpecial
099 && (NULLABILITY_ANNOTATIONS.contains(className) || SPECIAL_META_ANNOTATIONS.contains(className))
100 ) || SPECIAL_ANNOTATIONS.contains(className);
101 }
102
103 private JvmAnnotationNames() {
104 }
105 }