150 Options options = Options.instance(context);
151 lint = Lint.instance(context);
152 fileManager = context.get(JavaFileManager.class);
153
154 source = Source.instance(context);
155 target = Target.instance(context);
156 warnOnAnyAccessToMembers = options.isSet("warnOnAccessToMembers");
157
158 disablePreviewCheck = false;
159
160 Target target = Target.instance(context);
161 syntheticNameChar = target.syntheticNameChar();
162
163 profile = Profile.instance(context);
164 preview = Preview.instance(context);
165
166 allowModules = Feature.MODULES.allowedInSource(source);
167 allowRecords = Feature.RECORDS.allowedInSource(source);
168 allowSealed = Feature.SEALED_CLASSES.allowedInSource(source);
169 allowPrimitivePatterns = preview.isEnabled() && Feature.PRIMITIVE_PATTERNS.allowedInSource(source);
170 }
171
172 /** Character for synthetic names
173 */
174 char syntheticNameChar;
175
176 /** A table mapping flat names of all compiled classes for each module in this run
177 * to their symbols; maintained from outside.
178 */
179 private Map<Pair<ModuleSymbol, Name>,ClassSymbol> compiled = new HashMap<>();
180
181 /** Are modules allowed
182 */
183 private final boolean allowModules;
184
185 /** Are records allowed
186 */
187 private final boolean allowRecords;
188
189 /** Are sealed classes allowed
190 */
191 private final boolean allowSealed;
192
193 /** Are primitive patterns allowed
194 */
195 private final boolean allowPrimitivePatterns;
196
197 /** Whether to force suppression of deprecation and preview warnings.
198 * This happens when attributing import statements for JDK 9+.
199 * @see Feature#DEPRECATION_ON_IMPORT
200 */
201 private boolean importSuppression;
202
203 /* *************************************************************************
204 * Errors and Warnings
205 **************************************************************************/
206
207 Lint setLint(Lint newLint) {
208 Lint prev = lint;
209 lint = newLint;
210 return prev;
211 }
212
213 boolean setImportSuppression(boolean newImportSuppression) {
214 boolean prev = importSuppression;
215 importSuppression = newImportSuppression;
216 return prev;
654 /** Check that type is a class or interface type.
655 * @param pos Position to be used for error reporting.
656 * @param t The type to be checked.
657 */
658 Type checkClassType(DiagnosticPosition pos, Type t) {
659 if (!t.hasTag(CLASS) && !t.hasTag(ERROR)) {
660 return typeTagError(pos,
661 diags.fragment(Fragments.TypeReqClass),
662 asTypeParam(t));
663 } else {
664 return t;
665 }
666 }
667 //where
668 private Object asTypeParam(Type t) {
669 return (t.hasTag(TYPEVAR))
670 ? diags.fragment(Fragments.TypeParameter(t))
671 : t;
672 }
673
674 /** Check that type is a valid qualifier for a constructor reference expression
675 */
676 Type checkConstructorRefType(DiagnosticPosition pos, Type t) {
677 t = checkClassOrArrayType(pos, t);
678 if (t.hasTag(CLASS)) {
679 if ((t.tsym.flags() & (ABSTRACT | INTERFACE)) != 0) {
680 log.error(pos, Errors.AbstractCantBeInstantiated(t.tsym));
681 t = types.createErrorType(t);
682 } else if ((t.tsym.flags() & ENUM) != 0) {
683 log.error(pos, Errors.EnumCantBeInstantiated);
684 t = types.createErrorType(t);
685 } else {
686 t = checkClassType(pos, t, true);
687 }
688 } else if (t.hasTag(ARRAY)) {
689 if (!types.isReifiable(((ArrayType)t).elemtype)) {
690 log.error(pos, Errors.GenericArrayCreation);
691 t = types.createErrorType(t);
692 }
693 }
711 args = args.tail;
712 }
713 }
714 return t;
715 }
716
717 /** Check that type is a reference type, i.e. a class, interface or array type
718 * or a type variable.
719 * @param pos Position to be used for error reporting.
720 * @param t The type to be checked.
721 */
722 Type checkRefType(DiagnosticPosition pos, Type t) {
723 if (t.isReference())
724 return t;
725 else
726 return typeTagError(pos,
727 diags.fragment(Fragments.TypeReqRef),
728 t);
729 }
730
731 /** Check that each type is a reference type, i.e. a class, interface or array type
732 * or a type variable.
733 * @param trees Original trees, used for error reporting.
734 * @param types The types to be checked.
735 */
736 List<Type> checkRefTypes(List<JCExpression> trees, List<Type> types) {
737 List<JCExpression> tl = trees;
738 for (List<Type> l = types; l.nonEmpty(); l = l.tail) {
739 l.head = checkRefType(tl.head.pos(), l.head);
740 tl = tl.tail;
741 }
742 return types;
743 }
744
745 /** Check that type is a null or reference type.
746 * @param pos Position to be used for error reporting.
747 * @param t The type to be checked.
748 */
749 Type checkNullOrRefType(DiagnosticPosition pos, Type t) {
750 if (t.isReference() || t.hasTag(BOT))
1102 * Warning: we can't use flags() here since this method
1103 * is called during class enter, when flags() would cause a premature
1104 * completion.
1105 * @param flags The set of modifiers given in a definition.
1106 * @param sym The defined symbol.
1107 * @param tree The declaration
1108 */
1109 long checkFlags(long flags, Symbol sym, JCTree tree) {
1110 final DiagnosticPosition pos = tree.pos();
1111 long mask;
1112 long implicit = 0;
1113
1114 switch (sym.kind) {
1115 case VAR:
1116 if (TreeInfo.isReceiverParam(tree))
1117 mask = ReceiverParamFlags;
1118 else if (sym.owner.kind != TYP)
1119 mask = LocalVarFlags;
1120 else if ((sym.owner.flags_field & INTERFACE) != 0)
1121 mask = implicit = InterfaceVarFlags;
1122 else
1123 mask = VarFlags;
1124 break;
1125 case MTH:
1126 if (sym.name == names.init) {
1127 if ((sym.owner.flags_field & ENUM) != 0) {
1128 // enum constructors cannot be declared public or
1129 // protected and must be implicitly or explicitly
1130 // private
1131 implicit = PRIVATE;
1132 mask = PRIVATE;
1133 } else
1134 mask = ConstructorFlags;
1135 } else if ((sym.owner.flags_field & INTERFACE) != 0) {
1136 if ((sym.owner.flags_field & ANNOTATION) != 0) {
1137 mask = AnnotationTypeElementMask;
1138 implicit = PUBLIC | ABSTRACT;
1139 } else if ((flags & (DEFAULT | STATIC | PRIVATE)) != 0) {
1140 mask = InterfaceMethodMask;
1141 implicit = (flags & PRIVATE) != 0 ? 0 : PUBLIC;
1142 if ((flags & DEFAULT) != 0) {
1143 implicit |= ABSTRACT;
1144 }
1145 } else {
1146 mask = implicit = InterfaceMethodFlags;
1147 }
1148 } else if ((sym.owner.flags_field & RECORD) != 0) {
1149 mask = RecordMethodFlags;
1150 } else {
1151 mask = MethodFlags;
1152 }
1153 if ((flags & STRICTFP) != 0) {
1154 log.warning(tree.pos(), LintWarnings.Strictfp);
1155 }
1156 // Imply STRICTFP if owner has STRICTFP set.
1157 if (((flags|implicit) & Flags.ABSTRACT) == 0 ||
1158 ((flags) & Flags.DEFAULT) != 0)
1159 implicit |= sym.owner.flags_field & STRICTFP;
1160 break;
1161 case TYP:
1162 if (sym.owner.kind.matches(KindSelector.VAL_MTH) ||
1163 (sym.isDirectlyOrIndirectlyLocal() && (flags & ANNOTATION) != 0)) {
1164 boolean implicitlyStatic = !sym.isAnonymous() &&
1165 ((flags & RECORD) != 0 || (flags & ENUM) != 0 || (flags & INTERFACE) != 0);
1166 boolean staticOrImplicitlyStatic = (flags & STATIC) != 0 || implicitlyStatic;
1167 // local statics are allowed only if records are allowed too
1168 mask = staticOrImplicitlyStatic && allowRecords && (flags & ANNOTATION) == 0 ? StaticLocalFlags : LocalClassFlags;
1169 implicit = implicitlyStatic ? STATIC : implicit;
1170 } else if (sym.owner.kind == TYP) {
1171 // statics in inner classes are allowed only if records are allowed too
1172 mask = ((flags & STATIC) != 0) && allowRecords && (flags & ANNOTATION) == 0 ? ExtendedMemberStaticClassFlags : ExtendedMemberClassFlags;
1173 if (sym.owner.owner.kind == PCK ||
1174 (sym.owner.flags_field & STATIC) != 0) {
1175 mask |= STATIC;
1176 } else if (!allowRecords && ((flags & ENUM) != 0 || (flags & RECORD) != 0)) {
1177 log.error(pos, Errors.StaticDeclarationNotAllowedInInnerClasses);
1178 }
1179 // Nested interfaces and enums are always STATIC (Spec ???)
1180 if ((flags & (INTERFACE | ENUM | RECORD)) != 0 ) implicit = STATIC;
1181 } else {
1182 mask = ExtendedClassFlags;
1183 }
1184 // Interfaces are always ABSTRACT
1185 if ((flags & INTERFACE) != 0) implicit |= ABSTRACT;
1186
1187 if ((flags & ENUM) != 0) {
1188 // enums can't be declared abstract, final, sealed or non-sealed
1189 mask &= ~(ABSTRACT | FINAL | SEALED | NON_SEALED);
1190 implicit |= implicitEnumFinalFlag(tree);
1191 }
1192 if ((flags & RECORD) != 0) {
1193 // records can't be declared abstract
1194 mask &= ~ABSTRACT;
1195 implicit |= FINAL;
1196 }
1197 if ((flags & STRICTFP) != 0) {
1198 log.warning(tree.pos(), LintWarnings.Strictfp);
1199 }
1200 // Imply STRICTFP if owner has STRICTFP set.
1201 implicit |= sym.owner.flags_field & STRICTFP;
1202 break;
1203 default:
1204 throw new AssertionError();
1205 }
1206 long illegal = flags & ExtendedStandardFlags & ~mask;
1207 if (illegal != 0) {
1208 if ((illegal & INTERFACE) != 0) {
1209 log.error(pos, ((flags & ANNOTATION) != 0) ? Errors.AnnotationDeclNotAllowedHere : Errors.IntfNotAllowedHere);
1210 mask |= INTERFACE;
1211 }
1212 else {
1213 log.error(pos,
1214 Errors.ModNotAllowedHere(asFlagSet(illegal)));
1215 }
1216 }
1217 else if ((sym.kind == TYP ||
1218 // ISSUE: Disallowing abstract&private is no longer appropriate
1219 // in the presence of inner classes. Should it be deleted here?
1220 checkDisjoint(pos, flags,
1221 ABSTRACT,
1222 PRIVATE | STATIC | DEFAULT))
1223 &&
1224 checkDisjoint(pos, flags,
1225 STATIC | PRIVATE,
1226 DEFAULT)
1227 &&
1228 checkDisjoint(pos, flags,
1229 ABSTRACT | INTERFACE,
1230 FINAL | NATIVE | SYNCHRONIZED)
1231 &&
1232 checkDisjoint(pos, flags,
1233 PUBLIC,
1234 PRIVATE | PROTECTED)
1235 &&
1236 checkDisjoint(pos, flags,
1237 PRIVATE,
1238 PUBLIC | PROTECTED)
1239 &&
1240 checkDisjoint(pos, flags,
1241 FINAL,
1242 VOLATILE)
1243 &&
1244 (sym.kind == TYP ||
1245 checkDisjoint(pos, flags,
1246 ABSTRACT | NATIVE,
1247 STRICTFP))
1248 && checkDisjoint(pos, flags,
1249 FINAL,
1250 SEALED | NON_SEALED)
1251 && checkDisjoint(pos, flags,
1252 SEALED,
1253 FINAL | NON_SEALED)
1254 && checkDisjoint(pos, flags,
1255 SEALED,
1256 ANNOTATION)) {
1257 // skip
1258 }
1259 return flags & (mask | ~ExtendedStandardFlags) | implicit;
1260 }
1261
1262 /** Determine if this enum should be implicitly final.
1263 *
1264 * If the enum has no specialized enum constants, it is final.
1265 *
1266 * If the enum does have specialized enum constants, it is
1267 * <i>not</i> final.
1268 */
1269 private long implicitEnumFinalFlag(JCTree tree) {
1270 if (!tree.hasTag(CLASSDEF)) return 0;
1271 class SpecialTreeVisitor extends JCTree.Visitor {
1272 boolean specialized;
1273 SpecialTreeVisitor() {
1274 this.specialized = false;
1275 }
1276
2033 return true;
2034 }
2035 }
2036 }
2037 return false;
2038 }
2039
2040 /** Check that a given method conforms with any method it overrides.
2041 * @param tree The tree from which positions are extracted
2042 * for errors.
2043 * @param m The overriding method.
2044 */
2045 void checkOverride(Env<AttrContext> env, JCMethodDecl tree, MethodSymbol m) {
2046 ClassSymbol origin = (ClassSymbol)m.owner;
2047 if ((origin.flags() & ENUM) != 0 && names.finalize.equals(m.name)) {
2048 if (m.overrides(syms.enumFinalFinalize, origin, types, false)) {
2049 log.error(tree.pos(), Errors.EnumNoFinalize);
2050 return;
2051 }
2052 }
2053 if (allowRecords && origin.isRecord()) {
2054 // let's find out if this is a user defined accessor in which case the @Override annotation is acceptable
2055 Optional<? extends RecordComponent> recordComponent = origin.getRecordComponents().stream()
2056 .filter(rc -> rc.accessor == tree.sym && (rc.accessor.flags_field & GENERATED_MEMBER) == 0).findFirst();
2057 if (recordComponent.isPresent()) {
2058 return;
2059 }
2060 }
2061
2062 for (Type t = origin.type; t.hasTag(CLASS);
2063 t = types.supertype(t)) {
2064 if (t != origin.type) {
2065 checkOverride(tree, t, origin, m);
2066 }
2067 for (Type t2 : types.interfaces(t)) {
2068 checkOverride(tree, t2, origin, m);
2069 }
2070 }
2071
2072 final boolean explicitOverride = m.attribute(syms.overrideType.tsym) != null;
2468 /** Check that all abstract methods implemented by a class are
2469 * mutually compatible.
2470 * @param pos Position to be used for error reporting.
2471 * @param c The class whose interfaces are checked.
2472 */
2473 void checkCompatibleSupertypes(DiagnosticPosition pos, Type c) {
2474 List<Type> supertypes = types.interfaces(c);
2475 Type supertype = types.supertype(c);
2476 if (supertype.hasTag(CLASS) &&
2477 (supertype.tsym.flags() & ABSTRACT) != 0)
2478 supertypes = supertypes.prepend(supertype);
2479 for (List<Type> l = supertypes; l.nonEmpty(); l = l.tail) {
2480 if (!l.head.getTypeArguments().isEmpty() &&
2481 !checkCompatibleAbstracts(pos, l.head, l.head, c))
2482 return;
2483 for (List<Type> m = supertypes; m != l; m = m.tail)
2484 if (!checkCompatibleAbstracts(pos, l.head, m.head, c))
2485 return;
2486 }
2487 checkCompatibleConcretes(pos, c);
2488 }
2489
2490 /** Check that all non-override equivalent methods accessible from 'site'
2491 * are mutually compatible (JLS 8.4.8/9.4.1).
2492 *
2493 * @param pos Position to be used for error reporting.
2494 * @param site The class whose methods are checked.
2495 * @param sym The method symbol to be checked.
2496 */
2497 void checkOverrideClashes(DiagnosticPosition pos, Type site, MethodSymbol sym) {
2498 ClashFilter cf = new ClashFilter(site);
2499 //for each method m1 that is overridden (directly or indirectly)
2500 //by method 'sym' in 'site'...
2501
2502 ArrayList<Symbol> symbolsByName = new ArrayList<>();
2503 types.membersClosure(site, false).getSymbolsByName(sym.name, cf).forEach(symbolsByName::add);
2504 for (Symbol m1 : symbolsByName) {
2505 if (!sym.overrides(m1, site.tsym, types, false)) {
2506 continue;
2507 }
4841 }
4842 } else {
4843 Assert.error("Unknown pattern: " + currentPattern.getTag());
4844 }
4845 return false;
4846 }
4847
4848 /** check if a type is a subtype of Externalizable, if that is available. */
4849 boolean isExternalizable(Type t) {
4850 try {
4851 syms.externalizableType.complete();
4852 } catch (CompletionFailure e) {
4853 return false;
4854 }
4855 return types.isSubtype(t, syms.externalizableType);
4856 }
4857
4858 /**
4859 * Check structure of serialization declarations.
4860 */
4861 public void checkSerialStructure(JCClassDecl tree, ClassSymbol c) {
4862 (new SerialTypeVisitor()).visit(c, tree);
4863 }
4864
4865 /**
4866 * This visitor will warn if a serialization-related field or
4867 * method is declared in a suspicious or incorrect way. In
4868 * particular, it will warn for cases where the runtime
4869 * serialization mechanism will silently ignore a mis-declared
4870 * entity.
4871 *
4872 * Distinguished serialization-related fields and methods:
4873 *
4874 * Methods:
4875 *
4876 * private void writeObject(ObjectOutputStream stream) throws IOException
4877 * ANY-ACCESS-MODIFIER Object writeReplace() throws ObjectStreamException
4878 *
4879 * private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
4880 * private void readObjectNoData() throws ObjectStreamException
4881 * ANY-ACCESS-MODIFIER Object readResolve() throws ObjectStreamException
4882 *
4883 * Fields:
4884 *
4885 * private static final long serialVersionUID
4886 * private static final ObjectStreamField[] serialPersistentFields
4887 *
4888 * Externalizable: methods defined on the interface
4889 * public void writeExternal(ObjectOutput) throws IOException
4890 * public void readExternal(ObjectInput) throws IOException
4891 */
4892 private class SerialTypeVisitor extends ElementKindVisitor14<Void, JCClassDecl> {
4893 SerialTypeVisitor() {
4894 this.lint = Check.this.lint;
4895 }
4896
4897 private static final Set<String> serialMethodNames =
4898 Set.of("writeObject", "writeReplace",
4899 "readObject", "readObjectNoData",
4900 "readResolve");
4901
4902 private static final Set<String> serialFieldNames =
4903 Set.of("serialVersionUID", "serialPersistentFields");
4904
4905 // Type of serialPersistentFields
4906 private final Type OSF_TYPE = new Type.ArrayType(syms.objectStreamFieldType, syms.arrayClass);
4907
4908 Lint lint;
4909
4910 @Override
4911 public Void defaultAction(Element e, JCClassDecl p) {
4912 throw new IllegalArgumentException(Objects.requireNonNullElse(e.toString(), ""));
4913 }
4914
4915 @Override
4916 public Void visitType(TypeElement e, JCClassDecl p) {
4917 runUnderLint(e, p, (symbol, param) -> super.visitType(symbol, param));
4918 return null;
4919 }
4920
4921 @Override
4922 public Void visitTypeAsClass(TypeElement e,
4923 JCClassDecl p) {
4924 // Anonymous classes filtered out by caller.
4925
4926 ClassSymbol c = (ClassSymbol)e;
4927
4928 checkCtorAccess(p, c);
4929
4930 // Check for missing serialVersionUID; check *not* done
4931 // for enums or records.
4932 VarSymbol svuidSym = null;
4933 for (Symbol sym : c.members().getSymbolsByName(names.serialVersionUID)) {
4934 if (sym.kind == VAR) {
4935 svuidSym = (VarSymbol)sym;
4936 break;
4937 }
4938 }
4939
4940 if (svuidSym == null) {
4941 log.warning(p.pos(), LintWarnings.MissingSVUID(c));
4942 }
4943
4944 // Check for serialPersistentFields to gate checks for
4945 // non-serializable non-transient instance fields
4946 boolean serialPersistentFieldsPresent =
4947 c.members()
4948 .getSymbolsByName(names.serialPersistentFields, sym -> sym.kind == VAR)
4949 .iterator()
4950 .hasNext();
4951
4952 // Check declarations of serialization-related methods and
4953 // fields
4954 for(Symbol el : c.getEnclosedElements()) {
4955 runUnderLint(el, p, (enclosed, tree) -> {
4956 String name = null;
4957 switch(enclosed.getKind()) {
4958 case FIELD -> {
4959 if (!serialPersistentFieldsPresent) {
4960 var flags = enclosed.flags();
4961 if ( ((flags & TRANSIENT) == 0) &&
4962 ((flags & STATIC) == 0)) {
4963 Type varType = enclosed.asType();
4964 if (!canBeSerialized(varType)) {
4965 // Note per JLS arrays are
4966 // serializable even if the
4967 // component type is not.
4968 log.warning(
4969 TreeInfo.diagnosticPositionFor(enclosed, tree),
4970 LintWarnings.NonSerializableInstanceField);
4971 } else if (varType.hasTag(ARRAY)) {
4972 ArrayType arrayType = (ArrayType)varType;
4973 Type elementType = arrayType.elemtype;
5006 // Class.getDeclaredMethod. This differs from calling
5007 // Elements.getAllMembers(TypeElement) as the latter
5008 // will also pull in default methods from
5009 // superinterfaces. In other words, the runtime checks
5010 // (which long predate default methods on interfaces)
5011 // do not admit the possibility of inheriting methods
5012 // this way, a difference from general inheritance.
5013
5014 // The current implementation just checks the enclosed
5015 // elements and does not directly check the inherited
5016 // methods. If all the types are being checked this is
5017 // less of a concern; however, there are cases that
5018 // could be missed. In particular, readResolve and
5019 // writeReplace could, in principle, by inherited from
5020 // a non-serializable superclass and thus not checked
5021 // even if compiled with a serializable child class.
5022 case METHOD -> {
5023 var method = (MethodSymbol)enclosed;
5024 name = method.getSimpleName().toString();
5025 if (serialMethodNames.contains(name)) {
5026 switch (name) {
5027 case "writeObject" -> checkWriteObject(tree, e, method);
5028 case "writeReplace" -> checkWriteReplace(tree,e, method);
5029 case "readObject" -> checkReadObject(tree,e, method);
5030 case "readObjectNoData" -> checkReadObjectNoData(tree, e, method);
5031 case "readResolve" -> checkReadResolve(tree, e, method);
5032 default -> throw new AssertionError();
5033 }
5034 }
5035 }
5036 }
5037 });
5038 }
5039
5040 return null;
5041 }
5042
5043 boolean canBeSerialized(Type type) {
5044 return type.isPrimitive() || rs.isSerializable(type);
5045 }
5046
5047 /**
5048 * Check that Externalizable class needs a public no-arg
5049 * constructor.
5050 *
5051 * Check that a Serializable class has access to the no-arg
5052 * constructor of its first nonserializable superclass.
5053 */
5054 private void checkCtorAccess(JCClassDecl tree, ClassSymbol c) {
5055 if (isExternalizable(c.type)) {
5056 for(var sym : c.getEnclosedElements()) {
5057 if (sym.isConstructor() &&
5058 ((sym.flags() & PUBLIC) == PUBLIC)) {
5059 if (((MethodSymbol)sym).getParameters().isEmpty()) {
5060 return;
5061 }
5062 }
5063 }
5064 log.warning(tree.pos(),
5065 LintWarnings.ExternalizableMissingPublicNoArgCtor);
5066 } else {
5143
5144 if (isExternalizable((Type)(e.asType()))) {
5145 log.warning(
5146 TreeInfo.diagnosticPositionFor(spf, tree),
5147 LintWarnings.IneffectualSerialFieldExternalizable);
5148 }
5149
5150 // Warn if serialPersistentFields is initialized to a
5151 // literal null.
5152 JCTree spfDecl = TreeInfo.declarationFor(spf, tree);
5153 if (spfDecl != null && spfDecl.getTag() == VARDEF) {
5154 JCVariableDecl variableDef = (JCVariableDecl) spfDecl;
5155 JCExpression initExpr = variableDef.init;
5156 if (initExpr != null && TreeInfo.isNull(initExpr)) {
5157 log.warning(initExpr.pos(),
5158 LintWarnings.SPFNullInit);
5159 }
5160 }
5161 }
5162
5163 private void checkWriteObject(JCClassDecl tree, Element e, MethodSymbol method) {
5164 // The "synchronized" modifier is seen in the wild on
5165 // readObject and writeObject methods and is generally
5166 // innocuous.
5167
5168 // private void writeObject(ObjectOutputStream stream) throws IOException
5169 checkPrivateNonStaticMethod(tree, method);
5170 checkReturnType(tree, e, method, syms.voidType);
5171 checkOneArg(tree, e, method, syms.objectOutputStreamType);
5172 checkExceptions(tree, e, method, syms.ioExceptionType);
5173 checkExternalizable(tree, e, method);
5174 }
5175
5176 private void checkWriteReplace(JCClassDecl tree, Element e, MethodSymbol method) {
5177 // ANY-ACCESS-MODIFIER Object writeReplace() throws
5178 // ObjectStreamException
5179
5180 // Excluding abstract, could have a more complicated
5181 // rule based on abstract-ness of the class
5182 checkConcreteInstanceMethod(tree, e, method);
5183 checkReturnType(tree, e, method, syms.objectType);
5184 checkNoArgs(tree, e, method);
5185 checkExceptions(tree, e, method, syms.objectStreamExceptionType);
5186 }
5187
5188 private void checkReadObject(JCClassDecl tree, Element e, MethodSymbol method) {
5189 // The "synchronized" modifier is seen in the wild on
5190 // readObject and writeObject methods and is generally
5191 // innocuous.
5192
5193 // private void readObject(ObjectInputStream stream)
5194 // throws IOException, ClassNotFoundException
5195 checkPrivateNonStaticMethod(tree, method);
5196 checkReturnType(tree, e, method, syms.voidType);
5197 checkOneArg(tree, e, method, syms.objectInputStreamType);
5198 checkExceptions(tree, e, method, syms.ioExceptionType, syms.classNotFoundExceptionType);
5199 checkExternalizable(tree, e, method);
5200 }
5201
5202 private void checkReadObjectNoData(JCClassDecl tree, Element e, MethodSymbol method) {
5203 // private void readObjectNoData() throws ObjectStreamException
5204 checkPrivateNonStaticMethod(tree, method);
5205 checkReturnType(tree, e, method, syms.voidType);
5206 checkNoArgs(tree, e, method);
5207 checkExceptions(tree, e, method, syms.objectStreamExceptionType);
5208 checkExternalizable(tree, e, method);
5209 }
5210
5211 private void checkReadResolve(JCClassDecl tree, Element e, MethodSymbol method) {
5212 // ANY-ACCESS-MODIFIER Object readResolve()
5213 // throws ObjectStreamException
5214
5215 // Excluding abstract, could have a more complicated
5216 // rule based on abstract-ness of the class
5217 checkConcreteInstanceMethod(tree, e, method);
5218 checkReturnType(tree,e, method, syms.objectType);
5219 checkNoArgs(tree, e, method);
5220 checkExceptions(tree, e, method, syms.objectStreamExceptionType);
5221 }
5222
5223 private void checkWriteExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5224 //public void writeExternal(ObjectOutput) throws IOException
5225 checkExternMethodRecord(tree, e, method, syms.objectOutputType, isExtern);
5226 }
5227
5228 private void checkReadExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5229 // public void readExternal(ObjectInput) throws IOException
5230 checkExternMethodRecord(tree, e, method, syms.objectInputType, isExtern);
5231 }
5232
5233 private void checkExternMethodRecord(JCClassDecl tree, Element e, MethodSymbol method, Type argType,
5234 boolean isExtern) {
5235 if (isExtern && isExternMethod(tree, e, method, argType)) {
5236 log.warning(
5237 TreeInfo.diagnosticPositionFor(method, tree),
5238 LintWarnings.IneffectualExternalizableMethodRecord(method.getSimpleName().toString()));
5239 }
5240 }
5241
5242 void checkPrivateNonStaticMethod(JCClassDecl tree, MethodSymbol method) {
5243 var flags = method.flags();
5244 if ((flags & PRIVATE) == 0) {
5245 log.warning(
5246 TreeInfo.diagnosticPositionFor(method, tree),
5247 LintWarnings.SerialMethodNotPrivate(method.getSimpleName()));
5248 }
5249
5250 if ((flags & STATIC) != 0) {
5251 log.warning(
5252 TreeInfo.diagnosticPositionFor(method, tree),
5253 LintWarnings.SerialMethodStatic(method.getSimpleName()));
5254 }
5255 }
5256
5257 /**
5258 * Per section 1.12 "Serialization of Enum Constants" of
5259 * the serialization specification, due to the special
5260 * serialization handling of enums, any writeObject,
5261 * readObject, writeReplace, and readResolve methods are
5262 * ignored as are serialPersistentFields and
5263 * serialVersionUID fields.
5264 */
5265 @Override
5266 public Void visitTypeAsEnum(TypeElement e,
5267 JCClassDecl p) {
5268 boolean isExtern = isExternalizable((Type)e.asType());
5269 for(Element el : e.getEnclosedElements()) {
5270 runUnderLint(el, p, (enclosed, tree) -> {
5271 String name = enclosed.getSimpleName().toString();
5272 switch(enclosed.getKind()) {
5273 case FIELD -> {
5274 var field = (VarSymbol)enclosed;
5450 case FIELD -> {
5451 var field = (VarSymbol)enclosed;
5452 switch(name) {
5453 case "serialPersistentFields" -> {
5454 log.warning(
5455 TreeInfo.diagnosticPositionFor(field, tree),
5456 LintWarnings.IneffectualSerialFieldRecord);
5457 }
5458
5459 case "serialVersionUID" -> {
5460 // Could generate additional warning that
5461 // svuid value is not checked to match for
5462 // records.
5463 checkSerialVersionUID(tree, e, field);
5464 }}
5465 }
5466
5467 case METHOD -> {
5468 var method = (MethodSymbol)enclosed;
5469 switch(name) {
5470 case "writeReplace" -> checkWriteReplace(tree, e, method);
5471 case "readResolve" -> checkReadResolve(tree, e, method);
5472
5473 case "writeExternal" -> checkWriteExternalRecord(tree, e, method, isExtern);
5474 case "readExternal" -> checkReadExternalRecord(tree, e, method, isExtern);
5475
5476 default -> {
5477 if (serialMethodNames.contains(name)) {
5478 log.warning(
5479 TreeInfo.diagnosticPositionFor(method, tree),
5480 LintWarnings.IneffectualSerialMethodRecord(name));
5481 }
5482 }}
5483 }}});
5484 }
5485 return null;
5486 }
5487
5488 void checkConcreteInstanceMethod(JCClassDecl tree,
5489 Element enclosing,
5490 MethodSymbol method) {
5491 if ((method.flags() & (STATIC | ABSTRACT)) != 0) {
5492 log.warning(
5493 TreeInfo.diagnosticPositionFor(method, tree),
5494 LintWarnings.SerialConcreteInstanceMethod(method.getSimpleName()));
5495 }
5496 }
5497
5498 private void checkReturnType(JCClassDecl tree,
5499 Element enclosing,
5500 MethodSymbol method,
5501 Type expectedReturnType) {
5502 // Note: there may be complications checking writeReplace
5503 // and readResolve since they return Object and could, in
5504 // principle, have covariant overrides and any synthetic
5505 // bridge method would not be represented here for
5506 // checking.
5507 Type rtype = method.getReturnType();
5508 if (!types.isSameType(expectedReturnType, rtype)) {
5509 log.warning(
5510 TreeInfo.diagnosticPositionFor(method, tree),
5511 LintWarnings.SerialMethodUnexpectedReturnType(method.getSimpleName(),
5512 rtype, expectedReturnType));
5513 }
5514 }
5515
5516 private void checkOneArg(JCClassDecl tree,
5517 Element enclosing,
5518 MethodSymbol method,
5519 Type expectedType) {
5520 String name = method.getSimpleName().toString();
5521
5522 var parameters= method.getParameters();
5523
5524 if (parameters.size() != 1) {
5525 log.warning(
5526 TreeInfo.diagnosticPositionFor(method, tree),
5527 LintWarnings.SerialMethodOneArg(method.getSimpleName(), parameters.size()));
5528 return;
5529 }
5530
5531 Type parameterType = parameters.get(0).asType();
5532 if (!types.isSameType(parameterType, expectedType)) {
5533 log.warning(
5534 TreeInfo.diagnosticPositionFor(method, tree),
5535 LintWarnings.SerialMethodParameterType(method.getSimpleName(),
5536 expectedType,
5537 parameterType));
5538 }
5539 }
5540
5541 private boolean hasExactlyOneArgWithType(JCClassDecl tree,
5542 Element enclosing,
5543 MethodSymbol method,
5544 Type expectedType) {
5545 var parameters = method.getParameters();
5546 return (parameters.size() == 1) &&
5547 types.isSameType(parameters.get(0).asType(), expectedType);
5548 }
5549
5550
5551 private void checkNoArgs(JCClassDecl tree, Element enclosing, MethodSymbol method) {
5552 var parameters = method.getParameters();
5553 if (!parameters.isEmpty()) {
5554 log.warning(
5555 TreeInfo.diagnosticPositionFor(parameters.get(0), tree),
5556 LintWarnings.SerialMethodNoArgs(method.getSimpleName()));
5557 }
5558 }
5559
5560 private void checkExternalizable(JCClassDecl tree, Element enclosing, MethodSymbol method) {
5561 // If the enclosing class is externalizable, warn for the method
5562 if (isExternalizable((Type)enclosing.asType())) {
5563 log.warning(
5564 TreeInfo.diagnosticPositionFor(method, tree),
5565 LintWarnings.IneffectualSerialMethodExternalizable(method.getSimpleName()));
5566 }
5567 return;
5568 }
5569
5570 private void checkExceptions(JCClassDecl tree,
5571 Element enclosing,
5572 MethodSymbol method,
5573 Type... declaredExceptions) {
5574 for (Type thrownType: method.getThrownTypes()) {
5575 // For each exception in the throws clause of the
5576 // method, if not an Error and not a RuntimeException,
5577 // check if the exception is a subtype of a declared
5578 // exception from the throws clause of the
5579 // serialization method in question.
5580 if (types.isSubtype(thrownType, syms.runtimeExceptionType) ||
5581 types.isSubtype(thrownType, syms.errorType) ) {
5582 continue;
5583 } else {
5584 boolean declared = false;
5585 for (Type declaredException : declaredExceptions) {
5586 if (types.isSubtype(thrownType, declaredException)) {
5587 declared = true;
5588 continue;
5589 }
5590 }
5591 if (!declared) {
5592 log.warning(
5593 TreeInfo.diagnosticPositionFor(method, tree),
5594 LintWarnings.SerialMethodUnexpectedException(method.getSimpleName(),
5595 thrownType));
5596 }
5597 }
5598 }
5599 return;
5600 }
5601
5602 private <E extends Element> Void runUnderLint(E symbol, JCClassDecl p, BiConsumer<E, JCClassDecl> task) {
5603 Lint prevLint = lint;
5604 try {
5605 lint = lint.augment((Symbol) symbol);
5606
5607 if (lint.isEnabled(LintCategory.SERIAL)) {
5608 task.accept(symbol, p);
5609 }
5610
5611 return null;
5612 } finally {
5613 lint = prevLint;
5614 }
5615 }
5616
5617 }
5618
5619 void checkRequiresIdentity(JCTree tree, Lint lint) {
|
150 Options options = Options.instance(context);
151 lint = Lint.instance(context);
152 fileManager = context.get(JavaFileManager.class);
153
154 source = Source.instance(context);
155 target = Target.instance(context);
156 warnOnAnyAccessToMembers = options.isSet("warnOnAccessToMembers");
157
158 disablePreviewCheck = false;
159
160 Target target = Target.instance(context);
161 syntheticNameChar = target.syntheticNameChar();
162
163 profile = Profile.instance(context);
164 preview = Preview.instance(context);
165
166 allowModules = Feature.MODULES.allowedInSource(source);
167 allowRecords = Feature.RECORDS.allowedInSource(source);
168 allowSealed = Feature.SEALED_CLASSES.allowedInSource(source);
169 allowPrimitivePatterns = preview.isEnabled() && Feature.PRIMITIVE_PATTERNS.allowedInSource(source);
170 allowValueClasses = (!preview.isPreview(Feature.VALUE_CLASSES) || preview.isEnabled()) &&
171 Feature.VALUE_CLASSES.allowedInSource(source);
172 }
173
174 /** Character for synthetic names
175 */
176 char syntheticNameChar;
177
178 /** A table mapping flat names of all compiled classes for each module in this run
179 * to their symbols; maintained from outside.
180 */
181 private Map<Pair<ModuleSymbol, Name>,ClassSymbol> compiled = new HashMap<>();
182
183 /** Are modules allowed
184 */
185 private final boolean allowModules;
186
187 /** Are records allowed
188 */
189 private final boolean allowRecords;
190
191 /** Are sealed classes allowed
192 */
193 private final boolean allowSealed;
194
195 /** Are primitive patterns allowed
196 */
197 private final boolean allowPrimitivePatterns;
198
199 /** Are value classes allowed
200 */
201 private final boolean allowValueClasses;
202
203 /** Whether to force suppression of deprecation and preview warnings.
204 * This happens when attributing import statements for JDK 9+.
205 * @see Feature#DEPRECATION_ON_IMPORT
206 */
207 private boolean importSuppression;
208
209 /* *************************************************************************
210 * Errors and Warnings
211 **************************************************************************/
212
213 Lint setLint(Lint newLint) {
214 Lint prev = lint;
215 lint = newLint;
216 return prev;
217 }
218
219 boolean setImportSuppression(boolean newImportSuppression) {
220 boolean prev = importSuppression;
221 importSuppression = newImportSuppression;
222 return prev;
660 /** Check that type is a class or interface type.
661 * @param pos Position to be used for error reporting.
662 * @param t The type to be checked.
663 */
664 Type checkClassType(DiagnosticPosition pos, Type t) {
665 if (!t.hasTag(CLASS) && !t.hasTag(ERROR)) {
666 return typeTagError(pos,
667 diags.fragment(Fragments.TypeReqClass),
668 asTypeParam(t));
669 } else {
670 return t;
671 }
672 }
673 //where
674 private Object asTypeParam(Type t) {
675 return (t.hasTag(TYPEVAR))
676 ? diags.fragment(Fragments.TypeParameter(t))
677 : t;
678 }
679
680 void checkConstraintsOfValueClass(JCClassDecl tree, ClassSymbol c) {
681 DiagnosticPosition pos = tree.pos();
682 for (Type st : types.closure(c.type)) {
683 if (st == null || st.tsym == null || st.tsym.kind == ERR)
684 continue;
685 if (st.tsym == syms.objectType.tsym || st.tsym == syms.recordType.tsym || st.isInterface())
686 continue;
687 if (!st.tsym.isAbstract()) {
688 if (c != st.tsym) {
689 log.error(pos, Errors.ConcreteSupertypeForValueClass(c, st));
690 }
691 continue;
692 }
693 // dealing with an abstract value or value super class below.
694 for (Symbol s : st.tsym.members().getSymbols(NON_RECURSIVE)) {
695 if (s.kind == MTH) {
696 if ((s.flags() & (SYNCHRONIZED | STATIC)) == SYNCHRONIZED) {
697 log.error(pos, Errors.SuperClassMethodCannotBeSynchronized(s, c, st));
698 }
699 break;
700 }
701 }
702 }
703 }
704
705 /** Check that type is a valid qualifier for a constructor reference expression
706 */
707 Type checkConstructorRefType(DiagnosticPosition pos, Type t) {
708 t = checkClassOrArrayType(pos, t);
709 if (t.hasTag(CLASS)) {
710 if ((t.tsym.flags() & (ABSTRACT | INTERFACE)) != 0) {
711 log.error(pos, Errors.AbstractCantBeInstantiated(t.tsym));
712 t = types.createErrorType(t);
713 } else if ((t.tsym.flags() & ENUM) != 0) {
714 log.error(pos, Errors.EnumCantBeInstantiated);
715 t = types.createErrorType(t);
716 } else {
717 t = checkClassType(pos, t, true);
718 }
719 } else if (t.hasTag(ARRAY)) {
720 if (!types.isReifiable(((ArrayType)t).elemtype)) {
721 log.error(pos, Errors.GenericArrayCreation);
722 t = types.createErrorType(t);
723 }
724 }
742 args = args.tail;
743 }
744 }
745 return t;
746 }
747
748 /** Check that type is a reference type, i.e. a class, interface or array type
749 * or a type variable.
750 * @param pos Position to be used for error reporting.
751 * @param t The type to be checked.
752 */
753 Type checkRefType(DiagnosticPosition pos, Type t) {
754 if (t.isReference())
755 return t;
756 else
757 return typeTagError(pos,
758 diags.fragment(Fragments.TypeReqRef),
759 t);
760 }
761
762 /** Check that type is an identity type, i.e. not a value type.
763 * When not discernible statically, give it the benefit of doubt
764 * and defer to runtime.
765 *
766 * @param pos Position to be used for error reporting.
767 * @param t The type to be checked.
768 */
769 boolean checkIdentityType(DiagnosticPosition pos, Type t) {
770 if (t.hasTag(TYPEVAR)) {
771 t = types.skipTypeVars(t, false);
772 }
773 if (t.isIntersection()) {
774 IntersectionClassType ict = (IntersectionClassType)t;
775 boolean result = true;
776 for (Type component : ict.getExplicitComponents()) {
777 result &= checkIdentityType(pos, component);
778 }
779 return result;
780 }
781 if (t.isPrimitive() || (t.isValueClass() && !t.tsym.isAbstract())) {
782 typeTagError(pos, diags.fragment(Fragments.TypeReqIdentity), t);
783 return false;
784 }
785 return true;
786 }
787
788 /** Check that each type is a reference type, i.e. a class, interface or array type
789 * or a type variable.
790 * @param trees Original trees, used for error reporting.
791 * @param types The types to be checked.
792 */
793 List<Type> checkRefTypes(List<JCExpression> trees, List<Type> types) {
794 List<JCExpression> tl = trees;
795 for (List<Type> l = types; l.nonEmpty(); l = l.tail) {
796 l.head = checkRefType(tl.head.pos(), l.head);
797 tl = tl.tail;
798 }
799 return types;
800 }
801
802 /** Check that type is a null or reference type.
803 * @param pos Position to be used for error reporting.
804 * @param t The type to be checked.
805 */
806 Type checkNullOrRefType(DiagnosticPosition pos, Type t) {
807 if (t.isReference() || t.hasTag(BOT))
1159 * Warning: we can't use flags() here since this method
1160 * is called during class enter, when flags() would cause a premature
1161 * completion.
1162 * @param flags The set of modifiers given in a definition.
1163 * @param sym The defined symbol.
1164 * @param tree The declaration
1165 */
1166 long checkFlags(long flags, Symbol sym, JCTree tree) {
1167 final DiagnosticPosition pos = tree.pos();
1168 long mask;
1169 long implicit = 0;
1170
1171 switch (sym.kind) {
1172 case VAR:
1173 if (TreeInfo.isReceiverParam(tree))
1174 mask = ReceiverParamFlags;
1175 else if (sym.owner.kind != TYP)
1176 mask = LocalVarFlags;
1177 else if ((sym.owner.flags_field & INTERFACE) != 0)
1178 mask = implicit = InterfaceVarFlags;
1179 else {
1180 boolean isInstanceField = (flags & STATIC) == 0;
1181 boolean isInstanceFieldOfValueClass = isInstanceField && sym.owner.type.isValueClass();
1182 boolean isRecordField = isInstanceField && (sym.owner.flags_field & RECORD) != 0;
1183 if (allowValueClasses && (isInstanceFieldOfValueClass || isRecordField)) {
1184 implicit |= FINAL | STRICT;
1185 mask = ValueFieldFlags;
1186 } else {
1187 mask = VarFlags;
1188 }
1189 }
1190 break;
1191 case MTH:
1192 if (sym.name == names.init) {
1193 if ((sym.owner.flags_field & ENUM) != 0) {
1194 // enum constructors cannot be declared public or
1195 // protected and must be implicitly or explicitly
1196 // private
1197 implicit = PRIVATE;
1198 mask = PRIVATE;
1199 } else
1200 mask = ConstructorFlags;
1201 } else if ((sym.owner.flags_field & INTERFACE) != 0) {
1202 if ((sym.owner.flags_field & ANNOTATION) != 0) {
1203 mask = AnnotationTypeElementMask;
1204 implicit = PUBLIC | ABSTRACT;
1205 } else if ((flags & (DEFAULT | STATIC | PRIVATE)) != 0) {
1206 mask = InterfaceMethodMask;
1207 implicit = (flags & PRIVATE) != 0 ? 0 : PUBLIC;
1208 if ((flags & DEFAULT) != 0) {
1209 implicit |= ABSTRACT;
1210 }
1211 } else {
1212 mask = implicit = InterfaceMethodFlags;
1213 }
1214 } else if ((sym.owner.flags_field & RECORD) != 0) {
1215 mask = ((sym.owner.flags_field & VALUE_CLASS) != 0 && (flags & Flags.STATIC) == 0) ?
1216 RecordMethodFlags & ~SYNCHRONIZED : RecordMethodFlags;
1217 } else {
1218 // value objects do not have an associated monitor/lock
1219 mask = ((sym.owner.flags_field & VALUE_CLASS) != 0 && (flags & Flags.STATIC) == 0) ?
1220 MethodFlags & ~SYNCHRONIZED : MethodFlags;
1221 }
1222 if ((flags & STRICTFP) != 0) {
1223 log.warning(tree.pos(), LintWarnings.Strictfp);
1224 }
1225 // Imply STRICTFP if owner has STRICTFP set.
1226 if (((flags|implicit) & Flags.ABSTRACT) == 0 ||
1227 ((flags) & Flags.DEFAULT) != 0)
1228 implicit |= sym.owner.flags_field & STRICTFP;
1229 break;
1230 case TYP:
1231 if (sym.owner.kind.matches(KindSelector.VAL_MTH) ||
1232 (sym.isDirectlyOrIndirectlyLocal() && (flags & ANNOTATION) != 0)) {
1233 boolean implicitlyStatic = !sym.isAnonymous() &&
1234 ((flags & RECORD) != 0 || (flags & ENUM) != 0 || (flags & INTERFACE) != 0);
1235 boolean staticOrImplicitlyStatic = (flags & STATIC) != 0 || implicitlyStatic;
1236 // local statics are allowed only if records are allowed too
1237 mask = staticOrImplicitlyStatic && allowRecords && (flags & ANNOTATION) == 0 ? ExtendedStaticLocalClassFlags : ExtendedLocalClassFlags;
1238 implicit = implicitlyStatic ? STATIC : implicit;
1239 } else if (sym.owner.kind == TYP) {
1240 // statics in inner classes are allowed only if records are allowed too
1241 mask = ((flags & STATIC) != 0) && allowRecords && (flags & ANNOTATION) == 0 ? ExtendedMemberStaticClassFlags : ExtendedMemberClassFlags;
1242 if (sym.owner.owner.kind == PCK ||
1243 (sym.owner.flags_field & STATIC) != 0) {
1244 mask |= STATIC;
1245 } else if (!allowRecords && ((flags & ENUM) != 0 || (flags & RECORD) != 0)) {
1246 log.error(pos, Errors.StaticDeclarationNotAllowedInInnerClasses);
1247 }
1248 // Nested interfaces and enums are always STATIC (Spec ???)
1249 if ((flags & (INTERFACE | ENUM | RECORD)) != 0 ) implicit = STATIC;
1250 } else {
1251 mask = ExtendedClassFlags;
1252 }
1253 if ((flags & (VALUE_CLASS | SEALED | ABSTRACT)) == (VALUE_CLASS | SEALED) ||
1254 (flags & (VALUE_CLASS | NON_SEALED | ABSTRACT)) == (VALUE_CLASS | NON_SEALED)) {
1255 log.error(pos, Errors.NonAbstractValueClassCantBeSealedOrNonSealed);
1256 }
1257 // Interfaces are always ABSTRACT
1258 if ((flags & INTERFACE) != 0) implicit |= ABSTRACT;
1259
1260 if ((flags & (INTERFACE | VALUE_CLASS)) == 0) {
1261 implicit |= IDENTITY_TYPE;
1262 }
1263
1264 if ((flags & ENUM) != 0) {
1265 // enums can't be declared abstract, final, sealed or non-sealed or value
1266 mask &= ~(ABSTRACT | FINAL | SEALED | NON_SEALED | VALUE_CLASS);
1267 implicit |= implicitEnumFinalFlag(tree);
1268 }
1269 if ((flags & RECORD) != 0) {
1270 // records can't be declared abstract
1271 mask &= ~ABSTRACT;
1272 implicit |= FINAL;
1273 }
1274 if ((flags & STRICTFP) != 0) {
1275 log.warning(tree.pos(), LintWarnings.Strictfp);
1276 }
1277 // Imply STRICTFP if owner has STRICTFP set.
1278 implicit |= sym.owner.flags_field & STRICTFP;
1279
1280 // concrete value classes are implicitly final
1281 if ((flags & (ABSTRACT | INTERFACE | VALUE_CLASS)) == VALUE_CLASS) {
1282 implicit |= FINAL;
1283 }
1284 break;
1285 default:
1286 throw new AssertionError();
1287 }
1288 long illegal = flags & ExtendedStandardFlags & ~mask;
1289 if (illegal != 0) {
1290 if ((illegal & INTERFACE) != 0) {
1291 log.error(pos, ((flags & ANNOTATION) != 0) ? Errors.AnnotationDeclNotAllowedHere : Errors.IntfNotAllowedHere);
1292 mask |= INTERFACE;
1293 }
1294 else {
1295 log.error(pos,
1296 Errors.ModNotAllowedHere(asFlagSet(illegal)));
1297 }
1298 } else if ((sym.kind == TYP ||
1299 // ISSUE: Disallowing abstract&private is no longer appropriate
1300 // in the presence of inner classes. Should it be deleted here?
1301 checkDisjoint(pos, flags,
1302 ABSTRACT,
1303 PRIVATE | STATIC | DEFAULT))
1304 &&
1305 checkDisjoint(pos, flags,
1306 STATIC | PRIVATE,
1307 DEFAULT)
1308 &&
1309 checkDisjoint(pos, flags,
1310 ABSTRACT | INTERFACE,
1311 FINAL | NATIVE | SYNCHRONIZED)
1312 &&
1313 checkDisjoint(pos, flags,
1314 PUBLIC,
1315 PRIVATE | PROTECTED)
1316 &&
1317 checkDisjoint(pos, flags,
1318 PRIVATE,
1319 PUBLIC | PROTECTED)
1320 &&
1321 // we are using `implicit` here as instance fields of value classes are implicitly final
1322 checkDisjoint(pos, flags | implicit,
1323 FINAL,
1324 VOLATILE)
1325 &&
1326 (sym.kind == TYP ||
1327 checkDisjoint(pos, flags,
1328 ABSTRACT | NATIVE,
1329 STRICTFP))
1330 && checkDisjoint(pos, flags,
1331 FINAL,
1332 SEALED | NON_SEALED)
1333 && checkDisjoint(pos, flags,
1334 SEALED,
1335 FINAL | NON_SEALED)
1336 && checkDisjoint(pos, flags,
1337 SEALED,
1338 ANNOTATION)
1339 && checkDisjoint(pos, flags,
1340 VALUE_CLASS,
1341 ANNOTATION)
1342 && checkDisjoint(pos, flags,
1343 VALUE_CLASS,
1344 INTERFACE) ) {
1345 // skip
1346 }
1347 return flags & (mask | ~ExtendedStandardFlags) | implicit;
1348 }
1349
1350 /** Determine if this enum should be implicitly final.
1351 *
1352 * If the enum has no specialized enum constants, it is final.
1353 *
1354 * If the enum does have specialized enum constants, it is
1355 * <i>not</i> final.
1356 */
1357 private long implicitEnumFinalFlag(JCTree tree) {
1358 if (!tree.hasTag(CLASSDEF)) return 0;
1359 class SpecialTreeVisitor extends JCTree.Visitor {
1360 boolean specialized;
1361 SpecialTreeVisitor() {
1362 this.specialized = false;
1363 }
1364
2121 return true;
2122 }
2123 }
2124 }
2125 return false;
2126 }
2127
2128 /** Check that a given method conforms with any method it overrides.
2129 * @param tree The tree from which positions are extracted
2130 * for errors.
2131 * @param m The overriding method.
2132 */
2133 void checkOverride(Env<AttrContext> env, JCMethodDecl tree, MethodSymbol m) {
2134 ClassSymbol origin = (ClassSymbol)m.owner;
2135 if ((origin.flags() & ENUM) != 0 && names.finalize.equals(m.name)) {
2136 if (m.overrides(syms.enumFinalFinalize, origin, types, false)) {
2137 log.error(tree.pos(), Errors.EnumNoFinalize);
2138 return;
2139 }
2140 }
2141 if (allowValueClasses && origin.isValueClass() && names.finalize.equals(m.name)) {
2142 if (m.overrides(syms.objectFinalize, origin, types, false)) {
2143 log.warning(tree.pos(), Warnings.ValueFinalize);
2144 }
2145 }
2146 if (allowRecords && origin.isRecord()) {
2147 // let's find out if this is a user defined accessor in which case the @Override annotation is acceptable
2148 Optional<? extends RecordComponent> recordComponent = origin.getRecordComponents().stream()
2149 .filter(rc -> rc.accessor == tree.sym && (rc.accessor.flags_field & GENERATED_MEMBER) == 0).findFirst();
2150 if (recordComponent.isPresent()) {
2151 return;
2152 }
2153 }
2154
2155 for (Type t = origin.type; t.hasTag(CLASS);
2156 t = types.supertype(t)) {
2157 if (t != origin.type) {
2158 checkOverride(tree, t, origin, m);
2159 }
2160 for (Type t2 : types.interfaces(t)) {
2161 checkOverride(tree, t2, origin, m);
2162 }
2163 }
2164
2165 final boolean explicitOverride = m.attribute(syms.overrideType.tsym) != null;
2561 /** Check that all abstract methods implemented by a class are
2562 * mutually compatible.
2563 * @param pos Position to be used for error reporting.
2564 * @param c The class whose interfaces are checked.
2565 */
2566 void checkCompatibleSupertypes(DiagnosticPosition pos, Type c) {
2567 List<Type> supertypes = types.interfaces(c);
2568 Type supertype = types.supertype(c);
2569 if (supertype.hasTag(CLASS) &&
2570 (supertype.tsym.flags() & ABSTRACT) != 0)
2571 supertypes = supertypes.prepend(supertype);
2572 for (List<Type> l = supertypes; l.nonEmpty(); l = l.tail) {
2573 if (!l.head.getTypeArguments().isEmpty() &&
2574 !checkCompatibleAbstracts(pos, l.head, l.head, c))
2575 return;
2576 for (List<Type> m = supertypes; m != l; m = m.tail)
2577 if (!checkCompatibleAbstracts(pos, l.head, m.head, c))
2578 return;
2579 }
2580 checkCompatibleConcretes(pos, c);
2581
2582 Type identitySuper = null;
2583 for (Type t : types.closure(c)) {
2584 if (t != c) {
2585 if (t.isIdentityClass() && (t.tsym.flags() & VALUE_BASED) == 0)
2586 identitySuper = t;
2587 if (c.isValueClass() && identitySuper != null && identitySuper.tsym != syms.objectType.tsym) { // Object is special
2588 log.error(pos, Errors.ValueTypeHasIdentitySuperType(c, identitySuper));
2589 break;
2590 }
2591 }
2592 }
2593 }
2594
2595 /** Check that all non-override equivalent methods accessible from 'site'
2596 * are mutually compatible (JLS 8.4.8/9.4.1).
2597 *
2598 * @param pos Position to be used for error reporting.
2599 * @param site The class whose methods are checked.
2600 * @param sym The method symbol to be checked.
2601 */
2602 void checkOverrideClashes(DiagnosticPosition pos, Type site, MethodSymbol sym) {
2603 ClashFilter cf = new ClashFilter(site);
2604 //for each method m1 that is overridden (directly or indirectly)
2605 //by method 'sym' in 'site'...
2606
2607 ArrayList<Symbol> symbolsByName = new ArrayList<>();
2608 types.membersClosure(site, false).getSymbolsByName(sym.name, cf).forEach(symbolsByName::add);
2609 for (Symbol m1 : symbolsByName) {
2610 if (!sym.overrides(m1, site.tsym, types, false)) {
2611 continue;
2612 }
4946 }
4947 } else {
4948 Assert.error("Unknown pattern: " + currentPattern.getTag());
4949 }
4950 return false;
4951 }
4952
4953 /** check if a type is a subtype of Externalizable, if that is available. */
4954 boolean isExternalizable(Type t) {
4955 try {
4956 syms.externalizableType.complete();
4957 } catch (CompletionFailure e) {
4958 return false;
4959 }
4960 return types.isSubtype(t, syms.externalizableType);
4961 }
4962
4963 /**
4964 * Check structure of serialization declarations.
4965 */
4966 public void checkSerialStructure(Env<AttrContext> env, JCClassDecl tree, ClassSymbol c) {
4967 (new SerialTypeVisitor(env)).visit(c, tree);
4968 }
4969
4970 /**
4971 * This visitor will warn if a serialization-related field or
4972 * method is declared in a suspicious or incorrect way. In
4973 * particular, it will warn for cases where the runtime
4974 * serialization mechanism will silently ignore a mis-declared
4975 * entity.
4976 *
4977 * Distinguished serialization-related fields and methods:
4978 *
4979 * Methods:
4980 *
4981 * private void writeObject(ObjectOutputStream stream) throws IOException
4982 * ANY-ACCESS-MODIFIER Object writeReplace() throws ObjectStreamException
4983 *
4984 * private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
4985 * private void readObjectNoData() throws ObjectStreamException
4986 * ANY-ACCESS-MODIFIER Object readResolve() throws ObjectStreamException
4987 *
4988 * Fields:
4989 *
4990 * private static final long serialVersionUID
4991 * private static final ObjectStreamField[] serialPersistentFields
4992 *
4993 * Externalizable: methods defined on the interface
4994 * public void writeExternal(ObjectOutput) throws IOException
4995 * public void readExternal(ObjectInput) throws IOException
4996 */
4997 private class SerialTypeVisitor extends ElementKindVisitor14<Void, JCClassDecl> {
4998 Env<AttrContext> env;
4999 SerialTypeVisitor(Env<AttrContext> env) {
5000 this.lint = Check.this.lint;
5001 this.env = env;
5002 }
5003
5004 private static final Set<String> serialMethodNames =
5005 Set.of("writeObject", "writeReplace",
5006 "readObject", "readObjectNoData",
5007 "readResolve");
5008
5009 private static final Set<String> serialFieldNames =
5010 Set.of("serialVersionUID", "serialPersistentFields");
5011
5012 // Type of serialPersistentFields
5013 private final Type OSF_TYPE = new Type.ArrayType(syms.objectStreamFieldType, syms.arrayClass);
5014
5015 Lint lint;
5016
5017 @Override
5018 public Void defaultAction(Element e, JCClassDecl p) {
5019 throw new IllegalArgumentException(Objects.requireNonNullElse(e.toString(), ""));
5020 }
5021
5022 @Override
5023 public Void visitType(TypeElement e, JCClassDecl p) {
5024 runUnderLint(e, p, (symbol, param) -> super.visitType(symbol, param));
5025 return null;
5026 }
5027
5028 @Override
5029 public Void visitTypeAsClass(TypeElement e,
5030 JCClassDecl p) {
5031 // Anonymous classes filtered out by caller.
5032
5033 ClassSymbol c = (ClassSymbol)e;
5034
5035 checkCtorAccess(p, c);
5036
5037 /* Check for missing serialVersionUID; check *not* done
5038 * for enums or records.
5039 * Migrated value classes, need the value class and its corresponding
5040 * identity class to have the same SVUID.
5041 */
5042 VarSymbol svuidSym = null;
5043 for (Symbol sym : c.members().getSymbolsByName(names.serialVersionUID)) {
5044 if (sym.kind == VAR) {
5045 svuidSym = (VarSymbol)sym;
5046 break;
5047 }
5048 }
5049
5050 if (svuidSym == null) {
5051 log.warning(p.pos(), LintWarnings.MissingSVUID(c));
5052 }
5053
5054 // Check for serialPersistentFields to gate checks for
5055 // non-serializable non-transient instance fields
5056 boolean serialPersistentFieldsPresent =
5057 c.members()
5058 .getSymbolsByName(names.serialPersistentFields, sym -> sym.kind == VAR)
5059 .iterator()
5060 .hasNext();
5061
5062 // Check declarations of serialization-related methods and
5063 // fields
5064 final Map<String, Symbol> declaredSerialMethodNames = new HashMap<>();
5065 for(Symbol el : c.getEnclosedElements()) {
5066 runUnderLint(el, p, (enclosed, tree) -> {
5067 String name = null;
5068 switch(enclosed.getKind()) {
5069 case FIELD -> {
5070 if (!serialPersistentFieldsPresent) {
5071 var flags = enclosed.flags();
5072 if ( ((flags & TRANSIENT) == 0) &&
5073 ((flags & STATIC) == 0)) {
5074 Type varType = enclosed.asType();
5075 if (!canBeSerialized(varType)) {
5076 // Note per JLS arrays are
5077 // serializable even if the
5078 // component type is not.
5079 log.warning(
5080 TreeInfo.diagnosticPositionFor(enclosed, tree),
5081 LintWarnings.NonSerializableInstanceField);
5082 } else if (varType.hasTag(ARRAY)) {
5083 ArrayType arrayType = (ArrayType)varType;
5084 Type elementType = arrayType.elemtype;
5117 // Class.getDeclaredMethod. This differs from calling
5118 // Elements.getAllMembers(TypeElement) as the latter
5119 // will also pull in default methods from
5120 // superinterfaces. In other words, the runtime checks
5121 // (which long predate default methods on interfaces)
5122 // do not admit the possibility of inheriting methods
5123 // this way, a difference from general inheritance.
5124
5125 // The current implementation just checks the enclosed
5126 // elements and does not directly check the inherited
5127 // methods. If all the types are being checked this is
5128 // less of a concern; however, there are cases that
5129 // could be missed. In particular, readResolve and
5130 // writeReplace could, in principle, by inherited from
5131 // a non-serializable superclass and thus not checked
5132 // even if compiled with a serializable child class.
5133 case METHOD -> {
5134 var method = (MethodSymbol)enclosed;
5135 name = method.getSimpleName().toString();
5136 if (serialMethodNames.contains(name)) {
5137 if (switch (name) {
5138 case "writeObject" -> hasAppropriateWriteObject(tree, e, method);
5139 case "writeReplace" -> hasAppropriateWriteReplace(tree, method, true);
5140 case "readObject" -> hasAppropriateReadObject(tree, e, method);
5141 case "readObjectNoData" -> hasAppropriateReadObjectNoData(tree, e, method);
5142 case "readResolve" -> hasAppropriateReadResolve(tree, e, method);
5143 default -> throw new AssertionError();
5144 }) {
5145 declaredSerialMethodNames.put(name, el);
5146 }
5147 }
5148 }
5149 }
5150 });
5151 }
5152 if (declaredSerialMethodNames.get("writeReplace") == null &&
5153 (c.isValueClass() || hasAbstractValueSuperClass(c, Set.of(syms.numberType.tsym))) &&
5154 !c.isAbstract() && !c.isRecord() &&
5155 types.unboxedType(c.type) == Type.noType) {
5156 /* if we are dealing with a value class or with a class with a super class that happens to
5157 * be an abstract value class, that is not declaring a proper `writeReplace` method, then we
5158 * need to make sure then that it is inheriting an appropriate one.
5159 */
5160 MethodSymbol ms = null;
5161 Log.DiagnosticHandler discardHandler = log.new DiscardDiagnosticHandler();
5162 try {
5163 ms = rs.resolveInternalMethod(env.tree, env, c.type, names.writeReplace, List.nil(), List.nil());
5164 } catch (FatalError fe) {
5165 // ignore no method was found
5166 } finally {
5167 log.popDiagnosticHandler(discardHandler);
5168 }
5169 if (ms == null || !hasAppropriateWriteReplace(p, ms, false)) {
5170 log.warning(p.pos(),
5171 c.isValueClass() ? LintWarnings.SerializableValueClassWithoutWriteReplace1 :
5172 LintWarnings.SerializableValueClassWithoutWriteReplace2);
5173 }
5174 }
5175 if (c.isValueClass()) {
5176 /* Value classes are Serializable through the use of the serialization proxy pattern.
5177 * The serialization protocol does not support a standard serialized form for value classes.
5178 * The value class delegates to a serialization proxy by supplying an alternate
5179 * record or object to be serialized instead of the value class.
5180 * When the proxy is deserialized it re-constructs the value object and returns the value object.
5181 *
5182 * In particular methods:
5183 * - writeObject
5184 * - readObject and
5185 * - readObjectNoData
5186 * are not invoked for value classes, we need to warn the user about this
5187 */
5188 for (Map.Entry<String, Symbol> entry : declaredSerialMethodNames.entrySet()) {
5189 String key = entry.getKey();
5190 if (key.equals("writeObject") || key.equals("readObject") || key.equals("readObjectNoData")) {
5191 log.warning(TreeInfo.diagnosticPositionFor(entry.getValue(), p), LintWarnings.IneffectualSerialMethodValueClass(key));
5192 }
5193 }
5194 }
5195 return null;
5196 }
5197
5198 boolean canBeSerialized(Type type) {
5199 return type.isPrimitive() || rs.isSerializable(type);
5200 }
5201
5202 private boolean hasAbstractValueSuperClass(Symbol c, Set<Symbol> excluding) {
5203 while (c.getKind() == ElementKind.CLASS) {
5204 Type sup = ((ClassSymbol)c).getSuperclass();
5205 if (!sup.hasTag(CLASS) || sup.isErroneous() ||
5206 sup.tsym == syms.objectType.tsym) {
5207 return false;
5208 }
5209 // if it is a value super class it has to be abstract
5210 if (sup.isValueClass() && !excluding.contains(sup.tsym)) {
5211 return true;
5212 }
5213 c = sup.tsym;
5214 }
5215 return false;
5216 }
5217
5218 /**
5219 * Check that Externalizable class needs a public no-arg
5220 * constructor.
5221 *
5222 * Check that a Serializable class has access to the no-arg
5223 * constructor of its first nonserializable superclass.
5224 */
5225 private void checkCtorAccess(JCClassDecl tree, ClassSymbol c) {
5226 if (isExternalizable(c.type)) {
5227 for(var sym : c.getEnclosedElements()) {
5228 if (sym.isConstructor() &&
5229 ((sym.flags() & PUBLIC) == PUBLIC)) {
5230 if (((MethodSymbol)sym).getParameters().isEmpty()) {
5231 return;
5232 }
5233 }
5234 }
5235 log.warning(tree.pos(),
5236 LintWarnings.ExternalizableMissingPublicNoArgCtor);
5237 } else {
5314
5315 if (isExternalizable((Type)(e.asType()))) {
5316 log.warning(
5317 TreeInfo.diagnosticPositionFor(spf, tree),
5318 LintWarnings.IneffectualSerialFieldExternalizable);
5319 }
5320
5321 // Warn if serialPersistentFields is initialized to a
5322 // literal null.
5323 JCTree spfDecl = TreeInfo.declarationFor(spf, tree);
5324 if (spfDecl != null && spfDecl.getTag() == VARDEF) {
5325 JCVariableDecl variableDef = (JCVariableDecl) spfDecl;
5326 JCExpression initExpr = variableDef.init;
5327 if (initExpr != null && TreeInfo.isNull(initExpr)) {
5328 log.warning(initExpr.pos(),
5329 LintWarnings.SPFNullInit);
5330 }
5331 }
5332 }
5333
5334 private boolean hasAppropriateWriteObject(JCClassDecl tree, Element e, MethodSymbol method) {
5335 // The "synchronized" modifier is seen in the wild on
5336 // readObject and writeObject methods and is generally
5337 // innocuous.
5338
5339 // private void writeObject(ObjectOutputStream stream) throws IOException
5340 return isPrivateNonStaticMethod(tree, method) & // no short-circuit we need to log warnings
5341 isExpectedReturnType(tree, method, syms.voidType, true) &
5342 hasExpectedArg(tree, method, syms.objectOutputStreamType) &
5343 hasExpectedExceptions(tree, method, true, syms.ioExceptionType) &
5344 checkExternalizable(tree, e, method);
5345 }
5346
5347 private boolean hasAppropriateWriteReplace(JCClassDecl tree, MethodSymbol method, boolean warn) {
5348 // ANY-ACCESS-MODIFIER Object writeReplace() throws
5349 // ObjectStreamException
5350
5351 // Excluding abstract, could have a more complicated
5352 // rule based on abstract-ness of the class
5353 return isConcreteInstanceMethod(tree, method, warn) & // no short-circuit we need to log warnings
5354 isExpectedReturnType(tree, method, syms.objectType, warn) &
5355 hasNoArgs(tree, method, warn) &
5356 hasExpectedExceptions(tree, method, warn, syms.objectStreamExceptionType);
5357 }
5358
5359 private boolean hasAppropriateReadObject(JCClassDecl tree, Element e, MethodSymbol method) {
5360 // The "synchronized" modifier is seen in the wild on
5361 // readObject and writeObject methods and is generally
5362 // innocuous.
5363
5364 // private void readObject(ObjectInputStream stream)
5365 // throws IOException, ClassNotFoundException
5366 return isPrivateNonStaticMethod(tree, method) & // no short-circuit we need to log warnings
5367 isExpectedReturnType(tree, method, syms.voidType, true) &
5368 hasExpectedArg(tree, method, syms.objectInputStreamType) &
5369 hasExpectedExceptions(tree, method, true, syms.ioExceptionType, syms.classNotFoundExceptionType) &
5370 checkExternalizable(tree, e, method);
5371 }
5372
5373 private boolean hasAppropriateReadObjectNoData(JCClassDecl tree, Element e, MethodSymbol method) {
5374 // private void readObjectNoData() throws ObjectStreamException
5375 return isPrivateNonStaticMethod(tree, method) & // no short-circuit we need to log warnings
5376 isExpectedReturnType(tree, method, syms.voidType, true) &
5377 hasNoArgs(tree, method, true) &
5378 hasExpectedExceptions(tree, method, true, syms.objectStreamExceptionType) &
5379 checkExternalizable(tree, e, method);
5380 }
5381
5382 private boolean hasAppropriateReadResolve(JCClassDecl tree, Element e, MethodSymbol method) {
5383 // ANY-ACCESS-MODIFIER Object readResolve()
5384 // throws ObjectStreamException
5385
5386 // Excluding abstract, could have a more complicated
5387 // rule based on abstract-ness of the class
5388 return isConcreteInstanceMethod(tree, method, true) & // no short-circuit we need to log warnings
5389 isExpectedReturnType(tree, method, syms.objectType, true) &
5390 hasNoArgs(tree, method, true) &
5391 hasExpectedExceptions(tree, method, true, syms.objectStreamExceptionType);
5392 }
5393
5394 private void checkWriteExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5395 //public void writeExternal(ObjectOutput) throws IOException
5396 checkExternMethodRecord(tree, e, method, syms.objectOutputType, isExtern);
5397 }
5398
5399 private void checkReadExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5400 // public void readExternal(ObjectInput) throws IOException
5401 checkExternMethodRecord(tree, e, method, syms.objectInputType, isExtern);
5402 }
5403
5404 private void checkExternMethodRecord(JCClassDecl tree, Element e, MethodSymbol method, Type argType,
5405 boolean isExtern) {
5406 if (isExtern && isExternMethod(tree, e, method, argType)) {
5407 log.warning(
5408 TreeInfo.diagnosticPositionFor(method, tree),
5409 LintWarnings.IneffectualExternalizableMethodRecord(method.getSimpleName().toString()));
5410 }
5411 }
5412
5413 boolean isPrivateNonStaticMethod(JCClassDecl tree, MethodSymbol method) {
5414 var flags = method.flags();
5415 boolean result = true;
5416 if ((flags & PRIVATE) == 0) {
5417 log.warning(
5418 TreeInfo.diagnosticPositionFor(method, tree),
5419 LintWarnings.SerialMethodNotPrivate(method.getSimpleName()));
5420 result = false;
5421 }
5422
5423 if ((flags & STATIC) != 0) {
5424 log.warning(
5425 TreeInfo.diagnosticPositionFor(method, tree),
5426 LintWarnings.SerialMethodStatic(method.getSimpleName()));
5427 result = false;
5428 }
5429 return result;
5430 }
5431
5432 /**
5433 * Per section 1.12 "Serialization of Enum Constants" of
5434 * the serialization specification, due to the special
5435 * serialization handling of enums, any writeObject,
5436 * readObject, writeReplace, and readResolve methods are
5437 * ignored as are serialPersistentFields and
5438 * serialVersionUID fields.
5439 */
5440 @Override
5441 public Void visitTypeAsEnum(TypeElement e,
5442 JCClassDecl p) {
5443 boolean isExtern = isExternalizable((Type)e.asType());
5444 for(Element el : e.getEnclosedElements()) {
5445 runUnderLint(el, p, (enclosed, tree) -> {
5446 String name = enclosed.getSimpleName().toString();
5447 switch(enclosed.getKind()) {
5448 case FIELD -> {
5449 var field = (VarSymbol)enclosed;
5625 case FIELD -> {
5626 var field = (VarSymbol)enclosed;
5627 switch(name) {
5628 case "serialPersistentFields" -> {
5629 log.warning(
5630 TreeInfo.diagnosticPositionFor(field, tree),
5631 LintWarnings.IneffectualSerialFieldRecord);
5632 }
5633
5634 case "serialVersionUID" -> {
5635 // Could generate additional warning that
5636 // svuid value is not checked to match for
5637 // records.
5638 checkSerialVersionUID(tree, e, field);
5639 }}
5640 }
5641
5642 case METHOD -> {
5643 var method = (MethodSymbol)enclosed;
5644 switch(name) {
5645 case "writeReplace" -> hasAppropriateWriteReplace(tree, method, true);
5646 case "readResolve" -> hasAppropriateReadResolve(tree, e, method);
5647
5648 case "writeExternal" -> checkWriteExternalRecord(tree, e, method, isExtern);
5649 case "readExternal" -> checkReadExternalRecord(tree, e, method, isExtern);
5650
5651 default -> {
5652 if (serialMethodNames.contains(name)) {
5653 log.warning(
5654 TreeInfo.diagnosticPositionFor(method, tree),
5655 LintWarnings.IneffectualSerialMethodRecord(name));
5656 }
5657 }}
5658 }}});
5659 }
5660 return null;
5661 }
5662
5663 boolean isConcreteInstanceMethod(JCClassDecl tree,
5664 MethodSymbol method,
5665 boolean warn) {
5666 if ((method.flags() & (STATIC | ABSTRACT)) != 0) {
5667 if (warn) {
5668 log.warning(
5669 TreeInfo.diagnosticPositionFor(method, tree),
5670 LintWarnings.SerialConcreteInstanceMethod(method.getSimpleName()));
5671 }
5672 return false;
5673 }
5674 return true;
5675 }
5676
5677 private boolean isExpectedReturnType(JCClassDecl tree,
5678 MethodSymbol method,
5679 Type expectedReturnType,
5680 boolean warn) {
5681 // Note: there may be complications checking writeReplace
5682 // and readResolve since they return Object and could, in
5683 // principle, have covariant overrides and any synthetic
5684 // bridge method would not be represented here for
5685 // checking.
5686 Type rtype = method.getReturnType();
5687 if (!types.isSameType(expectedReturnType, rtype)) {
5688 if (warn) {
5689 log.warning(
5690 TreeInfo.diagnosticPositionFor(method, tree),
5691 LintWarnings.SerialMethodUnexpectedReturnType(method.getSimpleName(),
5692 rtype, expectedReturnType));
5693 }
5694 return false;
5695 }
5696 return true;
5697 }
5698
5699 private boolean hasExpectedArg(JCClassDecl tree,
5700 MethodSymbol method,
5701 Type expectedType) {
5702
5703 var parameters= method.getParameters();
5704
5705 if (parameters.size() != 1) {
5706 log.warning(
5707 TreeInfo.diagnosticPositionFor(method, tree),
5708 LintWarnings.SerialMethodOneArg(method.getSimpleName(), parameters.size()));
5709 return false;
5710 }
5711
5712 Type parameterType = parameters.get(0).asType();
5713 if (!types.isSameType(parameterType, expectedType)) {
5714 log.warning(
5715 TreeInfo.diagnosticPositionFor(method, tree),
5716 LintWarnings.SerialMethodParameterType(method.getSimpleName(),
5717 expectedType,
5718 parameterType));
5719 return false;
5720 }
5721 return true;
5722 }
5723
5724 private boolean hasExactlyOneArgWithType(JCClassDecl tree,
5725 Element enclosing,
5726 MethodSymbol method,
5727 Type expectedType) {
5728 var parameters = method.getParameters();
5729 return (parameters.size() == 1) &&
5730 types.isSameType(parameters.get(0).asType(), expectedType);
5731 }
5732
5733
5734 boolean hasNoArgs(JCClassDecl tree, MethodSymbol method, boolean warn) {
5735 var parameters = method.getParameters();
5736 if (!parameters.isEmpty()) {
5737 if (warn) {
5738 log.warning(
5739 TreeInfo.diagnosticPositionFor(parameters.get(0), tree),
5740 LintWarnings.SerialMethodNoArgs(method.getSimpleName()));
5741 }
5742 return false;
5743 }
5744 return true;
5745 }
5746
5747 private boolean checkExternalizable(JCClassDecl tree, Element enclosing, MethodSymbol method) {
5748 // If the enclosing class is externalizable, warn for the method
5749 if (isExternalizable((Type)enclosing.asType())) {
5750 log.warning(
5751 TreeInfo.diagnosticPositionFor(method, tree),
5752 LintWarnings.IneffectualSerialMethodExternalizable(method.getSimpleName()));
5753 return false;
5754 }
5755 return true;
5756 }
5757
5758 private boolean hasExpectedExceptions(JCClassDecl tree,
5759 MethodSymbol method,
5760 boolean warn,
5761 Type... declaredExceptions) {
5762 for (Type thrownType: method.getThrownTypes()) {
5763 // For each exception in the throws clause of the
5764 // method, if not an Error and not a RuntimeException,
5765 // check if the exception is a subtype of a declared
5766 // exception from the throws clause of the
5767 // serialization method in question.
5768 if (types.isSubtype(thrownType, syms.runtimeExceptionType) ||
5769 types.isSubtype(thrownType, syms.errorType) ) {
5770 continue;
5771 } else {
5772 boolean declared = false;
5773 for (Type declaredException : declaredExceptions) {
5774 if (types.isSubtype(thrownType, declaredException)) {
5775 declared = true;
5776 continue;
5777 }
5778 }
5779 if (!declared) {
5780 if (warn) {
5781 log.warning(
5782 TreeInfo.diagnosticPositionFor(method, tree),
5783 LintWarnings.SerialMethodUnexpectedException(method.getSimpleName(),
5784 thrownType));
5785 }
5786 return false;
5787 }
5788 }
5789 }
5790 return true;
5791 }
5792
5793 private <E extends Element> Void runUnderLint(E symbol, JCClassDecl p, BiConsumer<E, JCClassDecl> task) {
5794 Lint prevLint = lint;
5795 try {
5796 lint = lint.augment((Symbol) symbol);
5797
5798 if (lint.isEnabled(LintCategory.SERIAL)) {
5799 task.accept(symbol, p);
5800 }
5801
5802 return null;
5803 } finally {
5804 lint = prevLint;
5805 }
5806 }
5807
5808 }
5809
5810 void checkRequiresIdentity(JCTree tree, Lint lint) {
|