Plugin which generates Android Parcelable boilerplate code for kotlin's class.

nekocode

Last update: Dec 17, 2022

Related tags

Overview

Android Parcelable boilerplate code generation

Inspired by android-parcelable-intellij-plugin

Installation

Plugin is uploaded to plugin repository. If you like, you can also install it manually:

Download ParcelableGenerator release
Open IntelliJ/Android Studio
Preferences -> Plugins -> Install plugin from disk....
Choose the downloaded jar file

Dependencies

It depends on the latest version of Kotlin plugin.

Usage

Just press ALT + Insert (or your equivalent keybinding for code generation) in your editor and select Parcelable. It will auto generate Parcelable boilerplate code for your class.

Now Suported Types

Types implementing Parceable or Serializable
List of Parcelable objects
Array of Parcelable objects
Primitive Kotlin types: String, Byte, Double, Float, Int, Long, Boolean, Char
Kotlin Array types: Array<String>, ByteArray, DoubleArray, FloatArray, IntArray, LongArray, CharArray, BooleanArray
List of any objects (Warning: validation is not performed)
Enum type

License

Copyright (C) 2016 Nekocode (https://github.com/nekocode)

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.

Comments

uncaught NoSuchMethodError
Hi guys,

this plugin worked pretty good for me before, today I am getting this plugin crash while trying to generate parcelable code. This error occurs even when I try to regenerate code at existed classes. I tried to clear cache and restart, clean project, reinstall plugin, degrade kotlin version, even new project. Nothing helps.

Kotlin 1.0.5-2 Android Studio 2.2.3 Build #AI-145.3537739, built on December 2, 2016 JRE: 1.8.0_112-release-b05 x86_64 JVM: OpenJDK 64-Bit Server VM by JetBrains s.r.o

Plugin Error: Parcelable Code Generator(for kotlin) threw an uncaught NoSuchMethodError. Disable Plugin NoSuchMethodError: org.jetbrains.kotlin.descriptors.ClassDescriptor.getUnsubstitutedPrimaryConstructor()Lorg/jetbrains/kotlin/descriptors/ConstructorDescriptor;
bug
opened by Spazzze 14

Bad style for generated code for constructor

Version: 0.7.1 Android Studio: 2.2.3

Response:

constructor(source: Parcel) : this(
  source.readLong(),
  source.readString(),
  source.readString()
  )

How it will be better:

constructor(source: Parcel) : this(source.readLong(), source.readString(),  source.readString())

bug

opened by danielgomezrico 8

optional fields

If the class has optional fields, it might be helpful to use writeValue/readValue calls. With my optional fields, current plugin generates source.readString?() which is invalid, besides if I remove the '?', the function will probably result in NPE if field is null.
bug

opened by CapnSpellcheck 7
Unneded '?' in classLoader declaration
I have val income: Income? property and following code is generated for it

source.readParcelable<Income?>(Income?::class.java.classLoader)

As you see the '?' mark in Income?::class.java.classLoader is not needed. And lint says "type in class literal must not be nullable".
opened by Jeevuz 3
Support Enums
When I try to generate a parcelable class which contains an enum, it generates something like:

enum class SortOrder { AlphaAscending , AlphaDescending, Date }

constructor(source: Parcel) : this(source.readSortOrder()) override fun writeToParcel(dest: Parcel?, flags: Int) { dest?.writeSortOrder(sortOrder) }

and cannot resolve those read or write methods. Not sure if this has something to do with my code, or this plugin.
opened by Jawnnypoo 3

Compat generated code

Will be cool if the generated code was more compact using one liner functions or something like:

override fun describeContents(): Int = 0

companion object {
    @JvmField val CREATOR: Parcelable.Creator<User> = object : Parcelable.Creator<User> {
      override fun createFromParcel(source: Parcel): User = User(source)
      override fun newArray(size: Int): Array<User?> = arrayOfNulls(size)
    }
  }

instead of

override fun describeContents(): Int {
    return 0
  }

  companion object {
    @JvmField final val CREATOR: Parcelable.Creator<User> = object : Parcelable.Creator<User> {
      override fun createFromParcel(source: Parcel): User {
        return User(source)
      }

      override fun newArray(size: Int): Array<User?> {
        return arrayOfNulls(size)
      }
    }
  }

opened by danielgomezrico 2

Exception when using code generation in Java class, plugin enabled

I have this exception when i using code generation in Java class (IDEA 14.1.01674, java 1.7.0_79):

org/jetbrains/kotlin/psi/KtFile java.lang.NoClassDefFoundError: org/jetbrains/kotlin/psi/KtFile at cn.nekocode.plugin.parcelablegenerator.ParcelableAction.getPsiClassFromEvent(ParcelableAction.java:82) at cn.nekocode.plugin.parcelablegenerator.ParcelableAction.update(ParcelableAction.java:69) at com.intellij.openapi.actionSystem.AnAction.beforeActionPerformedUpdate(AnAction.java:243) at com.intellij.openapi.actionSystem.ex.ActionUtil.performDumbAwareUpdate(ActionUtil.java:111) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.b(PopupFactoryImpl.java:934) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.b(PopupFactoryImpl.java:924) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.buildGroup(PopupFactoryImpl.java:860) at com.intellij.ui.popup.PopupFactoryImpl$ActionGroupPopup.a(PopupFactoryImpl.java:257) at com.intellij.ui.popup.PopupFactoryImpl$ActionGroupPopup.(PopupFactoryImpl.java:214) at com.intellij.ui.popup.PopupFactoryImpl.a(PopupFactoryImpl.java:194) at com.intellij.ui.popup.PopupFactoryImpl.a(PopupFactoryImpl.java:168) at com.intellij.ui.popup.PopupFactoryImpl.createActionGroupPopup(PopupFactoryImpl.java:296) at com.intellij.codeInsight.generation.actions.GenerateAction.actionPerformed(GenerateAction.java:38) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher$3.performAction(IdeKeyEventDispatcher.java:586) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.processAction(IdeKeyEventDispatcher.java:637) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.d(IdeKeyEventDispatcher.java:476) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.dispatchKeyEvent(IdeKeyEventDispatcher.java:212) at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:538) at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:382) at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:242) at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:161) at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:150) at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:146) at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:138) at java.awt.EventDispatchThread.run(EventDispatchThread.java:91)

java.lang.NoClassDefFoundError: org/jetbrains/kotlin/psi/KtFile at cn.nekocode.plugin.parcelablegenerator.ParcelableAction.getPsiClassFromEvent(ParcelableAction.java:82) at cn.nekocode.plugin.parcelablegenerator.ParcelableAction.update(ParcelableAction.java:69) at com.intellij.openapi.actionSystem.AnAction.beforeActionPerformedUpdate(AnAction.java:243) at com.intellij.openapi.actionSystem.ex.ActionUtil.performDumbAwareUpdate(ActionUtil.java:111) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.b(PopupFactoryImpl.java:934) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.b(PopupFactoryImpl.java:924) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.buildGroup(PopupFactoryImpl.java:860) at com.intellij.ui.popup.PopupFactoryImpl$ActionGroupPopup.a(PopupFactoryImpl.java:257) at com.intellij.ui.popup.PopupFactoryImpl$ActionGroupPopup.(PopupFactoryImpl.java:214) at com.intellij.ui.popup.PopupFactoryImpl.a(PopupFactoryImpl.java:194) at com.intellij.ui.popup.PopupFactoryImpl.a(PopupFactoryImpl.java:168) at com.intellij.ui.popup.PopupFactoryImpl.createActionGroupPopup(PopupFactoryImpl.java:296) at com.intellij.codeInsight.generation.actions.GenerateAction.actionPerformed(GenerateAction.java:38) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher$3.performAction(IdeKeyEventDispatcher.java:586) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.processAction(IdeKeyEventDispatcher.java:637) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.d(IdeKeyEventDispatcher.java:476) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.dispatchKeyEvent(IdeKeyEventDispatcher.java:212) at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:538) at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:382) at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:242) at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:161) at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:150) at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:146) at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:138) at java.awt.EventDispatchThread.run(EventDispatchThread.java:91)

java.lang.NoClassDefFoundError: org/jetbrains/kotlin/psi/KtFile at cn.nekocode.plugin.parcelablegenerator.ParcelableAction.getPsiClassFromEvent(ParcelableAction.java:82) at cn.nekocode.plugin.parcelablegenerator.ParcelableAction.update(ParcelableAction.java:69) at com.intellij.openapi.actionSystem.AnAction.beforeActionPerformedUpdate(AnAction.java:243) at com.intellij.openapi.actionSystem.ex.ActionUtil.performDumbAwareUpdate(ActionUtil.java:111) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.b(PopupFactoryImpl.java:934) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.b(PopupFactoryImpl.java:924) at com.intellij.ui.popup.PopupFactoryImpl$ActionStepBuilder.buildGroup(PopupFactoryImpl.java:860) at com.intellij.ui.popup.PopupFactoryImpl$ActionGroupPopup.a(PopupFactoryImpl.java:257) at com.intellij.ui.popup.PopupFactoryImpl$ActionGroupPopup.(PopupFactoryImpl.java:214) at com.intellij.ui.popup.PopupFactoryImpl.a(PopupFactoryImpl.java:194) at com.intellij.ui.popup.PopupFactoryImpl.a(PopupFactoryImpl.java:168) at com.intellij.ui.popup.PopupFactoryImpl.createActionGroupPopup(PopupFactoryImpl.java:296) at com.intellij.codeInsight.generation.actions.GenerateAction.actionPerformed(GenerateAction.java:38) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher$3.performAction(IdeKeyEventDispatcher.java:586) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.processAction(IdeKeyEventDispatcher.java:637) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.d(IdeKeyEventDispatcher.java:476) at com.intellij.openapi.keymap.impl.IdeKeyEventDispatcher.dispatchKeyEvent(IdeKeyEventDispatcher.java:212) at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:538) at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:382) at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:242) at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:161) at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:150) at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:146) at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:138) at java.awt.EventDispatchThread.run(EventDispatchThread.java:91)

opened by sosmolovskii 2
Plagiarism ?

Hello @nekocode and @xorsk I'm just accidentally browse some kotlin plugin through android studio and found that this man also re-publish your plugin with the same name with yours Parcelable Code Generator Hope this information helps both of you.

opened by rhonyabdullah 1
Companion object should be below method declarations

According to the official style guide the companion object should be below the methods: https://github.com/JetBrains/kotlin-web-site/blob/636fe9e9d799eaa1e5c9d02b838f45aab1a13af2/pages/docs/reference/coding-conventions.md#class-layout

Its a small change but would you be able to swap the default layout to match this?
enhancement

opened by REggar 1

Use apply writing values to improve readability

To make the generated code more idiomatic you can use apply to apply things to the same object, sample:

Before:

override fun writeToParcel(dest: Parcel, flags: Int) {
    dest.writeLong(id)
    dest.writeString(firstName)
    dest.writeString(lastName)
    dest.writeString(affiliation)
    dest.writeString(about)
    dest.writeString(city)
    dest.writeString(state)
    dest.writeString(country)
    dest.writeDouble(latitude)
    dest.writeDouble(longitude)
    dest.writeTypedList(subtopics)
    dest.writeInt((if (isTopExpert) 1 else 0))
  }

After:

override fun writeToParcel(dest: Parcel, flags: Int) = dest.apply {
    writeLong(id)
    writeString(firstName)
    writeString(lastName)
    writeString(affiliation)
    writeString(about)
    writeString(city)
    writeString(state)
    writeString(country)
    writeDouble(latitude)
    writeDouble(longitude)
    writeTypedList(subtopics)
    writeInt((if (isTopExpert) 1 else 0))
  }

enhancement

opened by danielgomezrico 1

Deserialization for list parcelable crashes when you call writeTypedList(null) first

Current generated code for list of parcelables will crash if you put an empty list.

Error example

Caused by: java.lang.IllegalStateException: source.createTypedArrayL…(AvatarUrlHolder.CREATOR) must not be null

Example code

class AvatarUrlHolder(val id: Long, val url: String) : Parcelable {

  constructor(source: Parcel) : this(source.readLong(), source.readString())

  override fun describeContents() = 0

  override fun writeToParcel(dest: Parcel, flags: Int) = with(dest) {
    writeLong(id)
    writeString(url)
  }

  companion object {
    @JvmField
    val CREATOR: Parcelable.Creator<AvatarUrlHolder> = object : Parcelable.Creator<AvatarUrlHolder> {
      override fun createFromParcel(source: Parcel): AvatarUrlHolder = AvatarUrlHolder(source)
      override fun newArray(size: Int): Array<AvatarUrlHolder?> = arrayOfNulls(size)
    }
  }

}

// Class that have the list
class People(val avatars: List<AvatarUrlHolder>) : Parcelable {

  constructor(source: Parcel) : this(
    source.createTypedArrayList(AvatarUrlHolder.CREATOR)
  )

  override fun describeContents() = 0

  override fun writeToParcel(dest: Parcel, flags: Int) = with(dest) {
    writeTypedList(agreedExpertsAvatars)
  }

  companion object {
    @JvmField
    val CREATOR: Parcelable.Creator<People> = object : Parcelable.Creator<People> {
      override fun createFromParcel(source: Parcel): People = People(source)
      override fun newArray(size: Int): Array<People?> = arrayOfNulls(size)
    }
  }
}

If you create the people with People(listOf()) the method writeTypedList will crash with:

Caused by: java.lang.IllegalStateException: source.createTypedArrayL…(AvatarUrlHolder.CREATOR) must not be null

Solution

This can be fixed if the generated code in the constructor looks like:

listOf<AvatarUrlHolder>().apply {
  source.readTypedList(this, AvatarUrlHolder.CREATOR)
}

instead of:

source.createTypedArrayList(AvatarUrlHolder.CREATOR)

opened by danielgomezrico 1

Request: allow to use the new androidExtensions way
It's much shorter code:

gradle file:

apply plugin: 'org.jetbrains.kotlin.android.extensions' androidExtensions { experimental = true }

sample code of a class with 3 Dates in it:

@SuppressLint("ParcelCreator") @Parcelize class MonthItem(val today: Date, val startDate: Date, val endDate: Date) : Parcelable { }

The plugin here will only ask us which fields to add there, and which to ignore. Maybe also the order.
opened by AndroidDeveloperLB 0
ClassCastException: org.jetbrains.kotlin.psi.KtAnnotationEntry cannot be cast to org.jetbrains.kotlin.psi.KtParameter

Android Studio 2.3.3 Build #AI-162.4069837, built on June 6, 2017 JRE: 1.8.0_112-release-b06 amd64 JVM: OpenJDK 64-Bit Server VM by JetBrains s.r.o Kotlin version: 1.1.4-3

Plugin is crashing with following stacktrace:

opened by sreejithbnaick 5
Plugin works only with default constructor vars

For some reason your plugin takes into account only vars that are declared in the default constructor and doesn't see any outstanding vars. IMO it's a bug, since some attributes are not supposed to be a part of the constructor, but are supposed to be preserved through Parcelable.
enhancement

opened by n-belokopytov 2
How to get the kotlin-plugin.jar

hi,i want to learn how to develop plugin for kotlin . but when i pull your project , the library about kotlin is not found. like "KtClass" and so on. please tell me how to build this project
question

opened by JDDJJ 3

Releases(0.7.2)

0.7.2(Aug 8, 2017)

Source code(tar.gz)
Source code(zip)
ParcelableGenerator.jar(29.45 KB)
0.7.1(May 2, 2017)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(29.34 KB)
0.7.0(Apr 23, 2017)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(29.38 KB)
0.6.2(Apr 21, 2017)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(30.04 KB)
0.6.1(Mar 10, 2017)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(27.12 KB)
0.6(Nov 9, 2016)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(27.16 KB)
0.5.1(Sep 24, 2016)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(26.06 KB)
0.4.7(Aug 23, 2016)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(25.68 KB)
0.4.6(Jul 10, 2016)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(26.04 KB)
0.4.5(Jul 3, 2016)

Support for kotlin-plugin 1.0.3
Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(26.06 KB)
v0.4.3(Mar 19, 2016)

Now support runing in the jre 6 or jre 7 .
Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(24.70 KB)
v0.4.2(Feb 19, 2016)

It keeps the old declarations in your data class now.
Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(24.77 KB)
v0.4.0(Feb 15, 2016)

Support added for kotlin 1.0-rc.
Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(23.72 KB)
v0.3.11(Feb 3, 2016)

Fixed some issues.
Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(23.68 KB)
v0.3(Feb 3, 2016)

Supported many new types: Parcelable List, Parcelable Array, Array, ByteArray, DoubleArray, FloatArray, IntArray, LongArray, CharArray, BooleanArray, List<*>(no validation)
Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin.jar(23.38 KB)
v0.1(Dec 4, 2015)

Source code(tar.gz)
Source code(zip)
android-parcelable-generator-kotlin-0.1.jar(11.36 KB)

Owner

nekocode

Hack it.

GitHub

Kotlin compiler plugin generates support synthetic methods for use SaveStateHandle without constants and string variables.

SavedState Compiler Plugin Kotlin compiler plugin generates support methods for use SaveStateHandle without constants and string variables. Example If

3 Sep 20, 2022

UTBotJava generates test cases by code, trying to cover maximum statements and execution paths.

UTBotJava generates test cases by code, trying to cover maximum statements and execution paths. We treat source code as source of truth assuming that behavior is correct and corresponds to initial user demand. Generated tests are placed in so-called regression suite