com.intuit.wasabi.tests.library.util.serialstrategies

Class DefaultNameInclusionStrategy

java.lang.Object

com.intuit.wasabi.tests.library.util.serialstrategies.DefaultNameInclusionStrategy

All Implemented Interfaces:

com.google.gson.ExclusionStrategy, SerializationStrategy

public class DefaultNameInclusionStrategy
extends Object
implements SerializationStrategy

Implements an SerializationStrategy which only allows fields which have whitelisted names.

Constructor Summary

Constructors

Constructor and Description
DefaultNameInclusionStrategy(String... includes) Whitelists method names.

Method Summary

Modifier and Type	Method and Description
void	add(String... identifiers) Adds identifiers to the exclusion strategy.
boolean	contains(String identifier) Checks if an identifier is contained in this strategy.
boolean	exclude(String identifier) Checks if the given identifier should be excluded.
boolean	include(String identifier) Checks if the given identifier should be included.
void	remove(String... identifiers) Removes identifiers from the serialization strategy.
boolean	shouldSkipClass(Class<?> aClass) Skips no classes.
boolean	shouldSkipField(com.google.gson.FieldAttributes fieldAttributes) Skips all fields if their names are not contained in the whitelist.
String	toString() Returns an explanation how this strategy works.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNameInclusionStrategy

public DefaultNameInclusionStrategy(String... includes)

Whitelists method names.

Parameters:

includes - names to whitelist.

Method Detail

shouldSkipField

public boolean shouldSkipField(com.google.gson.FieldAttributes fieldAttributes)

Skips all fields if their names are not contained in the whitelist.

Specified by:

shouldSkipField in interface com.google.gson.ExclusionStrategy

Parameters:

fieldAttributes - the field attributes

Returns:

false if the whitelist contains the field name

shouldSkipClass

public boolean shouldSkipClass(Class<?> aClass)

Skips no classes.

Specified by:

shouldSkipClass in interface com.google.gson.ExclusionStrategy

Parameters:

aClass - the class types

Returns:

always false

add

public void add(String... identifiers)

Adds identifiers to the exclusion strategy.

Specified by:

add in interface SerializationStrategy

Parameters:

identifiers - the modifiers to be added.

remove

public void remove(String... identifiers)

Removes identifiers from the serialization strategy.

Specified by:

remove in interface SerializationStrategy

Parameters:

identifiers - the modifiers to be removed.

contains

public boolean contains(String identifier)

Checks if an identifier is contained in this strategy.

Specified by:

contains in interface SerializationStrategy

Parameters:

identifier - the identifier to be checked.

Returns:

true if identifier is in this strategy.

include

public boolean include(String identifier)

Checks if the given identifier should be included.

Specified by:

include in interface SerializationStrategy

Parameters:

identifier - the identifier to be checked.

Returns:

true if identifier is whitelisted

exclude

public boolean exclude(String identifier)

Checks if the given identifier should be excluded.

Specified by:

exclude in interface SerializationStrategy

Parameters:

identifier - the identifier to be checked.

Returns:

true if identifier is not whitelisted

toString

public String toString()

Returns an explanation how this strategy works.

Overrides:

toString in class Object

Returns:

this strategy in a human readable manner