Package org.apache.juneau.objecttools

Class SearchArgs

java.lang.Object

org.apache.juneau.objecttools.SearchArgs

public class SearchArgs
extends Object

Arguments passed to ObjectSearcher.

See Also:

• Overview > juneau-marshall > Object Tools

Constructor Summary

Constructors

Constructor	Description
SearchArgs(String searchArgs)	Constructor.
SearchArgs(List<String> searchArgs)	Constructor.

Method Summary

Modifier and Type	Method	Description
SearchArgs	append(String column, String searchTerm)	Appends the specified search argument.
static SearchArgs	create(String args)	Static creator.
static SearchArgs	create(List<String> args)	Static creator.
Map<String,String>	getSearch()	The query search terms.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchArgs

public SearchArgs(String searchArgs)

Constructor.

Parameters:

searchArgs - Search arguments.

SearchArgs

public SearchArgs(List<String> searchArgs)

Constructor.

Parameters:

searchArgs - Search arguments.

Method Details

create

public static SearchArgs create(String args)

Static creator.

Parameters:

args - Comma-delimited list of search arguments.

Returns:

A new SearchArgs object.

create

public static SearchArgs create(List<String> args)

Static creator.

Parameters:

args - List of search arguments.

Returns:

A new SearchArgs object.

append

public SearchArgs append(String column,
 String searchTerm)

Appends the specified search argument.

Parameters:

column - The column name to search.

searchTerm - The search term.

Returns:

This object.

getSearch

public Map<String,String> getSearch()

The query search terms.

The search terms are key/value pairs consisting of column-names and search tokens.

It's up to implementers to decide the syntax and meaning of the search term.

Returns:

An unmodifiable map of query search terms.