main.com.squareup.moshi.kotlin.codegen.api.Options.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moshi-kotlin-codegen Show documentation

A modern JSON API for Android and Java

There is a newer version: 1.15.1

/*
 * Copyright (C) 2021 Square, Inc.
 *
 * Licensed 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
 *
 *    https://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 com.squareup.moshi.kotlin.codegen.api

import com.squareup.kotlinpoet.ClassName

@InternalMoshiCodegenApi
public object Options {
  /**
   * This processing option can be specified to have a `@Generated` annotation
   * included in the generated code. It is not encouraged unless you need it for static analysis
   * reasons and not enabled by default.
   *
   * Note that this can only be one of the following values:
   *   * `"javax.annotation.processing.Generated"` (JRE 9+)
   *   * `"javax.annotation.Generated"` (JRE <9)
   */
  public const val OPTION_GENERATED: String = "moshi.generated"

  /**
   * This boolean processing option can disable proguard rule generation.
   * Normally, this is not recommended unless end-users build their own JsonAdapter look-up tool.
   * This is enabled by default.
   */
  public const val OPTION_GENERATE_PROGUARD_RULES: String = "moshi.generateProguardRules"

  /**
   * This boolean processing option controls whether or not Moshi will directly instantiate
   * JsonQualifier annotations in Kotlin 1.6+. Note that this is enabled by default in Kotlin 1.6
   * but can be disabled to restore the legacy behavior of storing annotations on generated adapter
   * fields and looking them up reflectively.
   */
  public const val OPTION_INSTANTIATE_ANNOTATIONS: String = "moshi.instantiateAnnotations"

  public val POSSIBLE_GENERATED_NAMES: Map = arrayOf(
    ClassName("javax.annotation.processing", "Generated"),
    ClassName("javax.annotation", "Generated")
  ).associateBy { it.canonicalName }
}