Skip to content

Support using @Json.Ignore on a type #366

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

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions blackbox-test/src/main/java/org/example/customer/IgnoredClass.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package org.example.customer;

import io.avaje.jsonb.Json;
import io.avaje.jsonb.Json.Ignore;
import io.avaje.jsonb.Json.Property;

@Json
@Ignore(serialize = true)
public class IgnoredClass {

private String firstName;

@Json.Ignore private String middleName;

@Property("last")
@Json.Ignore(deserialize = true, serialize = true)
private String lastName;

public IgnoredClass() {}

public IgnoredClass(String firstName, String middleName) {
this.firstName = firstName;
this.middleName = middleName;
}

public String getFirstName() {
return firstName;
}

public IgnoredClass setFirstName(String firstName) {
this.firstName = firstName;
return this;
}

public String getMiddleName() {
return middleName;
}

public String getLastName() {
return lastName;
}

public IgnoredClass setLastName(String lastName) {
this.lastName = lastName;
return this;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package org.example.customer;

import static org.assertj.core.api.Assertions.assertThat;

import org.junit.jupiter.api.Test;

import io.avaje.jsonb.Jsonb;

class IgnoreClassTest {

Jsonb jsonb = Jsonb.builder().build();

@Test
void toJsonFromJson() {
var bean = new IgnoredClass("fn", "mn");
bean.setLastName("ln");

String asJson = jsonb.toJson(bean);
assertThat(asJson).isEqualTo("{\"firstName\":\"fn\",\"last\":\"ln\"}");

var fromJson = jsonb.type(IgnoredClass.class).fromJson(asJson);
assertThat(fromJson.getFirstName()).isNull();
assertThat(fromJson.getLastName()).isNotEmpty();
assertThat(fromJson.getMiddleName()).isNull();
}
}
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
package io.avaje.jsonb.generator;

import java.lang.invoke.MethodHandles;
import java.util.function.Predicate;

import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import java.lang.invoke.MethodHandles;
import java.util.function.Predicate;

final class PropertyIgnoreReader {

Expand All @@ -29,9 +30,14 @@ final class PropertyIgnoreReader {
ignoreSerialize = propertyMethodOverride;

final IgnorePrism ignored = IgnorePrism.getInstanceOn(element);

final IgnorePrism ignoreFromType = IgnorePrism.getInstanceOn(element.getEnclosingElement());
if (ignored != null) {
ignoreDeserialize = !ignored.deserialize();
ignoreSerialize = propertyMethodOverride || !ignored.serialize();
} else if (ignoreFromType != null) {
ignoreDeserialize = !ignoreFromType.deserialize();
ignoreSerialize = propertyMethodOverride || !ignoreFromType.serialize();
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package io.avaje.jsonb.generator.models.valid.ignore;

import io.avaje.jsonb.Json;
import io.avaje.jsonb.Json.Ignore;
import io.avaje.jsonb.Json.Property;

@Json
@Ignore(serialize = true)
public class IgnoredClass {

private String firstName;

@Json.Ignore private String middleName;

@Property("last")
private String lastName;

public IgnoredClass() {}

public IgnoredClass(String firstName, String middleName) {
this.firstName = firstName;
this.middleName = middleName;
}

public String getFirstName() {
return firstName;
}

public IgnoredClass setFirstName(String firstName) {
this.firstName = firstName;
return this;
}

public String getMiddleName() {
return middleName;
}

public String getLastName() {
return lastName;
}

public IgnoredClass setLastName(String lastName) {
this.lastName = lastName;
return this;
}
}
12 changes: 4 additions & 8 deletions jsonb/src/main/java/io/avaje/jsonb/Json.java
Original file line number Diff line number Diff line change
Expand Up @@ -151,18 +151,14 @@
* We can explicitly use {@code serialize=true} to include the property in
* serialization but not deserialization.
*/
@Target(FIELD)
@Target({FIELD, TYPE})
@Retention(SOURCE)
@interface Ignore {

/**
* Set this explicitly to true to include in serialization.
*/
/** Include in serialization. */
boolean serialize() default false;

/**
* Set this explicitly to true to include in deserialization.
*/
/** Include in deserialization. */
boolean deserialize() default false;
}

Expand Down Expand Up @@ -241,7 +237,7 @@
@interface SubType {

/**
* The concrete type that extends or implements the base type.
* Concrete type that extends or implements the base type.
*/
Class<?> type();

Expand Down