Package com.apptus.esales.connector

Class Result.Phrases

java.lang.Object

com.apptus.esales.connector.Result.Phrases

All Implemented Interfaces:

Result, Iterable<Result.Phrase>

Enclosing interface:

Result

public static class Result.Phrases
extends Object
implements Result, Iterable<Result.Phrase>

Represents a result having the phrases format.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apptus.esales.connector.Result

Result.Ad, Result.Ads, Result.Attribute, Result.Category, Result.CategoryData, Result.CategoryList, Result.CategoryNode, Result.Completion, Result.Completions, Result.Correction, Result.Corrections, Result.Count, Result.Facet, Result.FacetList, Result.FacetRange, Result.Phrase, Result.Phrases, Result.Product, Result.Products, Result.ResultType, Result.Value, Result.Values, Result.Variant

Constructor Summary

Constructors

Constructor	Description
Phrases()

Method Summary

Modifier and Type	Method	Description
List<Result.Phrase>	getPhrases()	Get a list of the phrases.
Result.ResultType	getType()	Get the result type of this result.
boolean	isEmpty()	Check if this result is empty.
Iterator<Result.Phrase>	iterator()
static Result.Phrases	mock(List<Result.Phrase> phrases)	Creates a new Phrases object for test purposes.
int	size()	Get the number of phrases.
String	toString()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

Phrases

public Phrases()

Method Detail

mock

public static Result.Phrases mock(List<Result.Phrase> phrases)

Creates a new Phrases object for test purposes.

Parameters:

phrases - the phrases to include in the phrases result

Returns:

a phrases result

size

public int size()

Get the number of phrases.

Returns:

the number of phrases found

isEmpty

public boolean isEmpty()

Check if this result is empty.

Returns:

true if there are no phrases, otherwise false

getPhrases

public List<Result.Phrase> getPhrases()

Get a list of the phrases.

Returns:

the list of phrases

iterator

public Iterator<Result.Phrase> iterator()

Specified by:

iterator in interface Iterable<Result.Phrase>

toString

public String toString()

Specified by:

toString in interface Result

Overrides:

toString in class Object

getType

public Result.ResultType getType()

Description copied from interface: Result

Get the result type of this result.

Specified by:

getType in interface Result

Returns:

the result type