-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Added Bson-Kotlin Array Codec #1457
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
/* | ||
* Copyright 2008-present MongoDB, 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 org.bson.codecs.kotlin | ||
|
||
import java.lang.reflect.ParameterizedType | ||
import java.lang.reflect.Type | ||
import kotlin.reflect.KClass | ||
import org.bson.BsonReader | ||
import org.bson.BsonType | ||
import org.bson.BsonWriter | ||
import org.bson.codecs.Codec | ||
import org.bson.codecs.DecoderContext | ||
import org.bson.codecs.EncoderContext | ||
import org.bson.codecs.configuration.CodecRegistry | ||
|
||
@Suppress("UNCHECKED_CAST") | ||
internal data class ArrayCodec<R : Any, V>(private val kClass: KClass<R>, private val codec: Codec<V?>) : Codec<R> { | ||
|
||
companion object { | ||
internal fun <R : Any> create( | ||
kClass: KClass<R>, | ||
typeArguments: List<Type>, | ||
codecRegistry: CodecRegistry | ||
): Codec<R> { | ||
assert(kClass.javaObjectType.isArray) { "$kClass must be an array type" } | ||
val (valueClass, nestedTypes) = | ||
if (typeArguments.isEmpty()) { | ||
Pair(kClass.java.componentType.kotlin.javaObjectType as Class<Any>, emptyList()) | ||
} else { | ||
when (val pType = typeArguments[0]) { | ||
is Class<*> -> Pair(pType as Class<Any>, emptyList()) | ||
is ParameterizedType -> Pair(pType.rawType as Class<Any>, pType.actualTypeArguments.toList()) | ||
else -> Pair(Object::class.java as Class<Any>, emptyList()) | ||
} | ||
} | ||
val codec = | ||
if (nestedTypes.isEmpty()) codecRegistry.get(valueClass) else codecRegistry.get(valueClass, nestedTypes) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just a question: Is it our Kotlin code style to use single-line if-else statements without braces? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, we follow the main kotlin coding standards. It looks unusual as in Java we'd use a tenary operator but in Kotlin there is no such thing. |
||
return ArrayCodec(kClass, codec) | ||
} | ||
} | ||
|
||
private val isPrimitiveArray = kClass.java.componentType != kClass.java.componentType.kotlin.javaObjectType | ||
|
||
override fun encode(writer: BsonWriter, arrayValue: R, encoderContext: EncoderContext) { | ||
writer.writeStartArray() | ||
|
||
boxed(arrayValue).forEach { | ||
if (it == null) writer.writeNull() else encoderContext.encodeWithChildContext(codec, writer, it) | ||
} | ||
|
||
writer.writeEndArray() | ||
} | ||
|
||
override fun getEncoderClass(): Class<R> = kClass.java | ||
|
||
override fun decode(reader: BsonReader, decoderContext: DecoderContext): R { | ||
reader.readStartArray() | ||
val data = ArrayList<V?>() | ||
while (reader.readBsonType() != BsonType.END_OF_DOCUMENT) { | ||
if (reader.currentBsonType == BsonType.NULL) { | ||
reader.readNull() | ||
data.add(null) | ||
} else { | ||
data.add(decoderContext.decodeWithChildContext(codec, reader)) | ||
} | ||
} | ||
reader.readEndArray() | ||
return unboxed(data) | ||
} | ||
|
||
fun boxed(arrayValue: R): Iterator<V?> { | ||
val boxedValue = | ||
if (!isPrimitiveArray) { | ||
(arrayValue as Array<V?>).iterator() | ||
} else if (arrayValue is BooleanArray) { | ||
arrayValue.toList().iterator() | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using toList() seems redundant since we can directly use an iterator on the array itself. Is this additional conversion to a List necessary? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It was used to stop a spotbugs error, however, using |
||
} else if (arrayValue is ByteArray) { | ||
arrayValue.toList().iterator() | ||
} else if (arrayValue is CharArray) { | ||
arrayValue.toList().iterator() | ||
} else if (arrayValue is DoubleArray) { | ||
arrayValue.toList().iterator() | ||
} else if (arrayValue is FloatArray) { | ||
arrayValue.toList().iterator() | ||
} else if (arrayValue is IntArray) { | ||
arrayValue.toList().iterator() | ||
} else if (arrayValue is LongArray) { | ||
arrayValue.toList().iterator() | ||
} else if (arrayValue is ShortArray) { | ||
arrayValue.toList().iterator() | ||
} else { | ||
throw IllegalArgumentException("Unsupported array type ${arrayValue.javaClass}") | ||
} | ||
return boxedValue as Iterator<V?> | ||
} | ||
|
||
private fun unboxed(data: ArrayList<V?>): R { | ||
return if (kClass == BooleanArray::class) { | ||
(data as ArrayList<Boolean>).toBooleanArray() as R | ||
} else if (kClass == ByteArray::class) { | ||
(data as ArrayList<Byte>).toByteArray() as R | ||
} else if (kClass == CharArray::class) { | ||
(data as ArrayList<Char>).toCharArray() as R | ||
} else if (kClass == DoubleArray::class) { | ||
(data as ArrayList<Double>).toDoubleArray() as R | ||
} else if (kClass == FloatArray::class) { | ||
(data as ArrayList<Float>).toFloatArray() as R | ||
} else if (kClass == IntArray::class) { | ||
(data as ArrayList<Int>).toIntArray() as R | ||
} else if (kClass == LongArray::class) { | ||
(data as ArrayList<Long>).toLongArray() as R | ||
} else if (kClass == ShortArray::class) { | ||
(data as ArrayList<Short>).toShortArray() as R | ||
} else { | ||
data.toArray(arrayOfNulls(data.size)) as R | ||
} | ||
vbabanin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
private fun arrayOfNulls(size: Int): Array<V?> { | ||
return java.lang.reflect.Array.newInstance(codec.encoderClass, size) as Array<V?> | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
/* | ||
* Copyright 2008-present MongoDB, 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 org.bson.codecs.kotlin | ||
|
||
import java.lang.reflect.Type | ||
import org.bson.codecs.Codec | ||
import org.bson.codecs.configuration.CodecProvider | ||
import org.bson.codecs.configuration.CodecRegistry | ||
|
||
/** A Kotlin reflection based Codec Provider for data classes */ | ||
public class ArrayCodecProvider : CodecProvider { | ||
override fun <T : Any> get(clazz: Class<T>, registry: CodecRegistry): Codec<T>? = get(clazz, emptyList(), registry) | ||
|
||
override fun <T : Any> get(clazz: Class<T>, typeArguments: List<Type>, registry: CodecRegistry): Codec<T>? = | ||
if (clazz.isArray) { | ||
ArrayCodec.create(clazz.kotlin, typeArguments, registry) | ||
} else null | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Optional] We could consider extracting this code block into a named method to enhance clarity.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As its a single block, I opted to add a comment instead.