sergey-chugunov-1985 commented on code in PR #13532: URL: https://github.com/apache/ignite/pull/13532#discussion_r4104283186
########## modules/codegen/src/main/java/org/apache/ignite/internal/RollingUpgradeAware.java: ########## @@ -0,0 +1,40 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.internal; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import org.apache.ignite.internal.processors.rollingupgrade.feature.IgniteFeature; + +/** + * Marks a class whose serialization takes the Rolling Upgrade into account. + * + * <p>The {@link #registry()} is used to resolve fully qualified names of the {@link IgniteFeature}s that introduced or + * deprecated fields of the annotated class (see {@link Order#introducedBy()} and {@link Order#deprecatedBy()}).</p> + * + * @see Order + * @see IgniteFeature + */ +@Retention(RetentionPolicy.CLASS) +@Target(ElementType.TYPE) +public @interface RollingUpgradeAware { Review Comment: How about a bit different name: RollingUpgradeSubject? To me the word "Aware" has a semantics close to "I receive some information about the process I'm aware of" rather than "I'm a key participant of the process of Rolling Upgrade" ########## modules/codegen/src/main/java/org/apache/ignite/internal/RollingUpgradeAware.java: ########## @@ -0,0 +1,40 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.internal; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import org.apache.ignite.internal.processors.rollingupgrade.feature.IgniteFeature; + +/** + * Marks a class whose serialization takes the Rolling Upgrade into account. Review Comment: I suggest to improve documentation of this class. If a developer modifies a message in a way that should support RU, he/she will have to use this annotation anyway. We need to make the javadoc as clear as possible to explain to the developer how to use it and what role in a bigger picture the annotation plays. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
