/*
 * 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.fory.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation to specify encoding options for 32-bit signed integer fields.
 *
 * <p>When applied to a field of type {@code int} or {@code Integer}, this annotation controls how
 * the value is serialized:
 *
 * <ul>
 *   <li>{@code compress=true} (default): Uses variable-length encoding (VARINT32, type_id=5) which
 *       is more compact for small values
 *   <li>{@code compress=false}: Uses fixed 4-byte encoding (INT32, type_id=4) which has consistent
 *       size
 * </ul>
 *
 * <p>Example usage:
 *
 * <pre>{@code
 * public class MyStruct {
 *   {@literal @}Int32Type(compress = true)  // Uses varint encoding (default)
 *   int compactId;
 *
 *   {@literal @}Int32Type(compress = false) // Uses fixed 4-byte encoding
 *   int fixedId;
 * }
 * }</pre>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface Int32Type {
  /**
   * Whether to use variable-length compression for this int32 field.
   *
   * @return true to use VARINT32 encoding (compact for small values), false to use fixed INT32
   *     encoding (4 bytes)
   */
  boolean compress() default true;
}
