Package hudson.search

Class SearchIndexBuilder

java.lang.Object

hudson.search.SearchIndexBuilder

public final class SearchIndexBuilder
extends Object

Builds SearchIndex. This object is also used to represent partially build search index, much like StringBuilder is often passed around to cooperatively build search index.

Author:

Kohsuke Kawaguchi

See Also:

AbstractModelObject.makeSearchIndex()

Constructor Summary

Constructors

Constructor	Description
SearchIndexBuilder()

Method Summary

Modifier and Type	Method	Description
SearchIndexBuilder	add(SearchIndex index)
SearchIndexBuilder	add(SearchIndexBuilder index)
SearchIndexBuilder	add(SearchItem item)
SearchIndexBuilder	add(String urlAsWellAsName)	Short for add(urlAsWellAsName,urlAsWellAsName)
SearchIndexBuilder	add(String url, SearchableModelObject searchable, String name)
SearchIndexBuilder	add(String url, SearchableModelObject searchable, String... names)
SearchIndexBuilder	add(String url, String name)	Adds a search index under the keyword 'name' to the given URL.
SearchIndexBuilder	add(String url, String... names)
SearchIndexBuilder	addAllAnnotations(SearchableModelObject o)	Adds all QuickSilver-annotated properties to the search index.
SearchIndex	make()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchIndexBuilder

public SearchIndexBuilder()

Method Detail

addAllAnnotations

public SearchIndexBuilder addAllAnnotations(SearchableModelObject o)

Adds all QuickSilver-annotated properties to the search index.

add

public SearchIndexBuilder add(String urlAsWellAsName)

Short for add(urlAsWellAsName,urlAsWellAsName)

add

public SearchIndexBuilder add(String url,
                              String name)

Adds a search index under the keyword 'name' to the given URL.

Parameters:

url - Relative URL from the source of the search index.

add

public SearchIndexBuilder add(String url,
                              String... names)

add

public SearchIndexBuilder add(SearchItem item)

add

public SearchIndexBuilder add(String url,
                              SearchableModelObject searchable,
                              String name)

add

public SearchIndexBuilder add(String url,
                              SearchableModelObject searchable,
                              String... names)

add

public SearchIndexBuilder add(SearchIndex index)

add

public SearchIndexBuilder add(SearchIndexBuilder index)

make

public SearchIndex make()