StreamUtils (Groovy Documentation)

SharedLib.elements.StreamUtils

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`closeStream(java.lang.Object stream, groovy.lang.Closure streamProcessor)` Utility to close stream after processing
`null`	`static void`	`main(java.lang.String[] args)` Implicit main method for Groovy Scripts
	`java.lang.Object`	`stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)` Closable wrapper of api.stream(String typeCode, String sortBy, Filter... filters)
	`java.lang.Object`	`stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<java.lang.String> fields, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)` Closable wrapper of api.stream(String typeCode, String sortBy, List fields, Filter... filters)
	`java.lang.Object`	`stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<java.lang.String> fields, boolean distinctValuesOnly, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)` Closable wrapper of api.stream(String typeCode, String sortBy, List fields, boolean distinctValuesOnly, Filter... filters)
	`java.lang.Object`	`stream(java.lang.String typeCode, java.lang.String sortBy, java.util.Map<java.lang.String, java.lang.String> fields, boolean distinctValuesOnly, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)` Self closable wrapper of api.stream(String typeCode, String sortBy, Map fields, boolean distinctValuesOnly, Filter... filters)

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovy.lang.Script`	groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(long), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()
`class groovy.lang.GroovyObjectSupport`	groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()

- Method Detail
  - java.lang.Object closeStream(java.lang.Object stream, groovy.lang.Closure streamProcessor)
    
    Utility to close stream after processing
    Parameters:
    stream
    streamProcessor - : Closure accept stream as parameter. If null or empty closure will be passed, then default collect operation will be used.
    Returns:
    value returned by streamProcessor
    Throws:
    any exception during streamProcessor call will be thrown using api.throwException
  - static void main(java.lang.String[] args)
    
    Implicit main method for Groovy Scripts
  - java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)
    
    Closable wrapper of api.stream(String typeCode, String sortBy, Filter... filters)
    Parameters:
    : - typeCode
    : - sortBy
    : - filters. List of filters
    : - streamProcessor. Closure to process stream result. Closure should accept stream as parameter. Attention! Passing an empty closure { } can cause decreased performance and result in not closing streams which will leave hanging unclosed connections that can fill up connection pool and crash the server.
    Returns:
    : result returned from streamProcessing closure
  - java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<java.lang.String> fields, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)
    
    Closable wrapper of api.stream(String typeCode, String sortBy, List fields, Filter... filters)
    Parameters:
    : - typeCode
    : - sortBy
    : - fields. List of fields
    : - filters. List of filters
    : - streamProcessor. Closure to process stream result. Closure should accept stream as parameter. Attention! Passing an empty closure { } can cause decreased performance and result in not closing streams which will leave hanging unclosed connections that can fill up connection pool and crash the server.
    Returns:
    : result returned from streamProcessing closure
  - java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<java.lang.String> fields, boolean distinctValuesOnly, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)
    
    Closable wrapper of api.stream(String typeCode, String sortBy, List fields, boolean distinctValuesOnly, Filter... filters)
    Parameters:
    : - typeCode
    : - sortBy
    : - fields. List of fields
    : - distinctValuesOnly
    : - filters. List of filters
    : - streamProcessor. Closure to process stream result. Closure should accept stream as parameter. Attention! Passing an empty closure { } can cause decreased performance and result in not closing streams which will leave hanging unclosed connections that can fill up connection pool and crash the server.
    Returns:
    : result returned from streamProcessing closure
  - java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.Map<java.lang.String, java.lang.String> fields, boolean distinctValuesOnly, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)
    
    Self closable wrapper of api.stream(String typeCode, String sortBy, Map fields, boolean distinctValuesOnly, Filter... filters)
    Parameters:
    : - typeCode
    : - sortBy
    : - fields. Map of field
    : - distinctValuesOnly
    : - filters. List of filters
    : - streamProcessor. Closure to process stream result. Closure should accept stream as parameter. Attention! Passing an empty closure { } can cause decreased performance and result in not closing streams which will leave hanging unclosed connections that can fill up connection pool and crash the server.
    Returns:
    : result returned from streamProcessing closure

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Script StreamUtils

Methods Summary

Inherited Methods Summary

Method Detail

java.lang.Object closeStream(java.lang.Object stream, groovy.lang.Closure streamProcessor)

static void main(java.lang.String[] args)

java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)

java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<java.lang.String> fields, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)

java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.List<java.lang.String> fields, boolean distinctValuesOnly, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)

java.lang.Object stream(java.lang.String typeCode, java.lang.String sortBy, java.util.Map<java.lang.String, java.lang.String> fields, boolean distinctValuesOnly, java.util.List<com.googlecode.genericdao.search.Filter> filters, groovy.lang.Closure streamProcessor = null)