org.skyscreamer.yoga.builder

Class YogaBuilder

java.lang.Object

org.skyscreamer.yoga.builder.YogaBuilder

public class YogaBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected InputStream	_aliasProperties
protected ClassFinderStrategy	_classFinderStrategy
protected boolean	_createAllLinks
protected boolean	_finalized
protected RenderingListenerRegistry	_registry
protected SelectorResolver	_selectorResolver

Constructor Summary

Constructors

Constructor and Description
YogaBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAliases()
protected void	checkFinalized()
YogaBuilder	enableStarAsAllFields()
YogaBuilder	enableYogaLinks()
void	finalize()
InputStream	getAliasProperties()
ClassFinderStrategy	getClassFinderStrategy()
MetaDataRegistry	getMetaDataRegistry()
RenderingListenerRegistry	getRegistry()
SelectorResolver	getSelectorResolver()
protected void	init() there are cases where a user might want to override meta data registry, selector resolver and/or CoreSelector implementations.
boolean	isCreateAllLinks()
boolean	isEnableYogaMetadata()
YogaBuilder	registerEntityConfigurations(YogaEntityConfiguration<?>... entityConfigurations)
protected void	registerMetadataLinkListener()
protected void	registerRenderingListeners()
YogaBuilder	registerYogaMetaDataClasses(Class<?>... classes)
void	setAliasProperties(InputStream aliasProperties) This is a mechanism of allowing small aliases to be converted into pre-configured set of aliases for complicated or common selectors.
void	setClassFinderStrategy(ClassFinderStrategy classFinderStrategy) Hibernate and other ORMs do some funky things to your pojo classes.
void	setCreateYogaLinks(boolean createAllLinks) Should yoga create metadata links as part of client requests?
void	setEnableStarAsAllFields(boolean starAsAll) Should field selectors with * be considered as a shortcut for all child fields?
void	setEntityConfigurations(YogaEntityConfiguration<?>... entityConfigurations) Set hand coded yoga configuration objects.
void	setOutputCountLimit(int countLimit) Set the maximum number of values that yoga should emit.
void	setRegistry(RenderingListenerRegistry registry) Allows you to create a RenderingListenerRegistry that contains custom event handlers for yoga events that relate to different sets of data being added to JSon/XML outputs.
void	setRootMetaDataUrl(String rootMetaDataUrl) Set the root url to use for metadata requests.
void	setYogaMetaDataRegisteredClasses(Class<?>... classes) Register the classes that Yoga should know about for the purposes of metadata creation.
YogaBuilder	withAliasProperties(InputStream propertyFile)
YogaBuilder	withClassFinderStrategy(ClassFinderStrategy classFinderStrategy)
YogaBuilder	withOutputCountLimit(int countLimit)
YogaBuilder	withRegistryTraverser(RenderingListenerRegistry registry)

Methods inherited from class java.lang.Object

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

Field Detail

_finalized

protected boolean _finalized

_classFinderStrategy

protected ClassFinderStrategy _classFinderStrategy

_registry

protected RenderingListenerRegistry _registry

_selectorResolver

protected SelectorResolver _selectorResolver

_aliasProperties

protected InputStream _aliasProperties

_createAllLinks

protected boolean _createAllLinks

Constructor Detail

YogaBuilder

public YogaBuilder()

Method Detail

init

protected void init()

there are cases where a user might want to override meta data registry, selector resolver and/or CoreSelector implementations. This would be the place to do it, since we have complex dependencies for those objects, and we need those objects set up before other setters are called.

checkFinalized

protected void checkFinalized()

getClassFinderStrategy

public ClassFinderStrategy getClassFinderStrategy()

getRegistry

public RenderingListenerRegistry getRegistry()

getSelectorResolver

public SelectorResolver getSelectorResolver()

getAliasProperties

public InputStream getAliasProperties()

isCreateAllLinks

public boolean isCreateAllLinks()

isEnableYogaMetadata

public boolean isEnableYogaMetadata()

getMetaDataRegistry

public MetaDataRegistry getMetaDataRegistry()

setClassFinderStrategy

public void setClassFinderStrategy(ClassFinderStrategy classFinderStrategy)

Hibernate and other ORMs do some funky things to your pojo classes. A ClassFinderStrategy will convert the funky class object into the original version of the pojo's class.

Parameters:

classFinderStrategy - - a ClassFinderStrategy that knows how to introspect pojos.

See Also:

ClassFinderStrategy

setEntityConfigurations

public void setEntityConfigurations(YogaEntityConfiguration<?>... entityConfigurations)

Set hand coded yoga configuration objects. This allows for either a non-annotated pojos and/or some interesting customization of outputs.

Parameters:

entityConfigurations -

setRegistry

public void setRegistry(RenderingListenerRegistry registry)

Allows you to create a RenderingListenerRegistry that contains custom event handlers for yoga events that relate to different sets of data being added to JSon/XML outputs.

Parameters:

registry - a fully formed RenderingListenerRegistry object with custom listeners

See Also:

RenderingListenerRegistry

setAliasProperties

public void setAliasProperties(InputStream aliasProperties)

This is a mechanism of allowing small aliases to be converted into pre-configured set of aliases for complicated or common selectors.

Parameters:

aliasProperties - an Inputstream that contains key/value pairs to be injected into the Propterties

setOutputCountLimit

public void setOutputCountLimit(int countLimit)

Set the maximum number of values that yoga should emit. This is a sanity check to make sure that a user can't take down your server by reading all of your data through recursive calls. A limit of 10,000 is reasonable.

setCreateYogaLinks

public void setCreateYogaLinks(boolean createAllLinks)

Should yoga create metadata links as part of client requests?

setYogaMetaDataRegisteredClasses

public void setYogaMetaDataRegisteredClasses(Class<?>... classes)

Register the classes that Yoga should know about for the purposes of metadata creation. Yoga can do some interesting things if you register the list of pojos that are the return values of your REST endpoints.

setRootMetaDataUrl

public void setRootMetaDataUrl(String rootMetaDataUrl)

Set the root url to use for metadata requests.

setEnableStarAsAllFields

public void setEnableStarAsAllFields(boolean starAsAll)

Should field selectors with * be considered as a shortcut for all child fields?

withClassFinderStrategy

public YogaBuilder withClassFinderStrategy(ClassFinderStrategy classFinderStrategy)

withRegistryTraverser

public YogaBuilder withRegistryTraverser(RenderingListenerRegistry registry)

withAliasProperties

public YogaBuilder withAliasProperties(InputStream propertyFile)

withOutputCountLimit

public YogaBuilder withOutputCountLimit(int countLimit)

enableYogaLinks

public YogaBuilder enableYogaLinks()

registerEntityConfigurations

public YogaBuilder registerEntityConfigurations(YogaEntityConfiguration<?>... entityConfigurations)

registerYogaMetaDataClasses

public YogaBuilder registerYogaMetaDataClasses(Class<?>... classes)

enableStarAsAllFields

public YogaBuilder enableStarAsAllFields()

finalize

public void finalize()

Overrides:

finalize in class Object

registerMetadataLinkListener

protected void registerMetadataLinkListener()

registerRenderingListeners

protected void registerRenderingListeners()

addAliases

protected void addAliases()