com.squareup.moshi.kotlin.codegen.api.TargetProperty.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) 2018 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.KModifier
import com.squareup.kotlinpoet.PropertySpec
import com.squareup.kotlinpoet.TypeName

/** A property in user code that maps to JSON. */
@InternalMoshiCodegenApi
public data class TargetProperty(
  val propertySpec: PropertySpec,
  val parameter: TargetParameter?,
  val visibility: KModifier,
  val jsonName: String?,
  val jsonIgnore: Boolean
) {
  val name: String get() = propertySpec.name
  val type: TypeName get() = propertySpec.type
  val parameterIndex: Int get() = parameter?.index ?: -1
  val hasDefault: Boolean get() = parameter?.hasDefault ?: true

  override fun toString(): String = name
}