Package docking.widgets.search

Class SearchLocationContextBuilder

java.lang.Object

docking.widgets.search.SearchLocationContextBuilder

public class SearchLocationContextBuilder
extends Object

A builder for SearchLocationContext objects. Use append(String) for normal text pieces. Use appendMatch(String) for text that is meant to be rendered specially by the context class.

Constructor Summary

Constructors

Constructor	Description
SearchLocationContextBuilder()

Method Summary

Modifier and Type	Method	Description
SearchLocationContextBuilder	append(String text)	Appends the given text to this builder.
SearchLocationContextBuilder	appendMatch(String text)	Appends the given text to this builder.
SearchLocationContext	build()	Builds a SearchLocationContext using the text supplied via the append methods.
boolean	isEmpty()	Returns true if no text has been added to this builder.
SearchLocationContextBuilder	newline()	Adds a newline character to the previously added text.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SearchLocationContextBuilder

public SearchLocationContextBuilder()

Method Details

append

public SearchLocationContextBuilder append(String text)

Appends the given text to this builder.

Parameters:

text - the text

Returns:

this builder

appendMatch

public SearchLocationContextBuilder appendMatch(String text)

Appends the given text to this builder. This text represents a client-defined 'match' that will be rendered with markup when SearchLocationContext.getBoldMatchingText() is called.

Parameters:

text - the text

Returns:

this builder

newline

public SearchLocationContextBuilder newline()

Adds a newline character to the previously added text.

Returns:

this builder

build

public SearchLocationContext build()

Builds a SearchLocationContext using the text supplied via the append methods.

Returns:

the context

isEmpty

public boolean isEmpty()

Returns true if no text has been added to this builder.

Returns:

true if no text has been added to this builder

toString

public String toString()

Overrides:

toString in class Object