https://github.com/zeoflow/parcelled
A fast annotation processor that auto-generates the Parcelable methods without writing them.
https://github.com/zeoflow/parcelled
android-library annotation-processor kapt parcellable parcelled parcelled-compiler parcelled-library parcelled-runtime zeoflow zeoflow-library
Last synced: 15 days ago
JSON representation
A fast annotation processor that auto-generates the Parcelable methods without writing them.
- Host: GitHub
- URL: https://github.com/zeoflow/parcelled
- Owner: zeoflow
- License: apache-2.0
- Created: 2021-03-17T14:42:20.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-21T07:49:22.000Z (almost 5 years ago)
- Last Synced: 2024-05-20T20:07:21.191Z (over 1 year ago)
- Topics: android-library, annotation-processor, kapt, parcellable, parcelled, parcelled-compiler, parcelled-library, parcelled-runtime, zeoflow, zeoflow-library
- Language: Java
- Homepage:
- Size: 220 KB
- Stars: 15
- Watchers: 3
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Parcelled - Android Library
## Intro
A fast annotation processor that auto-generates the Parcelable methods without writing them.
## Getting Started
For information on how to get started Parcelled, take a look at our [Getting Started](docs/getting-started.md) guide.
## Submitting Bugs or Feature Requests
Bugs or feature requests should be submitted at our [GitHub Issues section](https://github.com/zeoflow/parcelled/issues).
## How does it work?
### 1. Depend on our library
Parcelled for Android is available through Google's Maven Repository.
To use it:
1. Open the `build.gradle` file for your application.
2. Make sure that the `repositories` section includes Google's Maven Repository
`google()`. For example:
```groovy
allprojects {
repositories {
google()
jcenter()
}
}
```
3. Add the library to the `dependencies` section:
```groovy
dependencies {
// ...
// parcelled version
def parcelled_version = "1.0.0"
// Java Project
implementation("com.zeoflow:parcelled-runtime:$parcelled_version")
annotationProcessor("com.zeoflow:parcelled-compiler:$parcelled_version")
// Kotlin Project
implementation("com.zeoflow:parcelled-runtime:$parcelled_version")
kapt("com.zeoflow:parcelled-compiler:$parcelled_version")
// ...
}
```
### 2. Usage
#### 2.1 Import
```java
import com.zeoflow.parcelled.Default;
import com.zeoflow.parcelled.Parcelled;
import com.zeoflow.parcelled.ParcelledAdapter;
import com.zeoflow.parcelled.ParcelledVersion;
```
#### 2.2 Class Declaration
```java
@Parcelled(version = 1)
public abstract class CustomBean implements Parcelable {
@Nullable
@Default(code = "null")
public String firstName;
@ParcelledVersion(after = 1, before = 2)
@Nullable
public String lastName;
@ParcelledAdapter(DateTypeAdapter.class)
@ParcelledVersion(before = 1)
@Default(code = "new Date()")
public Date birthday;
public static CustomBean create(
@NonNull String firstName,
@NonNull String lastName,
@NonNull Date birthday
) {
return new Parcelled_Person(firstName, lastName, birthday);
}
}
```
## License
Copyright 2020 ZeoFlow
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.
## 🏆 Contributors 🏆
