Package org.apache.juneau.marshall

Class MarshallingContext.Builder

java.lang.Object
org.apache.juneau.marshall.Context.Builder<MarshallingContext.Builder>
org.apache.juneau.marshall.MarshallingContext.Builder
Enclosing class:
MarshallingContext
public static class MarshallingContext.Builder extends Context.Builder<MarshallingContext.Builder>
Builder class.

  • Constructor Details

  • Method Details

    • beanClassVisibility

      public MarshallingContext.Builder beanClassVisibility(Visibility value)
      Minimum bean class visibility.

      Classes are not considered beans unless they meet the minimum visibility requirements. For example, if the visibility is PUBLIC and the bean class is protected, then the class will not be interpreted as a bean class and be serialized as a string. Use this setting to reduce the visibility requirement.

      Example:

      // A bean with a protected class and one field. protected class MyBean { public String foo = "bar"; } // Create a serializer that's capable of serializing the class. WriterSerializer serializer = JsonSerializer .create() .beanClassVisibility(PROTECTED) .build(); // Produces: {"foo","bar"} String json = serializer.write(new MyBean());

      Notes:
      • The @Marshalled annotation can be used on a non-public bean class to override this setting.
      • The @BeanIgnore annotation can also be used on a public bean class to ignore it as a bean.
      See Also:
      Parameters:
      value - The new value for this setting.
      The default is Visibility.PUBLIC.
      Cannot be null.
      Returns:
      This object.

    • beanConstructorVisibility

      public MarshallingContext.Builder beanConstructorVisibility(Visibility value)
      Minimum bean constructor visibility.

      Only look for constructors with the specified minimum visibility.

      This setting affects the logic for finding no-arg constructors for bean. Normally, only public no-arg constructors are used. Use this setting if you want to reduce the visibility requirement.

      Example:

      // A bean with a protected constructor and one field. public class MyBean { public String foo; protected MyBean() {} } // Create a parser capable of calling the protected constructor. ReaderParser parser = ReaderParser .create() .beanConstructorVisibility(PROTECTED) .build(); // Use it. MyBean myBean = parser.read("{foo:'bar'}", MyBean.class);

      Notes:
      • The @BeanCtor annotation can also be used to expose a non-public constructor.
      • The @BeanIgnore annotation can also be used on a public bean constructor to ignore it.
      See Also:
      Parameters:
      value - The new value for this setting.
      The default is Visibility.PUBLIC.
      Cannot be null.
      Returns:
      This object.

    • beanDictionary

      public List<ClassInfo> beanDictionary()
      Returns the bean dictionary list.

      Gives access to the inner list if you need to make more than simple additions via beanDictionary(Class...).

      Returns:
      The bean dictionary list.
      See Also:

    • beanDictionary

      public MarshallingContext.Builder beanDictionary(Class<?>... values)
      Convenience method for beanDictionary(ClassInfo...) that accepts Class objects.
      Parameters:
      values - The values to add to this setting.
      Cannot contain null values.
      Returns:
      This object.
      See Also:

    • beanDictionary

      public MarshallingContext.Builder beanDictionary(ClassInfo... values)
      Bean dictionary.

      The list of classes that make up the bean dictionary in this bean context.

      Values are prepended to the list so that later calls can override classes of earlier calls.

      A dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred through reflection. The names are defined through the @Marshalled(typeName) annotation defined on the bean class. For example, if a class Foo has a type-name of "myfoo", then it would end up serialized as "{_type:'myfoo',...}" in JSON or "<myfoo>...</myfoo>" in XML.

      This setting tells the parsers which classes to look for when resolving "_type" attributes.

      Values can consist of any of the following types:

      • Any bean class that specifies a value for @Marshalled(typeName).
      • Any subclass of BeanDictionaryList containing a collection of bean classes with type name annotations.
      • Any subclass of BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
      • Any array or collection of the objects above.
      Example:

      // POJOs with @Marshalled(name) annotations. @Marshalled(typeName="foo") public class Foo {...} @Marshalled(typeName="bar") public class Bar {...} // Create a parser and tell it which classes to try to resolve. ReaderParser parser = JsonParser .create() .dictionary(Foo.class, Bar.class) .addBeanTypes() .build(); // A bean with a field with an indeterminate type. public class MyBean { public Object mySimpleField; } // Parse bean. MyBean myBean = parser.read("{mySimpleField:{_type:'foo',...}}", MyBean.class);

      Another option is to use the Marshalled.dictionary() annotation on the POJO class itself:

      // Instead of by parser, define a bean dictionary on a class through an annotation. // This applies to all properties on this class and all subclasses. @Marshalled(dictionary={Foo.class,Bar.class}) public class MyBean { public Object mySimpleField; // May contain Foo or Bar object. public Map<String,Object> myMapField; // May contain Foo or Bar objects. }

      A typical usage is to allow for HTML documents to be parsed back into HTML beans:

      // Use the predefined HTML5 bean dictionary which is a BeanDictionaryList. ReaderParser parser = HtmlParser .create() .dictionary(HtmlBeanDictionary.class) .build(); // Parse an HTML body into HTML beans. Body body = parser.read("<body><ul><li>foo</li><li>bar</li></ul>", Body.class);

      See Also:
      Parameters:
      values - The values to add to this setting.
      Cannot contain null values.
      Returns:
      This object.

    • beanDictionary

      public MarshallingContext.Builder beanDictionary(Collection<ClassInfo> values)
      Same as beanDictionary(ClassInfo...) but allows you to pass in a collection of class info objects.
      Parameters:
      values - The values to add to this setting.
      Cannot be null or contain null values.
      Returns:
      This object.
      See Also:

    • beanFieldVisibility

      public MarshallingContext.Builder beanFieldVisibility(Visibility value)
      Minimum bean field visibility.

      Only look for bean fields with the specified minimum visibility.

      This affects which fields on a bean class are considered bean properties. Normally only public fields are considered. Use this setting if you want to reduce the visibility requirement.

      Example:

      // A bean with a protected field. public class MyBean { protected String foo = "bar"; } // Create a serializer that recognizes the protected field. WriterSerializer serializer = JsonSerializer .create() .beanFieldVisibility(PROTECTED) .build(); // Produces: {"foo":"bar"} String json = serializer.write(new MyBean());

      Bean fields can be ignored as properties entirely by setting the value to Visibility.NONE

      // Disable using fields as properties entirely. WriterSerializer serializer = JsonSerializer .create() .beanFieldVisibility(NONE) .build();

      Notes:
      • The @BeanProp annotation can also be used to expose a non-public field.
      • The @BeanIgnore annotation can also be used on a public bean field to ignore it as a bean property.
      See Also:
      Parameters:
      value - The new value for this setting.
      The default is Visibility.PUBLIC.
      Cannot be null.
      Returns:
      This object.

    • beanInterceptor

      public MarshallingContext.Builder beanInterceptor(Class<?> on, Class<? extends BeanInterceptor<?>> value)
      Bean interceptor.

      Bean interceptors can be used to intercept calls to getters and setters and alter their values in transit.

      Example:

      // Interceptor that strips out sensitive information. public class AddressInterceptor extends BeanInterceptor<Address> { public Object readProperty(Address bean, String name, Object value) { if ("taxInfo".equals(name)) return "redacted"; return value; } public Object writeProperty(Address bean, String name, Object value) { if ("taxInfo".equals(name) && "redacted".equals(value)) return TaxInfoUtils.lookup(bean.getStreet(), bean.getCity(), bean.getState()); return value; } } // Our bean class. public class Address { public String getTaxInfo() {...} public void setTaxInfo(String value) {...} } // Register filter on serializer or parser. WriterSerializer serializer = JsonSerializer .create() .beanInterceptor(Address.class, AddressInterceptor.class) .build(); // Produces: {"taxInfo":"redacted"} String json = serializer.write(new Address());

      See Also:
      Parameters:
      on - The bean that the filter applies to.
      Cannot be null.
      value - The new value for this setting.
      Cannot be null.
      Returns:
      This object.

    • beanMapPutReturnsOldValue

      public MarshallingContext.Builder beanMapPutReturnsOldValue()
      BeanMap.put() returns old property value.

      When enabled, then the BeanMap.put() method will return old property values. Otherwise, it returns null.

      Disabled by default because it introduces a slight performance penalty during serialization.

      Example:

      // Create a context that creates BeanMaps with normal put() behavior. MarshallingContext context = MarshallingContext .create() .beanMapPutReturnsOldValue() .build(); BeanMap<MyBean> myBeanMap = context.createSession().toBeanMap(new MyBean()); myBeanMap.put("foo", "bar"); Object oldValue = myBeanMap.put("foo", "baz"); // oldValue == "bar"

      See Also:
      Returns:
      This object.

    • beanMapPutReturnsOldValue

      public MarshallingContext.Builder beanMapPutReturnsOldValue(boolean value)
      Same as beanMapPutReturnsOldValue() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • beanMethodVisibility

      public MarshallingContext.Builder beanMethodVisibility(Visibility value)
      Minimum bean method visibility.

      Only look for bean methods with the specified minimum visibility.

      This affects which methods are detected as getters and setters on a bean class. Normally only public getters and setters are considered. Use this setting if you want to reduce the visibility requirement.

      Example:

      // A bean with a protected getter. public class MyBean { public String getFoo() { return "foo"; } protected String getBar() { return "bar"; } } // Create a serializer that looks for protected getters and setters. WriterSerializer serializer = JsonSerializer .create() .beanMethodVisibility(PROTECTED) .build(); // Produces: {"foo":"foo","bar":"bar"} String json = serializer.write(new MyBean());

      Notes:
      • The @BeanProp annotation can also be used to expose a non-public method.
      • The @BeanIgnore annotation can also be used on a public bean getter/setter to ignore it as a bean property.
      See Also:
      Parameters:
      value - The new value for this setting.
      The default is Visibility.PUBLIC
      Returns:
      This object.

    • beanProperties

      public MarshallingContext.Builder beanProperties(Class<?> beanClass, String properties)
      Bean property includes.

      Specifies the set and order of names of properties associated with the bean class.

      For example, beanProperties(MyBean.class, "foo,bar") means only serialize the foo and bar properties on the specified bean. Likewise, parsing will ignore any bean properties not specified and either throw an exception or silently ignore them depending on whether ignoreUnknownBeanProperties() has been called.

      This value is entirely optional if you simply want to expose all the getters and public fields on a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code, whereas on Oracle JREs, the order is entirely random.

      Setting applies to specified class and all subclasses.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo = "foo", bar = "bar", baz = "baz"; } // Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .beanProperties(MyBean.class, "foo,bar") .build(); // Produces: {"foo":"foo","bar":"bar"} String json = serializer.write(new MyBean());

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClass).properties(properties).build());

      See Also:
      Parameters:
      beanClass - The bean class.
      Cannot be null.
      properties - Comma-delimited list of property names.
      Cannot be null.
      Returns:
      This object.

    • beanProperties

      public MarshallingContext.Builder beanProperties(Map<String,Object> values)
      Bean property includes.

      Specifies the set and order of names of properties associated with bean classes.

      For example, beanProperties(AMap.of("MyBean", "foo,bar")) means only serialize the foo and bar properties on the specified bean. Likewise, parsing will ignore any bean properties not specified and either throw an exception or silently ignore them depending on whether ignoreUnknownBeanProperties() has been called.

      This value is entirely optional if you simply want to expose all the getters and public fields on a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code, whereas on Oracle JREs, the order is entirely random.

      Setting applies to specified class and all subclasses.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo = "foo", bar = "bar", baz = "baz"; } // Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .beanProperties(AMap.of("MyBean", "foo,bar")) .build(); // Produces: {"foo":"foo","bar":"bar"} String json = serializer.write(new MyBean());

      This method is functionally equivalent to the following code for each entry:

      builder.annotations(MarshalledAnnotation.create(key).properties(value.toString()).build());

      See Also:
      Parameters:
      values - The values to add to this builder.
      Keys are bean class names which can be a simple name, fully-qualified name, or "*" for all beans.
      Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.
      Cannot be null.
      Returns:
      This object.

    • beanProperties

      public MarshallingContext.Builder beanProperties(String beanClassName, String properties)
      Bean property includes.

      Specifies the set and order of names of properties associated with the bean class.

      For example, beanProperties("MyBean", "foo,bar") means only serialize the foo and bar properties on the specified bean. Likewise, parsing will ignore any bean properties not specified and either throw an exception or silently ignore them depending on whether ignoreUnknownBeanProperties() has been called.

      This value is entirely optional if you simply want to expose all the getters and public fields on a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code, whereas on Oracle JREs, the order is entirely random.

      Setting applies to specified class and all subclasses.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo = "foo", bar = "bar", baz = "baz"; } // Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .beanProperties("MyBean", "foo,bar") .build(); // Produces: {"foo":"foo","bar":"bar"} String json = serializer.write(new MyBean());

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClassName).properties(properties).build());

      See Also:
      Parameters:
      beanClassName - The bean class name.
      Can be a simple name, fully-qualified name, or "*" for all beans.
      properties - Comma-delimited list of property names.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesExcludes

      public MarshallingContext.Builder beanPropertiesExcludes(Class<?> beanClass, String properties)
      Bean property excludes.

      Specifies to exclude the specified list of properties for the specified bean class.

      Same as beanProperties(Class, String) except you specify a list of bean property names that you want to exclude from serialization.

      Setting applies to specified class and all subclasses.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo = "foo", bar = "bar", baz = "baz"; } // Create a serializer that excludes the "bar" and "baz" properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesExcludes(MyBean.class, "bar,baz") .build(); // Produces: {"foo":"foo"} String json = serializer.write(new MyBean());

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClass).excludeProperties(properties).build());

      See Also:
      Parameters:
      beanClass - The bean class.
      Cannot be null.
      properties - Comma-delimited list of property names.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesExcludes

      public MarshallingContext.Builder beanPropertiesExcludes(Map<String,Object> values)
      Bean property excludes.

      Specifies to exclude the specified list of properties for the specified bean classes.

      Same as beanProperties(Map) except you specify a list of bean property names that you want to exclude from serialization.

      Setting applies to specified class and all subclasses.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo = "foo", bar = "bar", baz = "baz"; } // Create a serializer that excludes the "bar" and "baz" properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesExcludes(AMap.of("MyBean", "bar,baz")) .build(); // Produces: {"foo":"foo"} String json = serializer.write(new MyBean());

      This method is functionally equivalent to the following code for each entry:

      builder.annotations(MarshalledAnnotation.create(key).excludeProperties(value.toString()).build());

      See Also:
      Parameters:
      values - The values to add to this builder.
      Keys are bean class names which can be a simple name, fully-qualified name, or "*" for all beans.
      Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesExcludes

      public MarshallingContext.Builder beanPropertiesExcludes(String beanClassName, String properties)
      Bean property excludes.

      Specifies to exclude the specified list of properties for the specified bean class.

      Same as beanPropertiesExcludes(String, String) except you specify a list of bean property names that you want to exclude from serialization.

      Setting applies to specified class and all subclasses.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo = "foo", bar = "bar", baz = "baz"; } // Create a serializer that excludes the "bar" and "baz" properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesExcludes("MyBean", "bar,baz") .build(); // Produces: {"foo":"foo"} String json = serializer.write(new MyBean());

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClassName).excludeProperties(properties).build());

      See Also:
      Parameters:
      beanClassName - The bean class name.
      Can be a simple name, fully-qualified name, or "*" for all bean classes.
      Cannot be null.
      properties - Comma-delimited list of property names.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesReadOnly

      public MarshallingContext.Builder beanPropertiesReadOnly(Class<?> beanClass, String properties)
      Read-only bean properties.

      Specifies one or more properties on a bean that are read-only despite having valid getters. Serializers will serialize such properties as usual, but parsers will silently ignore them. Note that this is different from the beanProperties/beanPropertiesExcludes settings which include or exclude properties for both serializers and parsers.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo, bar, baz; } // Create a serializer with read-only property settings. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesReadOnly(MyBean.class, "bar,baz") .build(); // All 3 properties will be serialized. String json = serializer.write(new MyBean()); // Create a parser with read-only property settings. ReaderParser parser = JsonParser .create() .beanPropertiesReadOnly(MyBean.class, "bar,baz") .ignoreUnknownBeanProperties() .build(); // Parser ignores bar and baz properties. MyBean myBean = parser.read("{foo:'foo',bar:'bar',baz:'baz'}", MyBean.class);

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClass).readOnlyProperties(properties).build());

      See Also:
      Parameters:
      beanClass - The bean class.
      Cannot be null.
      properties - Comma-delimited list of property names.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesReadOnly

      public MarshallingContext.Builder beanPropertiesReadOnly(Map<String,Object> values)
      Read-only bean properties.

      Specifies one or more properties on beans that are read-only despite having valid getters. Serializers will serialize such properties as usual, but parsers will silently ignore them. Note that this is different from the beanProperties/beanPropertiesExcludes settings which include or exclude properties for both serializers and parsers.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo, bar, baz; } // Create a serializer with read-only property settings. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesReadOnly(AMap.of("MyBean", "bar,baz")) .build(); // All 3 properties will be serialized. String json = serializer.write(new MyBean()); // Create a parser with read-only property settings. ReaderParser parser = JsonParser .create() .beanPropertiesReadOnly(AMap.of("MyBean", "bar,baz")) .ignoreUnknownBeanProperties() .build(); // Parser ignores bar and baz properties. MyBean myBean = parser.read("{foo:'foo',bar:'bar',baz:'baz'}", MyBean.class);

      This method is functionally equivalent to the following code for each entry:

      builder.annotations(MarshalledAnnotation.create(key).readOnlyProperties(value.toString()).build());

      See Also:
      Parameters:
      values - The values to add to this builder.
      Keys are bean class names which can be a simple name, fully-qualified name, or "*" for all beans.
      Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesReadOnly

      public MarshallingContext.Builder beanPropertiesReadOnly(String beanClassName, String properties)
      Read-only bean properties.

      Specifies one or more properties on a bean that are read-only despite having valid getters. Serializers will serialize such properties as usual, but parsers will silently ignore them. Note that this is different from the beanProperties/beanPropertiesExcludes settings which include or exclude properties for both serializers and parsers.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo, bar, baz; } // Create a serializer with read-only property settings. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesReadOnly("MyBean", "bar,baz") .build(); // All 3 properties will be serialized. String json = serializer.write(new MyBean()); // Create a parser with read-only property settings. ReaderParser parser = JsonParser .create() .beanPropertiesReadOnly("MyBean", "bar,baz") .ignoreUnknownBeanProperties() .build(); // Parser ignores bar and baz properties. MyBean myBean = parser.read("{foo:'foo',bar:'bar',baz:'baz'}", MyBean.class);

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClassName).readOnlyProperties(properties).build());

      See Also:
      Parameters:
      beanClassName - The bean class name.
      Can be a simple name, fully-qualified name, or "*" for all bean classes.
      properties - Comma-delimited list of property names.
      Returns:
      This object.

    • beanPropertiesWriteOnly

      public MarshallingContext.Builder beanPropertiesWriteOnly(Class<?> beanClass, String properties)
      Write-only bean properties.

      Specifies one or more properties on a bean that are write-only despite having valid setters. Parsers will parse such properties as usual, but serializers will silently ignore them. Note that this is different from the beanProperties/beanPropertiesExcludes settings which include or exclude properties for both serializers and parsers.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo, bar, baz; } // Create a serializer with write-only property settings. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesWriteOnly(MyBean.class, "bar,baz") .build(); // Only foo will be serialized. String json = serializer.write(new MyBean()); // Create a parser with write-only property settings. ReaderParser parser = JsonParser .create() .beanPropertiesWriteOnly(MyBean.class, "bar,baz") .build(); // Parser parses all 3 properties. MyBean myBean = parser.read("{foo:'foo',bar:'bar',baz:'baz'}", MyBean.class);

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClass).writeOnlyProperties(properties).build());

      See Also:
      Parameters:
      beanClass - The bean class.
      Cannot be null.
      properties - Comma-delimited list of property names.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesWriteOnly

      public MarshallingContext.Builder beanPropertiesWriteOnly(Map<String,Object> values)
      Write-only bean properties.

      Specifies one or more properties on a bean that are write-only despite having valid setters. Parsers will parse such properties as usual, but serializers will silently ignore them. Note that this is different from the beanProperties/beanPropertiesExcludes settings which include or exclude properties for both serializers and parsers.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo, bar, baz; } // Create a serializer with write-only property settings. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesWriteOnly(AMap.of("MyBean", "bar,baz")) .build(); // Only foo will be serialized. String json = serializer.write(new MyBean()); // Create a parser with write-only property settings. ReaderParser parser = JsonParser .create() .beanPropertiesWriteOnly(AMap.of("MyBean", "bar,baz")) .build(); // Parser parses all 3 properties. MyBean myBean = parser.read("{foo:'foo',bar:'bar',baz:'baz'}", MyBean.class);

      This method is functionally equivalent to the following code for each entry:

      builder.annotations(MarshalledAnnotation.create(key).writeOnlyProperties(value.toString()).build());

      See Also:
      Parameters:
      values - The values to add to this builder.
      Keys are bean class names which can be a simple name, fully-qualified name, or "*" for all beans.
      Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.
      Cannot be null.
      Returns:
      This object.

    • beanPropertiesWriteOnly

      public MarshallingContext.Builder beanPropertiesWriteOnly(String beanClassName, String properties)
      Write-only bean properties.

      Specifies one or more properties on a bean that are write-only despite having valid setters. Parsers will parse such properties as usual, but serializers will silently ignore them. Note that this is different from the beanProperties/beanPropertiesExcludes settings which include or exclude properties for both serializers and parsers.

      Example:

      // A bean with 3 properties. public class MyBean { public String foo, bar, baz; } // Create a serializer with write-only property settings. WriterSerializer serializer = JsonSerializer .create() .beanPropertiesWriteOnly("MyBean", "bar,baz") .build(); // Only foo will be serialized. String json = serializer.write(new MyBean()); // Create a parser with write-only property settings. ReaderParser parser = JsonParser .create() .beanPropertiesWriteOnly("MyBean", "bar,baz") .build(); // Parser parses all 3 properties. MyBean myBean = parser.read("{foo:'foo',bar:'bar',baz:'baz'}", MyBean.class);

      This method is functionally equivalent to the following code:

      builder.annotations(MarshalledAnnotation.create(beanClassName).writeOnlyProperties(properties).build());

      See Also:
      Parameters:
      beanClassName - The bean class name.
      Can be a simple name, fully-qualified name, or "*" for all bean classes.
      properties - Comma-delimited list of property names.
      Returns:
      This object.

    • beansRequireDefaultConstructor

      public MarshallingContext.Builder beansRequireDefaultConstructor()
      Beans require no-arg constructors.

      When enabled, a Java class must implement a default no-arg constructor to be considered a bean. Otherwise, the bean will be serialized as a string using the Object.toString() method.

      Example:

      // A bean without a no-arg constructor. public class MyBean { // A property method. public String foo = "bar"; // A no-arg constructor public MyBean(String foo) { this.foo = foo; } @Override public String toString() { return "bar"; } } // Create a serializer that ignores beans without default constructors. WriterSerializer serializer = JsonSerializer .create() .beansRequireDefaultConstructor() .build(); // Produces: "bar" String json = serializer.write(new MyBean());

      Notes:
      • The @Marshalled annotation can be used on a bean class to override this setting.
      • The @BeanIgnore annotation can also be used on a class to ignore it as a bean.
      See Also:
      Returns:
      This object.

    • beansRequireDefaultConstructor

      public MarshallingContext.Builder beansRequireDefaultConstructor(boolean value)
      Same as beansRequireDefaultConstructor() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • beansRequireSerializable

      public MarshallingContext.Builder beansRequireSerializable()
      Beans require Serializable interface.

      When enabled, a Java class must implement the Serializable interface to be considered a bean. Otherwise, the bean will be serialized as a string using the Object.toString() method.

      Example:

      // A bean without a Serializable interface. public class MyBean { // A property method. public String foo = "bar"; @Override public String toString() { return "bar"; } } // Create a serializer that ignores beans not implementing Serializable. WriterSerializer serializer = JsonSerializer .create() .beansRequireSerializable() .build(); // Produces: "bar" String json = serializer.write(new MyBean());

      Notes:
      • The @Marshalled annotation can be used on a bean class to override this setting.
      • The @BeanIgnore annotation can also be used on a class to ignore it as a bean.
      See Also:
      Returns:
      This object.

    • beansRequireSerializable

      public MarshallingContext.Builder beansRequireSerializable(boolean value)
      Same as beansRequireSerializable() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • beansRequireSettersForGetters

      public MarshallingContext.Builder beansRequireSettersForGetters()
      Beans require setters for getters.

      When enabled, ignore read-only properties (properties with getters but not setters).

      Example:

      // A bean without a Serializable interface. public class MyBean { // A read/write property. public String getFoo() { return "foo"; } public void setFoo(String foo) { ... } // A read-only property. public String getBar() { return "bar"; } } // Create a serializer that ignores bean properties without setters. WriterSerializer serializer = JsonSerializer .create() .beansRequireSettersForGetters() .build(); // Produces: {"foo":"foo"} String json = serializer.write(new MyBean());

      Notes:
      • The @BeanProp annotation can be used on the getter to override this setting.
      • The @BeanIgnore annotation can also be used on getters to ignore them as bean properties.
      Returns:
      This object.

    • beansRequireSettersForGetters

      public MarshallingContext.Builder beansRequireSettersForGetters(boolean value)
      Same as beansRequireSettersForGetters() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • beanStore

      public MarshallingContext.Builder beanStore(BeanStore value)
      Sets the bean store used for factory-based instantiation.

      The bean store is used to resolve BeanFactory instances registered via @BeanType(factory=X.class) and @BeanProp(factory=X.class) annotations. When a factory class is encountered, the framework first looks it up in the bean store before attempting direct instantiation.

      Typically set to a SpringBeanStore wrapping the application's ApplicationContext so that Spring-managed factories are resolved automatically.

      Example:

      public class MyRestServlet extends BasicRestServlet { @Autowired ApplicationContext ctx; @Override protected MarshallingContext createBeanContext(MarshallingContext.Builder<?> builder) { return builder.beanStore(new SpringBeanStore(ctx)).build(); } }

      Parameters:
      value - The bean store, or null to use direct instantiation only.
      Returns:
      This object.

    • build

      public MarshallingContext build()
      Description copied from class: Context.Builder
      Build the object.
      Overrides:
      build in class Context.Builder<MarshallingContext.Builder>
      Returns:
      The built object.

    • copy

      public MarshallingContext.Builder copy()
      Description copied from class: Context.Builder
      Copy creator.
      Specified by:
      copy in class Context.Builder<MarshallingContext.Builder>
      Returns:
      A new mutable copy of this builder.

    • copyOrNull

      public static MarshallingContext.Builder copyOrNull(MarshallingContext.Builder value)
      Null-safe copy: returns a deep copy of the specified value, or null if the value is null.
      Parameters:
      value - The value to copy. Can be null (returns null).
      Returns:
      A copy of the value, or null if the value was null.

    • dictionaryOn

      public MarshallingContext.Builder dictionaryOn(Class<?> on, Class<?>... values)
      Bean dictionary.

      This is identical to beanDictionary(Class...), but specifies a dictionary within the context of a single class as opposed to globally.

      Example:

      // POJOs with @Marshalled(name) annotations. @Marshalled(typeName="foo") public class Foo {...} @Marshalled(typeName="bar") public class Bar {...} // A bean with a field with an indeterminate type. public class MyBean { public Object mySimpleField; } // Create a parser and tell it which classes to try to resolve. ReaderParser parser = JsonParser .create() .dictionaryOn(MyBean.class, Foo.class, Bar.class) .build(); // Parse bean. MyBean myBean = parser.read("{mySimpleField:{_type:'foo',...}}", MyBean.class);

      This is functionally equivalent to the Marshalled.dictionary() annotation.

      See Also:
      Parameters:
      on - The class that the dictionary values apply to.
      values - The new values for this setting.
      Returns:
      This object.

    • disableBeansRequireSomeProperties

      public MarshallingContext.Builder disableBeansRequireSomeProperties()
      Beans don't require at least one property.

      When enabled, then a Java class doesn't need to contain at least 1 property to be considered a bean. Otherwise, the bean will be serialized as a string using the Object.toString() method.

      The @Marshalled annotation can be used on a class to override this setting when true.

      Example:

      // A bean with no properties. public class MyBean { } // Create a serializer that serializes beans even if they have zero properties. WriterSerializer serializer = JsonSerializer .create() .disableBeansRequireSomeProperties() .build(); // Produces: {} String json = serializer.write(new MyBean());

      Notes:
      • The @Marshalled annotation can be used on the class to force it to be recognized as a bean class even if it has no properties.
      See Also:
      Returns:
      This object.

    • disableBeansRequireSomeProperties

      public MarshallingContext.Builder disableBeansRequireSomeProperties(boolean value)
      Same as disableBeansRequireSomeProperties() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • disableIgnoreMissingSetters

      public MarshallingContext.Builder disableIgnoreMissingSetters()
      Don't silently ignore missing setters.

      When enabled, trying to set a value on a bean property without a setter will throw a BeanRuntimeException. Otherwise, it will be silently ignored.

      Example:

      // A bean with a property with a getter but not a setter. public class MyBean { public void getFoo() { return "foo"; } } // Create a parser that throws an exception if a setter is not found but a getter is. ReaderParser parser = JsonParser .create() .disableIgnoreMissingSetters() .build(); // Throws a ParseException. MyBean myBean = parser.read("{foo:'bar'}", MyBean.class);

      Notes:
      • The @BeanIgnore annotation can also be used on getters and fields to ignore them.
      See Also:
      Returns:
      This object.

    • disableIgnoreMissingSetters

      public MarshallingContext.Builder disableIgnoreMissingSetters(boolean value)
      Same as disableIgnoreMissingSetters() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • disableIgnoreTransientFields

      public MarshallingContext.Builder disableIgnoreTransientFields()
      Don't ignore transient fields.

      When enabled, methods and fields marked as transient will not be ignored as bean properties.

      Example:

      // A bean with a transient field. public class MyBean { public transient String foo = "foo"; } // Create a serializer that doesn't ignore transient fields. WriterSerializer serializer = JsonSerializer .create() .disableIgnoreTransientFields() .build(); // Produces: {"foo":"foo"} String json = serializer.write(new MyBean());

      Notes:
      • The @BeanProp annotation can also be used on transient fields to keep them from being ignored.
      See Also:
      Returns:
      This object.

    • disableIgnoreTransientFields

      public MarshallingContext.Builder disableIgnoreTransientFields(boolean value)
      Same as disableIgnoreTransientFields() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • disableIgnoreUnknownNullBeanProperties

      public MarshallingContext.Builder disableIgnoreUnknownNullBeanProperties()
      Don't ignore unknown properties with null values.

      When enabled, trying to set a null value on a non-existent bean property will throw a BeanRuntimeException. Otherwise it will be silently ignored.

      Example:

      // A bean with a single property. public class MyBean { public String foo; } // Create a parser that throws an exception on an unknown property even if the value being set is null. ReaderParser parser = JsonParser .create() .disableIgnoreUnknownNullBeanProperties() .build(); // Throws a BeanRuntimeException wrapped in a ParseException on the unknown 'bar' property. MyBean myBean = parser.read("{foo:'foo',bar:null}", MyBean.class);

      See Also:
      Returns:
      This object.

    • disableIgnoreUnknownNullBeanProperties

      public MarshallingContext.Builder disableIgnoreUnknownNullBeanProperties(boolean value)
      Same as disableIgnoreUnknownNullBeanProperties() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • disableInterfaceProxies

      public MarshallingContext.Builder disableInterfaceProxies()
      Don't use interface proxies.

      When enabled, interfaces will be instantiated as proxy classes through the use of an InvocationHandler if there is no other way of instantiating them. Otherwise, throws a BeanRuntimeException.

      See Also:
      Returns:
      This object.

    • disableInterfaceProxies

      public MarshallingContext.Builder disableInterfaceProxies(boolean value)
      Same as disableInterfaceProxies() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • example

      public <T> MarshallingContext.Builder example(Class<T> pojoClass, String json)
      POJO example.

      Specifies an example in JSON of the specified class.

      Examples are used in cases such as POJO examples in Swagger documents.

      Setting applies to specified class and all subclasses.

      Example:

      // Create a serializer that excludes the 'foo' and 'bar' properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .example(MyBean.class, "{foo:'bar'}") .build();

      This is a shorthand method for the following code:

      builder.annotations(MarshalledAnnotation.create(pojoClass).example(json).build())

      POJO examples can also be defined on classes via the following:

      See Also:
      Type Parameters:
      T - The POJO class type.
      Parameters:
      pojoClass - The POJO class.
      Cannot be null.
      json - The JSON 5 representation of the example.
      Can be null or empty (treated as no example).
      Returns:
      This object.

    • example

      public <T> MarshallingContext.Builder example(Class<T> pojoClass, T o)
      POJO example.

      Specifies an example of the specified class.

      Examples are used in cases such as POJO examples in Swagger documents.

      Example:

      // Create a serializer that excludes the 'foo' and 'bar' properties on the MyBean class. WriterSerializer serializer = JsonSerializer .create() .example(MyBean.class, new MyBean().setFoo("foo").setBar(123)) .build();

      This is a shorthand method for the following code:

      builder.annotations(MarshalledAnnotation.create(pojoClass).example(Json5.DEFAULT.toString(object)).build())

      Notes:
      • Using this method assumes the serialized form of the object is the same as that produced by the default serializer. This may not be true based on settings or swaps on the constructed serializer.

      POJO examples can also be defined on classes via the following:

      Type Parameters:
      T - The POJO class.
      Parameters:
      pojoClass - The POJO class.
      Cannot be null.
      o - An instance of the POJO class used for examples.
      Can be null (will be serialized as "null").
      Returns:
      This object.

    • findFluentSetters

      public MarshallingContext.Builder findFluentSetters()
      Find fluent setters.

      When enabled, fluent setters are detected on beans during parsing.

      Fluent setters must have the following attributes:

      • Public.
      • Not static.
      • Take in one parameter.
      • Return the bean itself.
      Example:

      // A bean with a fluent setter. public class MyBean { public MyBean foo(String value) {...} } // Create a parser that finds fluent setters. ReaderParser parser = JsonParser .create() .findFluentSetters() .build(); // Parse into bean using fluent setter. MyBean myBean = parser.read("{foo:'bar'}");

      Notes:
      • The @BeanProp annotation can also be used on methods to individually identify them as fluent setters.
      • The @BeanType.findFluentSetters() annotation can also be used on classes to specify to look for fluent setters.
      See Also:
      Returns:
      This object.

    • findFluentSetters

      public MarshallingContext.Builder findFluentSetters(boolean value)
      Same as findFluentSetters() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • findFluentSetters

      public MarshallingContext.Builder findFluentSetters(Class<?> on)
      Find fluent setters.

      Identical to findFluentSetters() but enables it on a specific class only.

      Example:

      // A bean with a fluent setter. public class MyBean { public MyBean foo(String value) {...} } // Create a parser that finds fluent setters. ReaderParser parser = JsonParser .create() .findFluentSetters(MyBean.class) .build(); // Parse into bean using fluent setter. MyBean myBean = parser.read("{foo:'bar'}");

      Notes:
      See Also:
      Parameters:
      on - The class that this applies to.
      Cannot be null.
      Returns:
      This object.

    • hashKey

      public HashKey hashKey()
      Description copied from class: Context.Builder
      Returns the hashkey of this builder.

      Used to return previously instantiated context beans that have matching hashkeys. The HashKey object is suitable for use as a hashmap key of a map of context beans. A context bean is considered equivalent if the HashKey.equals(Object) method is the same.

      Overrides:
      hashKey in class Context.Builder<MarshallingContext.Builder>
      Returns:
      The hashkey of this builder.

    • activeView

      public MarshallingContext.Builder activeView(String value)
      Sets the default active view name for all sessions created from this context.

      When set, only bean properties whose declared MarshalledProp.view() set contains this view name will be included during serialization. On the parse side, properties outside the active view are routed through the existing unknown/ignored-property mechanism governed by ignoreUnknownBeanProperties().

      Untagged properties (those whose declared view set is empty) follow the default-view-inclusion policy: included under every active view unless disableDefaultViewInclusion() has been called.

      This value can be overridden per serialization or parse call via the session builder (e.g. MarshallingSession.Builder.activeView(String)).

      Example:

      JsonSerializer serializer = JsonSerializer.create() .activeView("summary") .build();

      See Also:
      Parameters:
      value - The active view name. Use null to disable view filtering.
      Returns:
      This object.
      Since:
      10.0.0

    • disableDefaultViewInclusion

      public MarshallingContext.Builder disableDefaultViewInclusion()
      Disables the default-view-inclusion policy.

      By default, bean properties that carry no MarshalledProp.view() declaration are included under every active view (matching Jackson's DEFAULT_VIEW_INCLUSION behavior). Calling this method reverses the policy: untagged properties are excluded when any active view is set.

      See Also:
      Returns:
      This object.
      Since:
      10.0.0

    • disableDefaultViewInclusion

      public MarshallingContext.Builder disableDefaultViewInclusion(boolean value)
      Same as disableDefaultViewInclusion() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.
      Since:
      10.0.0

    • ignoreInvocationExceptionsOnGetters

      public MarshallingContext.Builder ignoreInvocationExceptionsOnGetters()
      Ignore invocation errors on getters.

      When enabled, errors thrown when calling bean getter methods will silently be ignored. Otherwise, a BeanRuntimeException is thrown.

      Example:

      // A bean with a property that throws an exception. public class MyBean { public String getFoo() { throw new RuntimeException("foo"); } } // Create a serializer that ignores bean getter exceptions. WriterSerializer serializer = JsonSerializer .create() .ingoreInvocationExceptionsOnGetters() .build(); // Exception is ignored. String json = serializer.write(new MyBean());

      See Also:
      Returns:
      This object.

    • ignoreInvocationExceptionsOnGetters

      public MarshallingContext.Builder ignoreInvocationExceptionsOnGetters(boolean value)
      Same as ignoreInvocationExceptionsOnGetters() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • ignoreInvocationExceptionsOnSetters

      public MarshallingContext.Builder ignoreInvocationExceptionsOnSetters()
      Ignore invocation errors on setters.

      When enabled, errors thrown when calling bean setter methods will silently be ignored. Otherwise, a BeanRuntimeException is thrown.

      Example:

      // A bean with a property that throws an exception. public class MyBean { public void setFoo(String foo) { throw new RuntimeException("foo"); } } // Create a parser that ignores bean setter exceptions. ReaderParser parser = JsonParser .create() .ignoreInvocationExceptionsOnSetters() .build(); // Exception is ignored. MyBean myBean = parser.read("{foo:'bar'}", MyBean.class);

      See Also:
      Returns:
      This object.

    • ignoreInvocationExceptionsOnSetters

      public MarshallingContext.Builder ignoreInvocationExceptionsOnSetters(boolean value)
      Same as ignoreInvocationExceptionsOnSetters() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • ignoreUnknownBeanProperties

      public MarshallingContext.Builder ignoreUnknownBeanProperties()
      Ignore unknown properties.

      When enabled, trying to set a value on a non-existent bean property will silently be ignored. Otherwise, a BeanRuntimeException is thrown.

      Example:

      // A bean with a single property. public class MyBean { public String foo; } // Create a parser that ignores missing bean properties. ReaderParser parser = JsonParser .create() .ignoreUnknownBeanProperties() .build(); // Doesn't throw an exception on unknown 'bar' property. MyBean myBean = parser.read("{foo:'foo',bar:'bar'}", MyBean.class);

      See Also:
      Returns:
      This object.

    • ignoreUnknownBeanProperties

      public MarshallingContext.Builder ignoreUnknownBeanProperties(boolean value)
      Same as ignoreUnknownBeanProperties() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • validateSchema

      public MarshallingContext.Builder validateSchema()
      Schema validation mode.

      When enabled, bean property values are validated against the constraints declared by @Schema annotations on those properties. Validation runs during both parsing (value set on the bean) and serialization (value read from the bean).

      Backed by the typed JsonSchema bean in juneau-bean-jsonschema and JSON Schema Draft 2020-12 semantics. Validation failures throw SchemaValidationException wrapped in BeanRuntimeException; the parser surfaces them as ParseException and the serializer surfaces them as SerializeException.

      If juneau-bean-jsonschema is not on the classpath, this flag becomes a silent no-op.

      Example:

      // A bean with a length-constrained property. public class MyBean { @Schema(minLength="2", maxLength="10") public String name; } // Parser that validates inbound values. ReaderParser p = JsonParser.create().validateSchema().build(); p.read("{name:'a'}", MyBean.class); // throws ParseException - too short

      See Also:
      Returns:
      This object.
      Since:
      10.0.0

    • validateSchema

      public MarshallingContext.Builder validateSchema(boolean value)
      Same as validateSchema() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.
      Since:
      10.0.0

    • ignoreUnknownEnumValues

      public MarshallingContext.Builder ignoreUnknownEnumValues()
      Ignore unknown properties.

      When enabled, unknown enum values will be set to null instead of throwing an exception.

      See Also:
      Returns:
      This object.

    • ignoreUnknownEnumValues

      public MarshallingContext.Builder ignoreUnknownEnumValues(boolean value)
      Same as ignoreUnknownEnumValues() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • implClass

      public MarshallingContext.Builder implClass(Class<?> interfaceClass, Class<?> implClass)
      Implementation classes.

      For interfaces and abstract classes this method can be used to specify an implementation class for the interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a parse).

      Example:

      // A bean interface. public interface MyBean { ... } // A bean implementation. public class MyBeanImpl implements MyBean { ... } // Create a parser that instantiates MyBeanImpls when parsing MyBeans. ReaderParser parser = JsonParser .create() .implClass(MyBean.class, MyBeanImpl.class) .build(); // Instantiates a MyBeanImpl, MyBean myBean = parser.read("...", MyBean.class);

      Parameters:
      interfaceClass - The interface class.
      Cannot be null.
      implClass - The implementation class.
      Cannot be null.
      Returns:
      This object.

    • implClasses

      public MarshallingContext.Builder implClasses(Map<Class<?>,Class<?>> values)
      Implementation classes.

      For interfaces and abstract classes this method can be used to specify an implementation class for the interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a parse).

      Example:

      // A bean with a single property. public interface MyBean { ... } // A bean with a single property. public class MyBeanImpl implements MyBean { ... } // Create a parser that instantiates MyBeanImpls when parsing MyBeans. ReaderParser parser = JsonParser .create() .implClasses(AMap.of(MyBean.class, MyBeanImpl.class)) .build(); // Instantiates a MyBeanImpl, MyBean myBean = parser.read("...", MyBean.class);

      Parameters:
      values - The new value for this setting.
      Cannot be null.
      Returns:
      This object.

    • interfaceClass

      public MarshallingContext.Builder interfaceClass(Class<?> on, Class<?> value)
      Identifies a class to be used as the interface class for the specified class and all subclasses.

      When specified, only the list of properties defined on the interface class will be used during serialization. Additional properties on subclasses will be ignored.

      // Parent class or interface public abstract class A { public String foo = "foo"; } // Sub class public class A1 extends A { public String bar = "bar"; } // Create a serializer and define our interface class mapping. WriterSerializer serializer = JsonSerializer .create() .interfaceClass(A1.class, A.class) .build(); // Produces "{"foo":"foo"}" String json = serializer.write(new A1());

      This annotation can be used on the parent class so that it filters to all child classes, or can be set individually on the child classes.

      Notes:
      Parameters:
      on - The class that the interface class applies to.
      Cannot be null.
      value - The new value for this setting.
      Cannot be null.
      Returns:
      This object.

    • interfaces

      public MarshallingContext.Builder interfaces(Class<?>... value)
      Identifies a set of interfaces.

      When specified, only the list of properties defined on the interface class will be used during serialization of implementation classes. Additional properties on subclasses will be ignored.

      // Parent class or interface public abstract class A { public String foo = "foo"; } // Sub class public class A1 extends A { public String bar = "bar"; } // Create a serializer and define our interface class mapping. WriterSerializer serializer = JsonSerializer .create() .interfaces(A.class) .build(); // Produces "{"foo":"foo"}" String json = serializer.write(new A1());

      This annotation can be used on the parent class so that it filters to all child classes, or can be set individually on the child classes.

      Notes:
      Parameters:
      value - The new value for this setting.
      Cannot be null.
      Returns:
      This object.

    • locale

      public MarshallingContext.Builder locale(Locale value)
      Context configuration property:  Locale.

      Specifies the default locale for serializer and parser sessions when not specified via MarshallingSession.Builder.locale(Locale). Typically used for POJO swaps that need to deal with locales such as swaps that convert Date and Calendar objects to strings by accessing it via the session passed into the ObjectSwap.swap(MarshallingSession, Object) and ObjectSwap.unswap(MarshallingSession, Object, ClassMeta, String) methods.

      Example:

      // Define a POJO swap that skips serializing beans if we're in the UK. public class MyBeanSwap extends StringSwap<MyBean> { @Override public String swap(MarshallingSession session, MyBean bean) throws Exception { if (session.getLocale().equals(Locale.UK)) return null; return bean.toString(); } } // Create a serializer that uses the specified locale if it's not passed in through session args. WriterSerializer serializer = JsonSerializer .create() .locale(Locale.UK) .swaps(MyBeanSwap.class) .build();

      See Also:
      Parameters:
      value - The new value for this property.
      Cannot be null.
      Returns:
      This object.

    • mediaType

      public MarshallingContext.Builder mediaType(MediaType value)
      Context configuration property:  Media type.

      Specifies the default media type for serializer and parser sessions when not specified via MarshallingSession.Builder.mediaType(MediaType). Typically used for POJO swaps that need to serialize the same POJO classes differently depending on the specific requested media type. For example, a swap could handle a request for media types "application/json" and "application/json+foo" slightly differently even though they're both being handled by the same JSON serializer or parser.

      Example:

      // Define a POJO swap that skips serializing beans if the media type is application/json. public class MyBeanSwap extends StringSwap<MyBean> { @Override public String swap(MarshallingSession session, MyBean bean) throws Exception { if (session.getMediaType().equals("application/json")) return null; return bean.toString(); } } // Create a serializer that uses the specified media type if it's not passed in through session args. WriterSerializer serializer = JsonSerializer .create() .mediaType(MediaType.JSON) .build();

      See Also:
      Parameters:
      value - The new value for this property.
      Can be null (no default media type will be set).
      Returns:
      This object.

    • notBeanClasses

      public Set<ClassInfo> notBeanClasses()
      Returns the set of not-bean classes.

      Gives access to the inner set if you need to make more than simple additions via notBeanClasses(ClassInfo...).

      Returns:
      The set of not-bean classes.
      See Also:

    • notBeanClasses

      public MarshallingContext.Builder notBeanClasses(Class<?>... values)
      Convenience method for notBeanClasses(ClassInfo...) that accepts Class objects.
      Parameters:
      values - The values to add to this setting.
      Cannot contain null values.
      Returns:
      This object.
      See Also:

    • notBeanClasses

      public MarshallingContext.Builder notBeanClasses(ClassInfo... values)
      Bean class exclusions.

      List of classes that should not be treated as beans even if they appear to be bean-like. Not-bean classes are converted to Strings during serialization.

      Values can consist of any of the following types:

      • Classes.
      • Arrays and collections of classes.
      Example:

      // A bean with a single property. public class MyBean { public String foo = "bar"; public String toString() { return "baz"; } } // Create a serializer that doesn't treat MyBean as a bean class. WriterSerializer serializer = JsonSerializer .create() .notBeanClasses(MyBean.class) .build(); // Produces "baz" instead of {"foo":"bar"} String json = serializer.write(new MyBean());

      Notes:
      • The @BeanIgnore annotation can also be used on classes to prevent them from being recognized as beans.
      See Also:
      Parameters:
      values - The values to add to this setting.
      Cannot contain null values.
      Returns:
      This object.

    • notBeanClasses

      public MarshallingContext.Builder notBeanClasses(Collection<ClassInfo> values)
      Same as notBeanClasses(ClassInfo...) but allows you to pass in a collection of class info objects.
      Parameters:
      values - The values to add to this setting.
      Cannot be null or contain null values.
      Returns:
      This object.
      See Also:

    • notBeanPackages

      public Set<String> notBeanPackages()
      Returns the list of not-bean Java package names.

      Gives access to the inner list if you need to make more than simple additions via notBeanPackages(String...).

      Returns:
      The list of not-bean Java package names.
      See Also:

    • notBeanPackages

      public MarshallingContext.Builder notBeanPackages(Collection<String> values)
      Same as notBeanPackages(String...) but allows you to pass in a collection of classes.
      Parameters:
      values - The values to add to this setting.
      Cannot be null or contain null values.
      Returns:
      This object.
      See Also:

    • notBeanPackages

      public MarshallingContext.Builder notBeanPackages(String... values)
      Bean package exclusions.

      Used as a convenient way of defining the notBeanClasses(Class...) property for entire packages. Any classes within these packages will be serialized to strings using Object.toString().

      Note that you can specify suffix patterns to include all subpackages.

      Values can consist of any of the following types:

      • Strings.
      • Arrays and collections of strings.
      Example:

      // Create a serializer that ignores beans in the specified packages. WriterSerializer serializer = JsonSerializer .create() .notBeanPackages("org.apache.foo", "org.apache.bar.*") .build();

      Parameters:
      values - The values to add to this setting.
      Values can consist of any of the following types:
      • Package objects.
      • Strings.
      • Arrays and collections of anything in this list.

      Cannot contain null values.
      Returns:
      This object.

    • propertyNamer

      public MarshallingContext.Builder propertyNamer(Class<?> on, Class<? extends PropertyNamer> value)
      Bean property namer

      Same as propertyNamer(Class) but allows you to specify a namer for a specific class.

      Example:

      // A bean with a single property. public class MyBean { public String fooBarBaz = "fooBarBaz"; } // Create a serializer that uses Dashed-Lower-Case property names for the MyBean class only. // (e.g. "foo-bar-baz" instead of "fooBarBaz") WriterSerializer serializer = JsonSerializer .create() .propertyNamer(MyBean.class, PropertyNamerDLC.class) .build(); // Produces: {"foo-bar-baz":"fooBarBaz"} String json = serializer.write(new MyBean());

      See Also:
      Parameters:
      on - The class that the namer applies to.
      Cannot be null.
      value - The new value for this setting.
      The default is BasicPropertyNamer.
      Cannot be null.
      Returns:
      This object.

    • propertyNamer

      public MarshallingContext.Builder propertyNamer(Class<? extends PropertyNamer> value)
      Bean property namer

      The class to use for calculating bean property names.

      Predefined classes:

      Example:

      // A bean with a single property. public class MyBean { public String fooBarBaz = "fooBarBaz"; } // Create a serializer that uses Dashed-Lower-Case property names. // (e.g. "foo-bar-baz" instead of "fooBarBaz") WriterSerializer serializer = JsonSerializer .create() .propertyNamer(PropertyNamerDLC.class) .build(); // Produces: {"foo-bar-baz":"fooBarBaz"} String json = serializer.write(new MyBean());

      Parameters:
      value - The new value for this setting.
      Can be null (will use BasicPropertyNamer as the default).
      Returns:
      This object.

    • unsortedProperties

      public MarshallingContext.Builder unsortedProperties()
      Disable sorted bean properties.

      By default, all bean properties are serialized and accessed in alphabetical order. Calling this method opts out of that behavior so that declaration order is used instead: record component order for records, field declaration order (superclass first) for other classes, then method-only properties alphabetically.

      Example:

      // A bean with 3 properties. public class MyBean { public String c = "1"; public String b = "2"; public String a = "3"; } // Create a serializer that does NOT sort bean properties. WriterSerializer serializer = JsonSerializer .create() .unsortedProperties() .build(); // Produces: {"c":"1","b":"2","a":"3"} (declaration order) String json = serializer.write(new MyBean());

      Notes:
      Returns:
      This object.

    • unsortedProperties

      public MarshallingContext.Builder unsortedProperties(boolean value)
      Same as unsortedProperties() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • recordComponentOrder

      public MarshallingContext.Builder recordComponentOrder()
      Use record component order for Record beans.

      By default, record properties are sorted alphabetically like every other bean. Calling this method makes records keep their component (declaration) order, even when other beans are sorted. Non-record beans are unaffected.

      Example:

      public record Person(String name, int age) {} WriterSerializer serializer = JsonSerializer .create() .recordComponentOrder() .build(); // Produces: {"name":"Alice","age":30} String json = serializer.write(new Person("Alice", 30));

      See Also:
      Returns:
      This object.

    • recordComponentOrder

      public MarshallingContext.Builder recordComponentOrder(boolean value)
      Same as recordComponentOrder() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.

    • unsortedProperties

      public MarshallingContext.Builder unsortedProperties(Class<?>... on)
      Opt specific bean classes out of alphabetical property sorting.

      Applies the @BeanType(unsorted=true) annotation to the specified classes, overriding the default sorted behavior for those specific beans.

      See Also:
      Parameters:
      on - The bean classes to opt out of sorted properties.
      Cannot contain null values.
      Returns:
      This object.

    • stopClass

      public MarshallingContext.Builder stopClass(Class<?> on, Class<?> value)
      Identifies a stop class for the annotated class.

      Identical in purpose to the stop class specified by Introspector.getBeanInfo(Class, Class). Any properties in the stop class or in its base classes will be ignored during analysis.

      For example, in the following class hierarchy, instances of C3 will include property p3, but not p1 or p2.

      Example:

      public class C1 { public int getP1(); } public class C2 extends C1 { public int getP2(); } public class C3 extends C2 { public int getP3(); } // Create a serializer specifies a stop class for C3. WriterSerializer serializer = JsonSerializer .create() .stopClass(C3.class, C2.class) .build(); // Produces: {"p3":"..."} String json = serializer.write(new C3());

      Parameters:
      on - The class on which the stop class is being applied.
      Cannot be null.
      value - The new value for this setting.
      Cannot be null.
      Returns:
      This object.

    • swap

      public <T, S> MarshallingContext.Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction)
      A shortcut for defining a FunctionalSwap.
      Example:

      // Create a serializer that performs a custom format for DAte objects. WriterSerializer serializer = JsonSerializer .create() .swap(Date.class, String.class, x -> format(x)) .build();

      Type Parameters:
      T - The object type being swapped out.
      S - The object type being swapped in.
      Parameters:
      normalClass - The object type being swapped out.
      Cannot be null.
      swappedClass - The object type being swapped in.
      Cannot be null.
      swapFunction - The function to convert the object.
      Cannot be null.
      Returns:
      This object.

    • swap

      public <T, S> MarshallingContext.Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction, ThrowingFunction<S,T> unswapFunction)
      A shortcut for defining a FunctionalSwap.
      Example:

      // Create a serializer that performs a custom format for Date objects. WriterSerializer serializer = JsonSerializer .create() .swap(Date.class, String.class, x -> format(x), x -> parse(x)) .build();

      Type Parameters:
      T - The object type being swapped out.
      S - The object type being swapped in.
      Parameters:
      normalClass - The object type being swapped out.
      Cannot be null.
      swappedClass - The object type being swapped in.
      Cannot be null.
      swapFunction - The function to convert the object during serialization.
      Cannot be null.
      unswapFunction - The function to convert the object during parsing.
      Cannot be null.
      Returns:
      This object.

    • swaps

      public List<Object> swaps()
      Returns the bean swaps list.

      Gives access to the inner list if you need to make more than simple additions via swaps(Class...).

      Returns:
      The bean swaps list.
      See Also:

    • swaps

      public MarshallingContext.Builder swaps(Class<?>... values)
      Same as swaps(Object...) but explicitly specifies an array of classes to avoid compilation warnings.
      Parameters:
      values - The values to add to this setting.
      Values can consist of any of the following types:
      Cannot be null.
      Returns:
      This object.

    • swaps

      public MarshallingContext.Builder swaps(Object... values)
      Java object swaps.

      Swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization, and "swap in" the non-serializable class during parsing.

      An example of a swap would be a Calendar object that gets swapped out for an ISO8601 string.

      Multiple swaps can be associated with a single class. When multiple swaps are applicable to the same class, the media type pattern defined by ObjectSwap.forMediaTypes() or @Swap(mediaTypes) are used to come up with the best match.

      Values can consist of any of the following types:

      • Any subclass of ObjectSwap.
      • Any instance of ObjectSwap.
      • Any surrogate class. A shortcut for defining a SurrogateSwap.
      • Any array or collection of the objects above.
      Example:

      // Sample swap for converting Dates to ISO8601 strings. public class MyDateSwap extends StringSwap<Date> { // ISO8601 formatter. private DateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ"); @Override public String swap(MarshallingSession session, Date date) { return format.format(date); } @Override public Date unswap(MarshallingSession session, String string, ClassMeta hint) throws Exception { return format.parse(string); } } // Sample bean with a Date field. public class MyBean { public Date date = new Date(112, 2, 3, 4, 5, 6); } // Create a serializer that uses our date swap. WriterSerializer serializer = JsonSerializer .create() .swaps(MyDateSwap.class) .build(); // Produces: {"date":"2012-03-03T04:05:06-0500"} String json = serializer.write(new MyBean()); // Create a serializer that uses our date swap. ReaderParser parser = JsonParser .create() .swaps(MyDateSwap.class) .build(); // Use our parser to parse a bean. MyBean bean = parser.read(json, MyBean.class);

      Notes:
      • The @Swap annotation can also be used on classes to identify swaps for the class.
      • The @Swap annotation can also be used on bean methods and fields to identify swaps for values of those bean properties.
      Parameters:
      values - The values to add to this setting.
      Values can consist of any of the following types:
      • Any subclass of ObjectSwap.
      • Any surrogate class. A shortcut for defining a SurrogateSwap.
      • Any array/collection/stream of the objects above.

      Cannot be null.
      Returns:
      This object.

    • timeZone

      public MarshallingContext.Builder timeZone(TimeZone value)
      Context configuration property:  TimeZone.

      Specifies the default time zone for serializer and parser sessions when not specified via MarshallingSession.Builder.timeZone(TimeZone). Typically used for POJO swaps that need to deal with timezones such as swaps that convert Date and Calendar objects to strings by accessing it via the session passed into the ObjectSwap.swap(MarshallingSession, Object) and ObjectSwap.unswap(MarshallingSession, Object, ClassMeta, String) methods.

      Example:

      // Define a POJO swap that skips serializing beans if the time zone is GMT. public class MyBeanSwap extends StringSwap<MyBean> { @Override public String swap(MarshallingSession session, MyBean bean) throws Exception { if (session.getTimeZone().equals(TimeZone.GMT)) return null; return bean.toString(); } } // Create a serializer that uses GMT if the timezone is not specified in the session args. WriterSerializer serializer = JsonSerializer .create() .timeZone(TimeZone.GMT) .build();

      See Also:
      Parameters:
      value - The new value for this property.
      Can be null (timezone will not be set, defaults to system timezone).
      Returns:
      This object.

    • durationFormat

      public MarshallingContext.Builder durationFormat(DurationFormat value)
      Duration wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to DurationFormat.ISO_8601_WITH_DAYS).
      Returns:
      This object.

    • periodFormat

      public MarshallingContext.Builder periodFormat(PeriodFormat value)
      Period wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to PeriodFormat.ISO_8601).
      Returns:
      This object.

    • calendarFormat

      public MarshallingContext.Builder calendarFormat(CalendarFormat value)
      Calendar wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to CalendarFormat.ISO_OFFSET_DATE_TIME).
      Returns:
      This object.

    • dateFormat

      public MarshallingContext.Builder dateFormat(DateFormat value)
      Date wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to DateFormat.ISO_LOCAL_DATE_TIME).
      Returns:
      This object.

    • temporalFormat

      public MarshallingContext.Builder temporalFormat(TemporalFormat value)
      Temporal wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to TemporalFormat.DEFAULT).
      Returns:
      This object.

    • timeZoneFormat

      public MarshallingContext.Builder timeZoneFormat(TimeZoneFormat value)
      Time-zone wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to TimeZoneFormat.ID).
      Returns:
      This object.

    • localeFormat

      public MarshallingContext.Builder localeFormat(LocaleFormat value)
      Locale wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to LocaleFormat.BCP_47).
      Returns:
      This object.

    • binaryFormat

      public MarshallingContext.Builder binaryFormat(BinaryFormat value)
      Binary wire format.

      Controls how byte[] values are written to and read from text-based serializer / parser wire formats, and the encoding used by stream-based serializers when converting their byte output to a string.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to BinaryFormat.NOT_SET).
      Returns:
      This object.

    • enumFormat

      public MarshallingContext.Builder enumFormat(EnumFormat value)
      Enum wire format.
      Parameters:
      value - The value for this setting.
      Can be null (defaults to EnumFormat.TO_STRING).
      Returns:
      This object.

    • uuidFormat

      public MarshallingContext.Builder uuidFormat(UuidFormat value)
      UUID wire format.

      Controls how UUID values are written to text-based wire formats. Binary serializers (BSON / CBOR / MsgPack / Prototext) emit native 16-byte binary regardless of this setting.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to UuidFormat.STANDARD).
      Returns:
      This object.

    • bitSetFormat

      public MarshallingContext.Builder bitSetFormat(BitSetFormat value)
      BitSet wire format.

      Controls how BitSet values are written to text-based wire formats.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to BitSetFormat.INDICES).
      Returns:
      This object.

    • bigNumberFormat

      public MarshallingContext.Builder bigNumberFormat(BigNumberFormat value)
      Big-number wire format.

      Controls how BigInteger and BigDecimal values are written to text-based wire formats. Useful for safe JS interop where values outside ±(2^53 − 1) would silently lose precision.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to BigNumberFormat.NUMBER).
      Returns:
      This object.

    • booleanFormat

      public MarshallingContext.Builder booleanFormat(BooleanFormat value)
      Boolean wire format.

      Controls how Boolean / boolean values are written to text-based wire formats. Binary serializers (BSON / CBOR / MsgPack / Prototext / Parquet) emit a native boolean wire type regardless of this setting.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to BooleanFormat.TRUE_FALSE).
      Returns:
      This object.

    • floatFormat

      public MarshallingContext.Builder floatFormat(FloatFormat value)
      Float / Double non-finite wire format.

      Controls how non-finite Float / Double values (NaN / ±Infinity) are written to text-based wire formats. The default FloatFormat.NaN_AS_NULL is JSON-spec-compliant. Binary serializers emit native IEEE-754 floats regardless of this setting.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to FloatFormat.NaN_AS_NULL).
      Returns:
      This object.

    • currencyFormat

      public MarshallingContext.Builder currencyFormat(CurrencyFormat value)
      Currency wire format.

      Controls how Currency values are written to text-based wire formats. The default CurrencyFormat.ISO_CODE is the only setting safe for machine-to-machine wires; CurrencyFormat.SYMBOL and CurrencyFormat.DISPLAY_NAME are locale-sensitive and best-effort on the parse side.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to CurrencyFormat.ISO_CODE).
      Returns:
      This object.

    • classFormat

      public MarshallingContext.Builder classFormat(ClassFormat value)
      Class wire format.

      Controls how Class values are written to text-based wire formats. The default ClassFormat.FQCN matches the historical ClassSwap behavior. ClassFormat.SIMPLE_NAME is serialize-only — the parser path throws UnsupportedOperationException.

      Parameters:
      value - The value for this setting.
      Can be null (defaults to ClassFormat.FQCN).
      Returns:
      This object.

    • classLoader

      public MarshallingContext.Builder classLoader(ClassLoader value)
      Session classloader.

      Sets the classloader used when parsing wire-format class names (e.g. FQCN or binary-name strings written by ClassFormatSwap). When null, the thread-context classloader is used as a fallback — which is the historical behavior.

      Useful in OSGi bundles, webapp classloaders, and plugin systems where the thread-context classloader does not have visibility into the classes that the session needs to resolve.

      Parameters:
      value - The classloader to use for class resolution. Can be null to reset to thread-context fallback.
      Returns:
      This object.

    • type

      public MarshallingContext.Builder type(Class<? extends Context> value)
      Description copied from class: Context.Builder
      Associates a context class with this builder.

      This is the type of object that this builder creates when the Context.Builder.build() method is called.

      By default, it's the outer class of where the builder class is defined.

      If null is set, Context.Builder.build() will throw an exception. The default constructor automatically sets this to the outer class, so null should only be set explicitly if you want to override the default.

      Overrides:
      type in class Context.Builder<MarshallingContext.Builder>
      Parameters:
      value - The context class that this builder should create.
      Can be null (will cause Context.Builder.build() to throw an exception).
      Returns:
      This object.

    • typeName

      public MarshallingContext.Builder typeName(Class<?> on, String value)
      An identifying name for this class.

      The name is used to identify the class type during parsing when it cannot be inferred through reflection. For example, if a bean property is of type Object, then the serializer will add the name to the output so that the class can be determined during parsing.

      It is also used to specify element names in XML.

      Example:

      // Use _type='mybean' to identify this bean. public class MyBean {...} // Create a serializer and specify the type name.. WriterSerializer serializer = JsonSerializer .create() .typeName(MyBean.class, "mybean") .build(); // Produces: {"_type":"mybean",...} String json = serializer.write(new MyBean());

      Notes:
      See Also:
      Parameters:
      on - The class the type name is being defined on.
      Cannot be null.
      value - The new value for this setting.
      Cannot be null.
      Returns:
      This object.

    • typePropertyName

      public MarshallingContext.Builder typePropertyName(Class<?> on, String value)
      Bean type property name.

      Same as typePropertyName(String) except targets a specific bean class instead of globally.

      Example:

      // POJOs with @Marshalled(name) annotations. @Marshalled(typeName="foo") public class Foo {...} @Marshalled(typeName="bar") public class Bar {...} // A bean with a field with an indeterminate type. public class MyBean { public Object mySimpleField; } // Create a serializer that uses 't' instead of '_type' for dictionary names. WriterSerializer serializer = JsonSerializer .create() .typePropertyName(MyBean.class, "t") .dictionary(Foo.class, Bar.class) .build(); // Produces "{mySimpleField:{t:'foo',...}}". String json = serializer.write(new MyBean());

      See Also:
      Parameters:
      on - The class the type property name applies to.
      Cannot be null.
      value - The new value for this setting.
      The default is "_type".
      Cannot be null.
      Returns:
      This object.

    • typePropertyName

      public MarshallingContext.Builder typePropertyName(String value)
      Bean type property name.

      This specifies the name of the bean property used to store the dictionary name of a bean type so that the parser knows the data type to reconstruct.

      Example:

      // POJOs with @Marshalled(name) annotations. @Marshalled(typeName="foo") public class Foo {...} @Marshalled(typeName="bar") public class Bar {...} // Create a serializer that uses 't' instead of '_type' for dictionary names. WriterSerializer serializer = JsonSerializer .create() .typePropertyName("t") .dictionary(Foo.class, Bar.class) .build(); // Create a serializer that uses 't' instead of '_type' for dictionary names. ReaderParser parser = JsonParser .create() .typePropertyName("t") .dictionary(Foo.class, Bar.class) .build(); // A bean with a field with an indeterminate type. public class MyBean { public Object mySimpleField; } // Produces "{mySimpleField:{t:'foo',...}}". String json = serializer.write(new MyBean()); // Parse bean. MyBean bean = parser.read(json, MyBean.class);

      See Also:
      Parameters:
      value - The new value for this setting.
      The default is "_type".
      Cannot be null.
      Returns:
      This object.

    • useJavaBeanIntrospector

      public MarshallingContext.Builder useJavaBeanIntrospector()
      Use Java Introspector.

      Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
      Most @Marshalled annotations will be ignored.

      Example:

      // Create a serializer that only uses the built-in java bean introspector for finding properties. WriterSerializer serializer = JsonSerializer .create() .useJavaBeanIntrospector() .build();

      Returns:
      This object.

    • useJavaBeanIntrospector

      public MarshallingContext.Builder useJavaBeanIntrospector(boolean value)
      Same as useJavaBeanIntrospector() but allows you to explicitly specify the value.
      Parameters:
      value - The value for this setting.
      Returns:
      This object.