Package org.apache.juneau.marshall

Class MarshalledFilter.Builder

java.lang.Object

org.apache.juneau.marshall.MarshalledFilter.Builder

Enclosing class:

MarshalledFilter

public static class MarshalledFilter.Builder
extends Object

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(ClassInfoTyped<?> beanClass)	Constructor for bean filters.

Method Summary

Modifier and Type	Method	Description
MarshalledFilter.Builder	applyAnnotations(List<Marshalled> annotations)	Applies the information in the specified list of @Marshalled annotations to this filter.
MarshalledFilter.Builder	applyBeanTypeAnnotations(List<BeanType> annotations)	Applies the information in the specified list of @BeanType annotations to this filter.
MarshalledFilter	build()	Creates a MarshalledFilter with settings in this builder class.
MarshalledFilter.Builder	dictionary(Class<?>... values)	Bean dictionary.
MarshalledFilter.Builder	dictionary(ClassInfo... values)	Bean dictionary.
MarshalledFilter.Builder	example(String value)	Example.
MarshalledFilter.Builder	excludeProperties(String... value)	Bean property excludes.
MarshalledFilter.Builder	findFluentSetters()	Find fluent setters.
MarshalledFilter.Builder	implClass(Class<?> value)	Bean implementation class.
MarshalledFilter.Builder	implClass(ClassInfo value)	Implementation class.
MarshalledFilter.Builder	interceptor(Class<?> value)	Bean interceptor.
MarshalledFilter.Builder	interceptor(ClassInfo value)	Bean interceptor.
MarshalledFilter.Builder	interfaceClass(Class<?> value)	Bean interface class.
MarshalledFilter.Builder	interfaceClass(ClassInfo value)	Interface class.
MarshalledFilter.Builder	properties(String... value)	Bean property includes.
MarshalledFilter.Builder	propertyNamer(Class<? extends PropertyNamer> value)	Bean property namer.
MarshalledFilter.Builder	propertyNamer(ClassInfoTyped<? extends PropertyNamer> value)	Bean property namer.
MarshalledFilter.Builder	readOnlyProperties(String... value)	Read-only bean properties.
MarshalledFilter.Builder	stopClass(Class<?> value)	Bean stop class.
MarshalledFilter.Builder	stopClass(ClassInfo value)	Stop class.
MarshalledFilter.Builder	typeName(String value)	Bean dictionary type name.
MarshalledFilter.Builder	unsortedProperties()	Opt out of alphabetical property sorting for this specific bean.
MarshalledFilter.Builder	unsortedProperties(boolean value)	Opt out of alphabetical property sorting for this specific bean.
MarshalledFilter.Builder	writeOnlyProperties(String... value)	Write-only bean properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder(ClassInfoTyped<?> beanClass)

Constructor for bean filters.

Parameters:

beanClass - The bean class that this filter applies to.

Method Details

applyAnnotations

public MarshalledFilter.Builder applyAnnotations(List<Marshalled> annotations)

Applies the information in the specified list of @Marshalled annotations to this filter.

Parameters:

annotations - The annotations to apply. Must not be null.

Returns:

This object.

applyBeanTypeAnnotations

public MarshalledFilter.Builder applyBeanTypeAnnotations(List<BeanType> annotations)

Applies the information in the specified list of @BeanType annotations to this filter.

Carries the bean-modeling attributes (property lists, ordering, fluent setters, stop class, etc.) that used to live on @Marshalled before the bean-layer split.

Parameters:

annotations - The annotations to apply. Must not be null.

Returns:

This object.

build

public MarshalledFilter build()

Creates a MarshalledFilter with settings in this builder class.

Returns:

A new MarshalledFilter instance.

dictionary

public MarshalledFilter.Builder dictionary(Class<?>... values)

Bean dictionary.

Adds to the list of classes that make up the bean dictionary for this bean.

See Also:

• Marshalled.dictionary()
• MarshallingContext.Builder.beanDictionary(Class...)

Parameters:

values - The values to add to this property.

Returns:

This object.

dictionary

public MarshalledFilter.Builder dictionary(ClassInfo... values)

Bean dictionary.

Same as the other dictionary method but accepts ClassInfo objects directly instead of Class objects.

Parameters:

values - The class info objects to add to this property.

Returns:

This object.

example

public MarshalledFilter.Builder example(String value)

Example.

Parameters:

value - The new value for this property.

Returns:

This object.

excludeProperties

public MarshalledFilter.Builder excludeProperties(String... value)

Bean property excludes.

Specifies properties to exclude from the bean class.

See Also:

• BeanType.excludeProperties()
• MarshallingContext.Builder.beanPropertiesExcludes(Class, String)
• MarshallingContext.Builder.beanPropertiesExcludes(String, String)
• MarshallingContext.Builder.beanPropertiesExcludes(Map)

Parameters:

value - The new value for this setting.
Values can contain comma-delimited list of property names.

Returns:

This object.

findFluentSetters

public MarshalledFilter.Builder findFluentSetters()

Find fluent setters.

When enabled, fluent setters are detected on beans.

See Also:

• BeanType.findFluentSetters()
• MarshallingContext.Builder.findFluentSetters()

Returns:

This object.

implClass

public MarshalledFilter.Builder implClass(Class<?> value)

Bean implementation class.

Parameters:

value - The new value for this setting. Can be null to clear any previously-set implementation class.

Returns:

This object.

implClass

public MarshalledFilter.Builder implClass(ClassInfo value)

Implementation class.

Same as the other implClass method but accepts a ClassInfo object directly instead of a Class object.

Parameters:

value - The new value for this setting.

Returns:

This object.

interceptor

public MarshalledFilter.Builder interceptor(Class<?> value)

Bean interceptor.

The interceptor to use for intercepting and altering getter and setter calls.

See Also:

• Marshalled.interceptor()
• BeanInterceptor

Parameters:

value - The new value for this setting.
The default value is BeanInterceptor.

Returns:

This object.

interceptor

public MarshalledFilter.Builder interceptor(ClassInfo value)

Bean interceptor.

Same as the other interceptor method but accepts a ClassInfo object directly instead of a Class object.

Parameters:

value - The new value for this setting.

Returns:

This object.

interfaceClass

public MarshalledFilter.Builder interfaceClass(Class<?> value)

Bean interface class.

Identifies a class to be used as the interface class for this and all subclasses. When specified, only the list of properties defined on the interface class will be used during serialization.

See Also:

• BeanType.interfaceClass()

Parameters:

value - The new value for this setting. Can be null to clear any previously-set interface class.

Returns:

This object.

interfaceClass

public MarshalledFilter.Builder interfaceClass(ClassInfo value)

Interface class.

Same as the other interfaceClass method but accepts a ClassInfo object directly instead of a Class object.

Parameters:

value - The new value for this setting.

Returns:

This object.

properties

public MarshalledFilter.Builder properties(String... value)

Bean property includes.

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

See Also:

• BeanType.properties()
• MarshallingContext.Builder.beanProperties(Class, String)
• MarshallingContext.Builder.beanProperties(String, String)
• MarshallingContext.Builder.beanProperties(Map)

Parameters:

value - The new value for this setting.
Values can contain comma-delimited list of property names.

Returns:

This object.

propertyNamer

public MarshalledFilter.Builder propertyNamer(Class<? extends PropertyNamer> value)

Bean property namer.

The class to use for calculating bean property names.

See Also:

• BeanType.propertyNamer()
• MarshallingContext.Builder.propertyNamer(Class)
• PropertyNamer

Parameters:

value - The new value for this setting.
The default is BasicPropertyNamer.

Returns:

This object.

propertyNamer

public MarshalledFilter.Builder propertyNamer(ClassInfoTyped<? extends PropertyNamer> value)

Bean property namer.

Same as the other propertyNamer method but accepts a ClassInfoTyped object directly instead of a Class object.

Parameters:

value - The new value for this setting.

Returns:

This object.

readOnlyProperties

public MarshalledFilter.Builder readOnlyProperties(String... value)

Read-only bean properties.

Specifies one or more properties on a bean that are read-only despite having valid getters.

See Also:

• BeanType.readOnlyProperties()
• BeanProp.ro()
• MarshallingContext.Builder.beanPropertiesReadOnly(Class, String)
• MarshallingContext.Builder.beanPropertiesReadOnly(String, String)
• MarshallingContext.Builder.beanPropertiesReadOnly(Map)

Parameters:

value - The new value for this setting.
Values can contain comma-delimited list of property names.

Returns:

This object.

unsortedProperties

public MarshalledFilter.Builder unsortedProperties()

Opt out of alphabetical property sorting for this specific bean.

See Also:

• BeanType.unsorted()
• MarshallingContext.Builder.unsortedProperties()

Returns:

This object.

unsortedProperties

public MarshalledFilter.Builder unsortedProperties(boolean value)

Opt out of alphabetical property sorting for this specific bean.

See Also:

• BeanType.unsorted()
• MarshallingContext.Builder.unsortedProperties()

Parameters:

value - The new value for this property.
The default is false.

Returns:

This object.

stopClass

public MarshalledFilter.Builder stopClass(Class<?> value)

Bean stop class.

Identifies a stop class for this class and all subclasses. Identical in purpose to the stop class specified by Introspector.getBeanInfo(Class, Class).

See Also:

• BeanType.stopClass()

Parameters:

value - The new value for this setting. Can be null to clear any previously-set stop class.

Returns:

This object.

stopClass

public MarshalledFilter.Builder stopClass(ClassInfo value)

Stop class.

Same as the other stopClass method but accepts a ClassInfo object directly instead of a Class object.

Parameters:

value - The new value for this setting.

Returns:

This object.

typeName

public MarshalledFilter.Builder typeName(String value)

Bean dictionary type name.

Specifies the dictionary type name for this bean.

See Also:

• Marshalled.typeName()

Parameters:

value - The new value for this setting.

Returns:

This object.

writeOnlyProperties

public MarshalledFilter.Builder writeOnlyProperties(String... value)

Write-only bean properties.

Specifies one or more properties on a bean that are write-only despite having valid setters.

See Also:

• BeanType.writeOnlyProperties()
• BeanProp.wo()
• MarshallingContext.Builder.beanPropertiesWriteOnly(Class, String)
• MarshallingContext.Builder.beanPropertiesWriteOnly(String, String)
• MarshallingContext.Builder.beanPropertiesWriteOnly(Map)

Parameters:

value - The new value for this setting.
Values can contain comma-delimited list of property names.

Returns:

This object.