commonMain.com.squareup.wire.AnyMessage.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 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
 *
 * 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 com.squareup.wire

import com.squareup.wire.AnyMessage.Companion.pack
import okio.ByteString
import kotlin.jvm.JvmField

/**
 * Wire implementation of the `google.protobuf.Any` type. The `Any` type wraps an arbitrary
 * protobuf message. Field of `Any` generated by Wire will be typed [AnyMessage]. [typeUrl] is
 * used to identify the type of the message, defined as 'type.googleapis.com/full.type.name'.
 * [value] is the serialized representation of the wrapped message. The [pack] and [unpack] methods
 * are available to wrap and unwrap an `Any` message.
 *
 * Example
 * ```
 * val person: Person = anyMessage.unpack(Person.ADAPTER)
 * val anyMessage: AnyMessage = AnyMessage.ADAPTER.pack(person)
 * ```
 */
class AnyMessage(
  val typeUrl: String,
  val value: ByteString = ByteString.EMPTY
) : Message(ADAPTER, ByteString.EMPTY) {

  fun  unpack(adapter: ProtoAdapter): T {
    check(typeUrl == adapter.typeUrl) {
      "type mismatch: $typeUrl != ${adapter.typeUrl}"
    }
    return adapter.decode(value)
  }

  fun  unpackOrNull(adapter: ProtoAdapter): T? {
    return if (typeUrl == adapter.typeUrl) adapter.decode(value) else null
  }

  @Deprecated(
      message = "Shouldn't be used in Kotlin",
      level = DeprecationLevel.HIDDEN
  )
  override fun newBuilder(): Nothing = throw AssertionError()

  override fun equals(other: Any?): Boolean {
    if (other === this) return true
    if (other !is AnyMessage) return false
    return typeUrl == other.typeUrl && value == other.value
  }

  override fun hashCode(): Int {
    var result = super.hashCode
    if (result == 0) {
      result = result * 37 + typeUrl.hashCode()
      result = result * 37 + value.hashCode()
      super.hashCode = result
    }
    return result
  }

  override fun toString() = "Any{type_url=$typeUrl, value=$value}"

  fun copy(
    typeUrl: String = this.typeUrl,
    value: ByteString = this.value
  ) = AnyMessage(typeUrl, value)

  companion object {
    fun pack(message: Message<*, *>): AnyMessage {
      val typeUrl = message.adapter.typeUrl
          ?: error("recompile ${message::class} to use it with AnyMessage")
      return AnyMessage(typeUrl, message.encodeByteString())
    }

    @JvmField
    val ADAPTER: ProtoAdapter = object : ProtoAdapter(
        FieldEncoding.LENGTH_DELIMITED,
        AnyMessage::class,
        "type.googleapis.com/google.protobuf.Any",
        Syntax.PROTO_3
    ) {
      override fun encodedSize(value: AnyMessage): Int =
          STRING.encodedSizeWithTag(1, value.typeUrl) +
              BYTES.encodedSizeWithTag(2, value.value)

      override fun encode(writer: ProtoWriter, value: AnyMessage) {
        STRING.encodeWithTag(writer, 1, value.typeUrl)
        BYTES.encodeWithTag(writer, 2, value.value)
      }

      override fun encode(writer: ReverseProtoWriter, value: AnyMessage) {
        BYTES.encodeWithTag(writer, 2, value.value)
        STRING.encodeWithTag(writer, 1, value.typeUrl)
      }

      override fun decode(reader: ProtoReader): AnyMessage {
        var typeUrl = ""
        var value = ByteString.EMPTY
        reader.forEachTag { tag ->
          when (tag) {
            1 -> typeUrl = STRING.decode(reader)
            2 -> value = BYTES.decode(reader)
            else -> reader.readUnknownField(tag)
          }
        }
        return AnyMessage(typeUrl = typeUrl, value = value)
      }

      // TODO: this is a hazard.
      override fun redact(value: AnyMessage) =
          AnyMessage("square.github.io/wire/redacted", ByteString.EMPTY)
    }
  }
}