b4j.core

Interface SearchData

All Superinterfaces:

Configurable

All Known Implementing Classes:

DefaultSearchData

public interface SearchData
extends Configurable

Defines search parameters that a Session object can use to query bugs.

Author:

Ralph Schuster

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String parameter, List<String> values) Adds a search parameter with specified values.
void	add(String parameter, String value) Adds a value for a specific search parameter.
void	add(String parameter, String[] values) Adds a search parameter with specified values.
void	dump(org.slf4j.Logger log) Debug information into log.
Iterator<String>	get(String parameter) Returns an iterator of all values for specified parameter key.
int	getParameterCount() Returns the number of parameter names.
Iterator<String>	getParameterNames() Returns an iterator of all parameter names.
boolean	hasParameter(String name) Returns true if parameter name is set.

Methods inherited from interface b4j.core.Configurable

configure

Method Detail

getParameterCount

int getParameterCount()

Returns the number of parameter names.

Returns:

number of parameter names.

getParameterNames

Iterator<String> getParameterNames()

Returns an iterator of all parameter names.

Returns:

iterator on parameter names

hasParameter

boolean hasParameter(String name)

Returns true if parameter name is set.

Parameters:

name - parameter name

Returns:

true or false

get

Iterator<String> get(String parameter)

Returns an iterator of all values for specified parameter key. This methods must return null if no such parameter exists.

Parameters:

parameter - - name of parameter.

Returns:

iterator on values of parameter

add

void add(String parameter,
       String[] values)

Adds a search parameter with specified values. Existing values of this parameter must not be overridden.

Parameters:

parameter - - name of parameter

values - - array of additional values for parameter

add

void add(String parameter,
       List<String> values)

Adds a search parameter with specified values. Existing values of this parameter must not be overridden.

Parameters:

parameter - - name of parameter

values - - list of additional values for parameter

add

void add(String parameter,
       String value)

Adds a value for a specific search parameter.

Parameters:

parameter - - name of parameter

value - - value to add for parameter

dump

void dump(org.slf4j.Logger log)

Debug information into log. This method supports debugging functionality.

Parameters:

log - - log to dump into.