Package org.apache.juneau

Class MarshalledFilter

java.lang.Object

org.apache.juneau.MarshalledFilter

public final class MarshalledFilter
extends Object

Parent class for all non-bean filters.

Marshalled filters are used to control aspects of how POJOs are handled during serialization and parsing.

Marshalled filters are created by MarshalledFilter.Builder which is the programmatic equivalent to the @Marshalled annotation.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarshalledFilter.Builder	Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MarshalledFilter(MarshalledFilter.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static <T> MarshalledFilter.Builder	create(Class<T> marshalledClass)	Create a new instance of this POJO filter.
String	getExample()	Returns the example string with this class.
Class<?>	getImplClass()	Returns the implementation class associated with this class.
Class<?>	getMarshalledClass()	Returns the class that this filter applies to.

Methods inherited from class java.lang.Object

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

Constructor Details

MarshalledFilter

protected MarshalledFilter(MarshalledFilter.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static <T> MarshalledFilter.Builder create(Class<T> marshalledClass)

Create a new instance of this POJO filter.

Type Parameters:

T - The POJO class being filtered.

Parameters:

marshalledClass - The POJO class being filtered.

Returns:

A new MarshalledFilter.Builder object.

getMarshalledClass

public Class<?> getMarshalledClass()

Returns the class that this filter applies to.

Returns:

The class that this filter applies to.

getImplClass

public Class<?> getImplClass()

Returns the implementation class associated with this class.

Returns:

The implementation class associated with this class, or null if no implementation class is associated.

getExample

public String getExample()

Returns the example string with this class.

Returns:

The example string associated with this class, or null if no example string is associated.